feat:Add remove_audio_tags field to AssemblyAI OpenAPI schemas#160
Merged
feat:Add remove_audio_tags field to AssemblyAI OpenAPI schemas#160
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
WalkthroughThis pull request adds a new optional Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
src/libs/AssemblyAI/openapi.yaml (2)
1578-1583: Extractremove_audio_tagsinto a shared component schema.The same union definition is duplicated in both request and response models. A shared schema will reduce drift and keep SDK generation behavior consistent if this enum grows later.
♻️ Suggested refactor
@@ - remove_audio_tags: - x-label: Remove audio tags - description: | - Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags. - - Note: This parameter is only supported for the Universal-3-Pro model. - oneOf: - - type: string - enum: - - all - - type: "null" - default: null + remove_audio_tags: + x-label: Remove audio tags + description: | + Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags. + + Note: This parameter is only supported for the Universal-3-Pro model. + $ref: "#/components/schemas/RemoveAudioTags" @@ - remove_audio_tags: - x-label: Remove audio tags - description: | - Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text. - - Note: This parameter is only supported for the Universal-3-Pro model. - oneOf: - - type: string - enum: - - all - - type: "null" + remove_audio_tags: + x-label: Remove audio tags + description: | + Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text. + + Note: This parameter is only supported for the Universal-3-Pro model. + $ref: "#/components/schemas/RemoveAudioTags" @@ + RemoveAudioTags: + oneOf: + - type: string + enum: + - all + - type: "null"Also applies to: 3073-3078
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/libs/AssemblyAI/openapi.yaml` around lines 1578 - 1583, Create a shared component schema named something like RemoveAudioTags under components.schemas that contains the oneOf union (type: string with enum: ["all"] and type: "null") and default: null; then replace the duplicated inline definitions for remove_audio_tags in both the request and response models with a $ref to this new components.schemas.RemoveAudioTags (ensure the schema name matches references and update any swagger/openapi references accordingly so SDK generation uses the shared component).
3069-3071: ClarifyTranscript.remove_audio_tagssemantics in the description.The current wording reads like a boolean outcome, but the actual value is
"all"ornull. A slightly more explicit description will reduce SDK/docs confusion.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/libs/AssemblyAI/openapi.yaml` around lines 3069 - 3071, Update the OpenAPI description for the Transcript.remove_audio_tags property to accurately reflect its semantics: state that the field is not a boolean but holds the string "all" when all audio event tags were removed and null when no tags were removed (or when the information is unavailable). Locate the Transcript.remove_audio_tags entry in src/libs/AssemblyAI/openapi.yaml and replace the existing description with a concise sentence that explicitly documents the two possible values ("all" or null) and what each means.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/libs/AssemblyAI/openapi.yaml`:
- Around line 1578-1583: Create a shared component schema named something like
RemoveAudioTags under components.schemas that contains the oneOf union (type:
string with enum: ["all"] and type: "null") and default: null; then replace the
duplicated inline definitions for remove_audio_tags in both the request and
response models with a $ref to this new components.schemas.RemoveAudioTags
(ensure the schema name matches references and update any swagger/openapi
references accordingly so SDK generation uses the shared component).
- Around line 3069-3071: Update the OpenAPI description for the
Transcript.remove_audio_tags property to accurately reflect its semantics: state
that the field is not a boolean but holds the string "all" when all audio event
tags were removed and null when no tags were removed (or when the information is
unavailable). Locate the Transcript.remove_audio_tags entry in
src/libs/AssemblyAI/openapi.yaml and replace the existing description with a
concise sentence that explicitly documents the two possible values ("all" or
null) and what each means.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: eaac9e8d-641a-4970-83f1-dc688d63bbd4
⛔ Files ignored due to path filters (11)
src/libs/AssemblyAI/Generated/AssemblyAI..JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.TranscriptOptionalParamsRemoveAudioTags.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.TranscriptOptionalParamsRemoveAudioTagsNullable.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.TranscriptRemoveAudioTags.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.TranscriptRemoveAudioTagsNullable.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsRemoveAudioTags.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptRemoveAudioTags.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit