feat:Remove explicit EU server entry from OpenAPI spec and update docs #66
Conversation
WalkthroughThis pull request updates the AssemblyAI OpenAPI specification by removing the explicit EU server entry from the Changes
Possibly related PRs
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
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:
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: 0
🧹 Nitpick comments (10)
src/libs/AssemblyAI/openapi.yaml (10)
41-43: EU Server Upload Instruction Note Added
A new note has been inserted in the upload endpoint’s description that instructs users to replace
api.assemblyai.comwithapi.eu.assemblyai.comwhen uploading files. The note helps clarify how to
access the EU server without requiring an explicit server entry.
78-80: EU Note for Transcription Creation Endpoint
The POST/v2/transcriptendpoint now includes a note advising clients to switch the domain for EU server access.
Verify that the phrasing ("To use our EU server for transcription, replaceapi.assemblyai.comwithapi.eu.assemblyai.com.") is consistent with the overall documentation style.
169-171: EU Note for Listing Transcripts Endpoint
In the GET/v2/transcript(list) endpoint, a note has been added instructing users to adjust the domain for EU retrieval.
Ensure that the note is clear and that similar instructions in other endpoints use identical wording.
251-253: EU Note for Get Transcript by ID Endpoint
The description of the GET/v2/transcript/{transcript_id}endpoint now starts with a note about accessing the EU server.
Maintain consistency in phrasing and consider if additional clarification or a link to more detailed documentation is needed.
303-305: EU Note for Delete Transcript Endpoint
The DELETE/v2/transcript/{transcript_id}endpoint now carries a note for EU server access.
Double-check that the note does not conflict with any server-specific logic, and that “delete” operations are adequately documented regarding the changed server configuration.
344-346: EU Note for Subtitles Endpoint
For the GET/v2/transcript/{transcript_id}/{subtitle_format}endpoint, a note is added to instruct users on EU server access.
Confirm that this additional instruction is helpful for the consumers and follows the same formatting (using the<Note>tag).
417-419: EU Note for Sentences Endpoint
The GET/v2/transcript/{transcript_id}/sentencesendpoint’s description now begins with a note regarding EU server usage.
This extra detail is beneficial for guiding API consumers. Ensure that it is in sync with all similar notes throughout the file.
459-461: EU Note for Paragraphs Endpoint
The GET/v2/transcript/{transcript_id}/paragraphsendpoint now includes a note advising a domain change for EU access.
Check that the note’s tone and format (using<Note>) match those in the other endpoints for consistency.
497-499: EU Note for Word Search Endpoint
A note has been added to the GET/v2/transcript/{transcript_id}/word-searchendpoint to inform users about replacing the default API domain with the EU endpoint for word-search operations.
Ensure that the messaging is clear and that similar instructions elsewhere are uniformly worded.
552-554: EU Note for Redacted Audio Endpoint
The GET/v2/transcript/{transcript_id}/redacted-audioendpoint now starts with a note explaining the domain substitution for EU server access.
Confirm that this note is sufficient for users to understand that the underlying API host needs to be modified accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (20)
src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.CreateTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.DeleteTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetRedactedAudio.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetSubtitles.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetTranscriptParagraphs.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetTranscriptSentences.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.UploadFile.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.WordSearch.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.CreateTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.DeleteTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetRedactedAudio.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetSubtitles.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetTranscriptParagraphs.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetTranscriptSentences.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.UploadFile.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.WordSearch.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(11 hunks)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
5230-5231: Block Style Formatting for upload_url Description
The description for theupload_urlproperty in theUploadedFileschema has been reformatted to a block style.
This improves readability and makes the usage note stand out. Verify that the block style formatting is correctly rendered by your documentation tools.
Summary by CodeRabbit