Update OpenAPI documentation with comprehensive usage guide#84
Open
dev-docs-github-app-dev[bot] wants to merge 1 commit intomaintemp-testing-docs-dev/docs:mainfrom
2025-06-09-23-13-update-openapi-docstemp-testing-docs-dev/docs:2025-06-09-23-13-update-openapi-docsCopy head branch name to clipboard
Open
Update OpenAPI documentation with comprehensive usage guide#84dev-docs-github-app-dev[bot] wants to merge 1 commit intomaintemp-testing-docs-dev/docs:mainfrom 2025-06-09-23-13-update-openapi-docstemp-testing-docs-dev/docs:2025-06-09-23-13-update-openapi-docsCopy head branch name to clipboard
dev-docs-github-app-dev[bot] wants to merge 1 commit intomaintemp-testing-docs-dev/docs:mainfrom
2025-06-09-23-13-update-openapi-docstemp-testing-docs-dev/docs:2025-06-09-23-13-update-openapi-docsCopy head branch name to clipboard
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
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 enhances the OpenAPI documentation by adding detailed information about accessing and utilizing Vapi's API specification. The changes include adding sections on introduction, accessing the specification, usage examples, and OpenAPI version details. Also clarifies the specification URL text and adds navigation links to related resources. These updates will help developers better understand how to leverage our OpenAPI specification for integration purposes.