feat:Add new endpoints and modify existing schemas in Ultravox API #13
Conversation
WalkthroughThe changes to the Ultravox API involve the addition of multiple new endpoints for managing API keys, calls, tools, voices, and webhooks. Additionally, there are modifications to existing schemas, specifically the Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
src/libs/Ultravox/openapi.yaml (2)
1560-1563: Consider refining the timeout pattern for BaseToolDefinition.The timeout field implementation is well documented with clear execution implications. However, the regex pattern allows negative durations which doesn't make sense for a timeout value.
Consider updating the pattern to disallow negative values:
- pattern: '^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$' + pattern: '^(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$'
Line range hint
1-8: Consider adding rate limiting information to the API specification.While the API security and structure are well-defined, the specification would benefit from documenting rate limiting behavior. This helps API consumers better understand usage limits and implement appropriate handling.
Consider adding standard rate limiting response headers to the specification:
components: headers: X-RateLimit-Limit: schema: type: integer description: The number of allowed requests in the current period X-RateLimit-Remaining: schema: type: integer description: The number of remaining requests in the current period X-RateLimit-Reset: schema: type: integer format: unix-timestamp description: The time at which the current rate limit window resets paths: # Add to all authenticated endpoints responses: '429': description: Too Many Requests headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (2)
src/libs/Ultravox/Generated/Ultravox.Models.UltravoxV1BaseToolDefinition.g.csis excluded by!**/generated/**src/libs/Ultravox/Generated/Ultravox.Models.UltravoxV1CallTool.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Ultravox/openapi.yaml(2 hunks)
| timeout: | ||
| pattern: '^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$' | ||
| type: string | ||
| description: "The maximum amount of time the tool is allowed for execution. The conversation is frozen\n while tools run, so prefer sticking to the default unless you're comfortable with that\n consequence. If your tool is too slow for the default and can't be made faster, still try to\n keep this timeout as low as possible.\n Note: For read APIs, 0s actually means unset (i.e. use the default)." |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider schema reuse for timeout definition.
The timeout field is duplicated between BaseToolDefinition and CallTool with identical pattern and description. Additionally, like its counterpart, it allows negative durations.
Consider:
- Creating a shared schema component for the timeout field
- Updating the pattern to disallow negative values
# Add to components.schemas
DurationTimeout:
pattern: '^(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$'
type: string
description: "The maximum amount of time the tool is allowed for execution. The conversation is frozen\n while tools run, so prefer sticking to the default unless you're comfortable with that\n consequence. If your tool is too slow for the default and can't be made faster, still try to\n keep this timeout as low as possible.\n Note: For read APIs, 0s actually means unset (i.e. use the default)."
# Then reference it in both schemas
timeout:
$ref: '#/components/schemas/DurationTimeout'
Summary by CodeRabbit
StartCallRequest,CallTool, andBaseToolDefinitionwith additional fields.