feat:Update GET /v2/transcript description with support instruction

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation with improved guidance for retrieving transcripts older than 90 days. Users are now directed to contact support if transcripts beyond the specified time frame are needed.

[coderabbitai]

Walkthrough

The pull request updates the OpenAPI specification in the src/libs/AssemblyAI/openapi.yaml file. Specifically, the description for the GET /v2/transcript endpoint has been modified by removing a blank line and adding an instruction. The new line informs users to contact support for retrieving transcripts older than 90 days. No changes were made to exported or public entities.

Changes

File(s)	Change Summary
src/libs/AssemblyAI/openapi.yaml	Updated the GET /v2/transcript endpoint description: removed an extraneous blank line and added guidance to contact support (support@assemblyai.com) for transcripts >90 days.

Possibly related PRs

• feat:Revise listTranscripts description for 90-day transcript availability #58: Modified the OpenAPI specification for transcript retrieval, addressing transcripts older than 90 days.
• feat:Update openapi.yaml with new endpoints and improved query parameters #29: Involved updates to the GET /v2/transcript endpoint, including the addition of new query parameters.
• feat:Remove explicit EU server entry from OpenAPI spec and update docs #66: Also updated the documentation for the GET /v2/transcript endpoint in the openapi.yaml file.

Poem

Hop along, dear coder, in the code maze so bright,
I’ve munched on blank lines and set old data alight.
With a twitch of my nose, I add guidance clear and sweet,
For transcripts past 90 days, support is there to meet.
CodeRabbit hops in celebration with a cheer so light!
🐇✨

---

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 plan to trigger planning for file edits and PR creation.
• @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)

170-175: Enhanced Documentation with Support Contact Information

The revised description for the GET /v2/transcript endpoint now includes a clear support instruction: "If you need to retrieve transcripts from more than 90 days ago please reach out to our Support team at support@assemblyai.com." This addition improves clarity by guiding users on where to turn for older transcript retrieval. Please double-check that the support email is correct and consider whether a mailto link would further improve usability.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 172-172: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6feb036 and 51d4ce4.

📒 Files selected for processing (1)

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