feat:Deprecate custom_topics in TranscriptOptionalParams OpenAPI schema

[HavenDV]

Summary by CodeRabbit

• Chores
  • The transcript API now deprecates the custom topics option. Customers should use the topics property for defining custom topics, as the deprecated option may be removed in future versions.

[coderabbitai]

Walkthrough

The pull request updates the OpenAPI specification by marking the custom_topics property as deprecated in the TranscriptOptionalParams schema within src/libs/AssemblyAI/openapi.yaml. This change signals that the custom_topics feature is no longer recommended for use and may be removed in future versions, while the topics property remains unchanged.

Changes

File	Change Summary
src/libs/AssemblyAI/openapi.yaml	Added deprecated: true to the custom_topics property in the TranscriptOptionalParams schema.

Possibly related PRs

• feat:Add multichannel parameter to Transcript schemas in openapi.yaml #31: Introduces a new multichannel property to the same TranscriptOptionalParams schema.
• feat:Update openapi.yaml for AssemblyAI API to version 1.3.4 with changes #26: Marks the dual_channel parameter as deprecated within the TranscriptOptionalParams schema.
• feat:Update openapi.yaml with new endpoints and improved query parameters #29: Updates the TranscriptOptionalParams schema by removing the multichannel property.

Suggested reviewers

• github-actions

Poem

Hop, hop! I'm a rabbit here to say,
A little change has hopped our way.
custom_topics now wears a sign so clear,
Deprecated steps, a future shift is near.
With whiskers twitching and code trails bright,
We celebrate changes in the moonlit night!
(_/), (O.o), ( > <) 🥕

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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)

2824-2829: Deprecation Notice for custom_topics:
The addition of deprecated: true to the custom_topics property clearly communicates that this feature is no longer recommended and may be removed in future versions. This aligns well with our goal of discouraging its use in favor of the topics property.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8870227 and 08a54fd.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

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