feat:Update OpenAPI Specification for Ultravox Service with New Features

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new clientVersion property in the Call schema, enhancing call tracking.
  • Added operations for creating, updating, and deleting webhooks, improving webhook management.
  • New operations for managing API keys, including creation and updates.

• Documentation

  • Enhanced descriptions for API endpoints to improve clarity and usability for developers.

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the OpenAPI specification for the Ultravox service. A new property, clientVersion, is added to the Call schema, making it a required field. Several API endpoints, including api_keys and calls, receive enhanced descriptions for clarity. New operations for managing webhooks are introduced, including create, update, and delete functionalities, all secured by the apiKeyAuth scheme. Overall, the changes enhance the API's documentation and structure while maintaining its existing framework.

Changes

File Path	Change Summary
src/libs/Ultravox/openapi.yaml	- Added clientVersion as a required property in Call schema.
	- Added operations for webhooks: create, update, partial_update, and destroy.
	- Added operations for API keys: create, update, and partial_update.
	- Enhanced descriptions for api_keys and calls endpoints.
	- Specified usage of priorCallId in calls_create operation.

Poem

In the meadow where calls do ring,
A new version joins, oh what a thing!
Webhooks now dance, with actions galore,
API keys flourish, and we ask for more.
With each update, our service grows bright,
Hopping along, everything feels just right! 🐰✨

---

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?

❤️ 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.

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

🧹 Outside diff range and nitpick comments (1)

src/libs/Ultravox/openapi.yaml (1)

Line range hint 982-999: Consider the implications of making clientVersion both required and nullable.

While the implementation is technically correct, having a property that is both required and nullable could be confusing for API consumers. This combination means that the property must always be present in the response, but its value can be null.

Consider either:

1. Making it optional (removing from required array) if null values are expected, or
2. Making it non-nullable if it should always have a value

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 21937de and b43acf0.

⛔ Files ignored due to path filters (1)

• src/libs/Ultravox/Generated/Ultravox.Models.Call.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Ultravox/openapi.yaml (2 hunks)

🔇 Additional comments (1)

src/libs/Ultravox/openapi.yaml (1)

Line range hint 1-1: LGTM! Changes align with the PR objectives.

The implementation successfully:

• Adds the clientVersion tracking capability
• Enhances API documentation with detailed descriptions
• Implements webhook operations with proper security controls