feat:Wrap example under requestBody.value for /v1/streaming.create_token

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Corrected the example for the streaming token creation request body to use a value-wrapped object, aligning with OpenAPI expectations.
  • Improves accuracy of the API reference, reducing confusion and potential integration errors when generating streaming tokens.

[coderabbitai]

Walkthrough

The change updates an example object in src/libs/HeyGen/openapi.yaml: under /v1/streaming.create_token requestBody, the example is wrapped inside a value field. No endpoints, methods, or schemas were modified.

Changes

Cohort / File(s)	Summary of changes
OpenAPI example adjustment src/libs/HeyGen/openapi.yaml	Updated the requestBody example for /v1/streaming.create_token from streaming.create_token: { } to streaming.create_token: value: { }, converting a bare ExampleObject to one with a value field; no other spec elements changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my ears at YAML’s grace,
A tiny tweak in just one place—
Wrapped a value, snug and neat,
Example now is quite complete.
Hop hop! Docs aligned in tone,
One small carrot, fully grown. 🥕

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202508260110

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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/HeyGen/openapi.yaml (1)

532-533: Optional: Clarify whether the request body is required and/or must be an empty object.

Right now, the schema is type: object without properties and the example is {}. If the API:

• accepts no payload, mark the requestBody as optional; or
• requires an explicitly empty JSON object, enforce it via schema.

Two suggested patterns (pick one):

1. If body is optional (recommended if server ignores body):

requestBody:
  required: false
  content:
    application/json:
      schema:
        type: object
      examples:
        streaming.create_token:
          value: {}

2. If body must be exactly {}:

requestBody:
  required: true
  content:
    application/json:
      schema:
        type: object
        additionalProperties: false
        # minProperties/maxProperties are supported by OAS 3.0 JSON Schema dialects
        minProperties: 0
        maxProperties: 0
      examples:
        streaming.create_token:
          value: {}

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d26d32d and 02c7957.

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

src/libs/HeyGen/openapi.yaml (2)

532-533: Good fix: ExampleObject now correctly uses a value.

Wrapping the example in value: {} aligns with OpenAPI 3.x ExampleObject semantics and improves tooling compatibility (Swagger UI, codegen, Postman). No functional changes to the endpoint behavior.

---

532-533: Validate HeyGen OpenAPI spec

We located and validated the spec at src/libs/HeyGen/openapi.yaml:

• ✅ Spec is syntactically valid per swagger-cli validate.
• 🚨 The previous Redocly lint invocation was incorrect and needs to be run as shown below.

Please run the following and confirm there are no lint errors:

#!/bin/bash
set -euo pipefail

file="src/libs/HeyGen/openapi.yaml"

# 1) Re-validate syntax
npx --yes swagger-cli@4 validate "$file"

# 2) Lint with Redocly CLI
npx --yes @redocly/cli@1.18.1 lint "$file" || true

Ensure the lint step completes without errors to avoid regressions in downstream code generators.