Skip to content

Add API documentation for GraphQL and REST endpoints#344

Open
matheus1lva wants to merge 1 commit intomainfrom
feat/api-docs
Open

Add API documentation for GraphQL and REST endpoints#344
matheus1lva wants to merge 1 commit intomainfrom
feat/api-docs

Conversation

@matheus1lva
Copy link
Collaborator

Why this exists
Clear, minimal context makes reviews fast.
Tell the reviewer exactly how to validate your work so they can approve it quickly without guesswork.

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

  • graphql.md - GraphQL endpoint, all query types (vaults, strategies, accounts, financial data, transfers, protocol management), custom scalars, and caching configuration
  • rest.md - REST base URL, list vaults, vault snapshots, timeseries, vault reports, and non-REST endpoints for queue monitoring and webhooks

The structure follows the existing documentation style and provides practical examples for each endpoint.

Test plan

  • Manual: Browse through both docs files in a markdown viewer to verify formatting, links, and examples are correct
  • Verify the endpoint URLs match the actual API routes in packages/web

Risk / impact

No code changes — documentation only, zero risk to production. Can be merged and updated independently of code changes.

@vercel
Copy link

vercel bot commented Feb 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
kong Ready Ready Preview, Comment Feb 16, 2026 9:44pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant