-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat:Update speakers_expected property descriptions to remove upper limit reference #100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughThe change updates the description text for the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
2836-2840: Mirror the earlier description update for consistencySame comment as above applies to the
Transcriptschema instance. Make sure any enforced limits are reflected either through explicitmaximum/minimumkeywords or harmonised documentation, otherwise SDK consumers will be left guessing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(2 hunks)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
1417-1421: Clarify and/or codify any hard limit in the JSON schemaThe description update removes the “up to 10” wording, but the schema still does not declare any numeric constraints (
minimum,maximum) forspeakers_expected.
If the backend still enforces an upper bound (historically 10), callers now receive mixed signals – the docs say “any”, but the API may reject >10. Conversely, if the limit truly no longer exists, references to a hard-coded 10 in the neighbouringspeaker_options.max_speakers_expecteddefault and examples become confusing.Action items
- Confirm with the service team whether an upper bound is still enforced.
- Encode the truth in the schema:
# Only if a limit still exists speakers_expected: type: [integer, "null"] minimum: 1 maximum: 10 # or whatever the real ceiling is
- Audit sibling descriptions (
max_speakers_expected, examples, docs) for consistency so that clients and generated SDKs stay in sync.
Summary by CodeRabbit