Skip to content

feat:Update apply_text_normalization parameter description in OpenAPI schema#152

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508051525
Aug 5, 2025
Merged

feat:Update apply_text_normalization parameter description in OpenAPI schema#152
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202508051525

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Aug 5, 2025

Summary by CodeRabbit

  • Documentation
    • Clarified the description for text normalization settings, specifying that for certain models, this feature is only available to users with Enterprise plans.

@coderabbitai
Copy link

coderabbitai bot commented Aug 5, 2025

Walkthrough

The change updates the description of the apply_text_normalization parameter in the OpenAPI schema for several ElevenLabs text-to-speech request bodies. The new description clarifies that text normalization for specific models is only available to Enterprise plan users, replacing a previous blanket restriction.

Changes

Cohort / File(s) Change Summary
OpenAPI Schema Description Update
src/libs/ElevenLabs/openapi.yaml
Updated the apply_text_normalization parameter description in four text-to-speech request schemas to clarify Enterprise plan requirements for certain models.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A tweak in the docs, so small yet precise,
Now Enterprise plans hold the key to this slice.
For voices that stream and those that just speak,
Text normalization—no longer so bleak!
With clarity added, the docs hop ahead,
A rabbit’s delight in the words newly said.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ 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_202508051525

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @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 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 generate unit tests to generate unit tests for 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.

@HavenDV HavenDV merged commit 901ad6c into main Aug 5, 2025
2 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202508051525 branch August 5, 2025 15:26
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update apply_text_normalization parameter description in OpenAPI schema Aug 5, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/libs/ElevenLabs/openapi.yaml (1)

12394-12399: Consider deduplicating repeated parameter descriptions

The identical apply_text_normalization schema fragment appears four times. To avoid drift and simplify maintenance, extract it once under components/parameters (or a reusable schema) and reference it with $ref.

This keeps future wording or enum changes consistent across all endpoints with a single edit.

Also applies to: 12490-12495, 12586-12591, 12679-12684

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c2c626 and 472edc4.

⛔ Files ignored due to path filters (16)
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceId.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingV1TextToSpeechVoiceIdStreamPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingV1TextToSpeechVoiceIdStreamPostApplyTextNormalization.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPostApplyTextNormalization.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechV1TextToSpeechVoiceIdPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechV1TextToSpeechVoiceIdPostApplyTextNormalization.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPostApplyTextNormalization.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceId.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/ElevenLabs/openapi.yaml (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Test / Build, test and publish

Comment on lines +12397 to 12400
description: 'This parameter controls text normalization with three modes: ''auto'', ''on'', and ''off''. When set to ''auto'', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With ''on'', text normalization will always be applied, while with ''off'', it will be skipped. For ''eleven_turbo_v2_5'' and ''eleven_flash_v2_5'' models, text normalization can only be enabled with Enterprise plans.'
default: auto
example: 'true'
apply_language_text_normalization:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Example value is invalid for declared enum type

example: 'true' is not one of the allowed enum values (auto | on | off) and could cause client-side validation failures or misleading documentation.
Replace the example with a valid value, e.g. 'auto'.

-          example: 'true'
+          example: 'auto'

Also applies to: 12493-12496, 12589-12592, 12682-12685

🤖 Prompt for AI Agents
In src/libs/ElevenLabs/openapi.yaml around lines 12397 to 12400, the example
value for the apply_language_text_normalization parameter is set to 'true',
which is invalid for the declared enum type that only allows 'auto', 'on', or
'off'. Replace the example value with a valid enum value such as 'auto'. Also
apply this fix to the same parameter examples at lines 12493-12496, 12589-12592,
and 12682-12685.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant