feat:Add redact_pii_audio_options to transcript parameters in OpenAPI spec #84
Conversation
WalkthroughA new schema component, Changes
Poem
✨ Finishing Touches🧪 Generate Unit Tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
1399-1404: Refine x-label and descriptionThe
x-labelduplicates the description and is rather verbose. Consider simplifying the label to something likePII Audio Redaction Optionsand tightening the description, for example:x-label: PII Audio Redaction Options description: Return redacted audio URLs even for silent files when set to true.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
src/libs/AssemblyAI/Generated/AssemblyAI.JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsRedactPiiAudioOptions.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsRedactPiiAudioOptions.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(1 hunks)
| redact_pii_audio_options: | ||
| x-label: Specify options for PII redacted audio files. | ||
| description: Specify options for PII redacted audio files. | ||
| type: object | ||
| additionalProperties: false |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Inline schema extraction recommended
Currently redact_pii_audio_options is defined inline under TranscriptOptionalParams. For better modularity, discoverability, and SDK generation, extract this object into a top-level schema (e.g. components/schemas/TranscriptRedactPiiAudioOptions) and reference it via $ref in TranscriptOptionalParams instead of embedding it inline.
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 1393 to 1397, the
redact_pii_audio_options object is defined inline within
TranscriptOptionalParams. To improve modularity and SDK generation, extract
redact_pii_audio_options into a separate top-level schema named
TranscriptRedactPiiAudioOptions under components/schemas, then replace the
inline definition in TranscriptOptionalParams with a $ref pointing to this new
schema.
Summary by CodeRabbit