Expand OpenAPI documentation with comprehensive API reference #63
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![dev-docs-github-app-dev[bot]](https://app.smartcontext.ai/default/https://avatars.githubusercontent.com/u/128262096?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR significantly enhances the OpenAPI documentation by adding detailed information about API usage, authentication, endpoints, and integration methods. The updates include comprehensive sections on code generation, API testing tools, response formats, rate limits, and webhook events. This expansion provides developers with a more complete reference for integrating with the Vapi API, making it easier to understand and implement our services.
The main changes are in the fern/api-reference/openapi.mdx file, transforming it from a basic endpoint reference into a full-featured API documentation resource.