feat:Update OpenAPI /v2/transcript endpoint description for EU server

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated the transcript API endpoint details with clearer guidance for EU users, including instructions on switching to the EU server endpoint.

[coderabbitai]

Walkthrough

The pull request updates the OpenAPI specification in the AssemblyAI library. Specifically, the description for the /v2/transcript POST endpoint in the openapi.yaml file has been modified. The new description now includes a note explaining that for transcription via the EU server, users should replace api.assemblyai.com with api.eu.assemblyai.com.

Changes

File(s)	Change Summary
src/libs/AssemblyAI/openapi.yaml	Updated the /v2/transcript POST endpoint description to include a note about using the EU server by replacing the default hostname.

Possibly related PRs

• feat:Update openapi.yaml with new endpoints and improved query parameters #29: Modifications include additional query parameters and functionality related to the /v2/transcript endpoint.
• feat:Update openapi.yaml with model deprecations and improved documentation #14: Updates descriptions within the same openapi.yaml file for different endpoints, indicating a related focus on documentation improvements.

Suggested reviewers

• github-actions

Poem

I'm a rabbit that hops with delight,
Updating endpoints both day and night.
A note for the EU server now in play,
Helping users find the right API way.
With whiskers twitching, I cheer this code update—hip, hip, hooray! 🥕🐇

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

79-81: Enhanced Endpoint Description for EU Users

The updated description now clearly informs users that to use the EU server, they must replace api.assemblyai.com with api.eu.assemblyai.com. This explicit note is very valuable for EU-based customers and aligns well with the second server entry already defined in the servers section. One minor suggestion is to verify that the use of XML-like tags (i.e. <Note>...</Note>) in the description complies with your documentation and tooling standards. If not, consider whether a markdown or plain text format might be more appropriate.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 191a178 and 810df72.

⛔ Files ignored due to path filters (2)

• src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.CreateTranscript.g.cs is excluded by !**/generated/**
• src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.CreateTranscript.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/AssemblyAI/openapi.yaml (1 hunks)