Add API documentation for GraphQL and REST endpoints#344
Open
matheus1lva wants to merge 1 commit intomainfrom
Open
Add API documentation for GraphQL and REST endpoints#344matheus1lva wants to merge 1 commit intomainfrom
matheus1lva wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
This adds comprehensive documentation for Kong's GraphQL and REST APIs. The new docs cover all available endpoints, query parameters, request/response examples, and caching behavior to help developers integrate with the indexer.
How to review
Review the two new markdown files in
docs/:The structure follows the existing documentation style and provides practical examples for each endpoint.
Test plan
Risk / impact
No code changes — documentation only, zero risk to production. Can be merged and updated independently of code changes.