feat:Update openapi.yaml with new endpoints and improved query parameters

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced new API endpoints for enhanced transcript management, including the ability to delete transcripts and retrieve subtitles in specified formats.
  • Added new query parameters for the transcript retrieval endpoint, allowing for more refined searches.
  • Implemented webhook notifications for transcript readiness and redacted audio updates.

• Updates

  • Streamlined parameters for transcript creation by deprecating certain properties.

[coderabbitai]

Walkthrough

The changes in the pull request focus on significant updates to the openapi.yaml file for the AssemblyAI API. Enhancements include new endpoints, such as a delete method for transcripts and a new endpoint for retrieving subtitles. Existing endpoints have been modified to support additional query parameters for improved transcript retrieval. New schemas for handling notifications related to transcripts and redacted audio have been introduced, while deprecated properties have been removed from existing schemas to streamline functionality.

Changes

File Path	Change Summary
src/libs/AssemblyAI/openapi.yaml	- Added POST /v2/transcript/{transcript_id} with delete method.
	- Updated GET /v2/transcript with new query parameters: limit, status, created_on, before_id, after_id, throttled_only.
	- Added GET /v2/transcript/{transcript_id}/{subtitle_format}.
	- Updated TranscriptParams and TranscriptOptionalParams schemas (removed multichannel).
	- Added TranscriptWebhookNotification schema.
	- Added RedactedAudioNotification schema.

Poem

🐇 In the meadow where the data flows,
New endpoints sprout like springtime's rose.
With transcripts managed, and subtitles clear,
Our API dances, bringing us cheer!
So hop along, dear friends, let's play,
For AssemblyAI shines brighter today! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between eba826b and 9c17fdc.

⛔ Files ignored due to path filters (2)

• src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.cs is excluded by !**/generated/**
• src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

💤 Files with no reviewable changes (1)

• src/libs/AssemblyAI/openapi.yaml

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.