feat:Refine /v2/upload endpoint schema for binary file uploads in OpenAPI spec

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Clarified the API documentation for the media file upload endpoint to specify that it accepts binary data.

[coderabbitai]

Walkthrough

The OpenAPI specification file for the AssemblyAI library was updated to refine the definition of the /v2/upload POST endpoint. The request body for the application/octet-stream content type now explicitly includes a schema specifying a binary string format, clarifying the expected payload for file uploads. No other parts of the API specification were modified.

Changes

File	Change Summary
src/libs/AssemblyAI/openapi.yaml	Updated /v2/upload POST endpoint to define the request body schema as a binary string payload.

Poem

A spec was tuned with careful hand,
To show the bytes it must withstand.
Now uploads know just what to be—
A binary string, clear as can be!
With YAML lines both neat and bright,
The docs now guide each upload right.
🐇✨

---

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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)

49-52: Explicit binary schema clarification for upload endpoint
The new schema correctly defines the application/octet-stream payload as a binary string, which will improve client validation and codegen. Consider marking the request body as required and adding a brief description to guide implementers.

Diff suggestion:

@@ -47,4 +47,6 @@ paths:
-        content:
+        required: true
+        content:
           application/octet-stream:
             schema:
               type: string
               format: binary
+            description: Binary data of the media file

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 560bca5 and aae809f.

⛔ Files ignored due to path filters (3)

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

📒 Files selected for processing (1)

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