feat:Update OpenAPI spec with EU server notes and schema description formatting #85
Conversation
WalkthroughThe OpenAPI specification for AssemblyAI was updated to include notes in all LeMUR-related endpoint descriptions about using the EU server by changing the base URL. Additionally, formatting adjustments were made in schema field descriptions, replacing quotation marks with backticks for certain values. No functional or signature changes were made. 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: 2
🧹 Nitpick comments (5)
src/libs/AssemblyAI/openapi.yaml (5)
640-642: EU server note added – consider using a server definition.The manual
<Note>instructs users to replace the base URL for EU, which works but is error-prone. Consider adding an explicithttps://api.eu.assemblyai.comentry under the top-levelservers:section so clients can select the EU server via OpenAPI tooling instead of text replacement.
697-699: Consistent EU server note – opt for server list.Same
<Note>inserted here. Approve, but as above, centralize server URLs to avoid duplicating replacement instructions.
755-758: EU server note on Question-Answer – centralize configuration.Good catch adding the note here. For maintainability, define the EU server in the
servers:array rather than repeating text.
869-871: EU server note on GET response – consolidate servers.This aligns the GET description. As a best practice, move EU server into
servers:to eliminate manual URL swaps.
911-913: EU server note on DELETE – unify server definitions.Note is correct. To reduce duplication and risk, declare the EU server at the root.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (13)
src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.GetLemurResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurQuestionAnswer.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurSummary.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurTask.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.PurgeLemurRequestData.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.GetLemurResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurQuestionAnswer.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurSummary.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurTask.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.PurgeLemurRequestData.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SubstitutionPolicy.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/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(8 hunks)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
1875-1877: SubstitutionPolicy schema description is correct.The description correctly references
entity_nameandhash, matching the enum. No changes needed here.
| x-label: Redact PII substitution | ||
| description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | ||
| description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | ||
| oneOf: |
There was a problem hiding this comment.
Mismatch in PII substitution options.
The redact_pii_sub parameter description lists entity_type but the SubstitutionPolicy enum accepts entity_name or hash. Update the description to entity_name to match the schema.
- description: The replacement logic for detected PII, can be `entity_type` or `hash`.
+ description: The replacement logic for detected PII, can be `entity_name` or `hash`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| x-label: Redact PII substitution | |
| description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| oneOf: | |
| x-label: Redact PII substitution | |
| description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| oneOf: |
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 1391 to 1393, the description
for the redact_pii_sub parameter incorrectly uses "entity_type" while the
SubstitutionPolicy enum defines "entity_name". Update the description text to
replace "entity_type" with "entity_name" to ensure consistency with the schema.
| x-label: Redact PII substitution | ||
| description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | ||
| description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | ||
| $ref: "#/components/schemas/SubstitutionPolicy" |
There was a problem hiding this comment.
Inconsistent PII substitution description in response.
The redact_pii_sub field in the response also erroneously cites entity_type. It should be entity_name to align with SubstitutionPolicy.
- description: The replacement logic for detected PII, can be `entity_type` or `hash`.
+ description: The replacement logic for detected PII, can be `entity_name` or `hash`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| x-label: Redact PII substitution | |
| description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| $ref: "#/components/schemas/SubstitutionPolicy" | |
| x-label: Redact PII substitution | |
| - description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| + description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. | |
| $ref: "#/components/schemas/SubstitutionPolicy" |
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 2811 to 2813, the description
for the PII substitution field incorrectly references `entity_type` instead of
`entity_name`. Update the description text to replace `entity_type` with
`entity_name` to ensure consistency with the SubstitutionPolicy schema.
Summary by CodeRabbit