Skip to content

Move graphql API section to separate README#489

Merged
aditya1702 merged 6 commits intomainfrom
update-readme
Feb 4, 2026
Merged

Move graphql API section to separate README#489
aditya1702 merged 6 commits intomainfrom
update-readme

Conversation

@aditya1702
Copy link
Contributor

What

  • Move the API reference README section to another README in /internal/serve/graphql
  • Update the API documentation to match the current schema.

Why

  • The landing page README is very long and this provides a better developer experience to directly reference the API.

Known limitations

N/A

Copilot AI review requested due to automatic review settings February 4, 2026 14:31
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Moves the API reference documentation out of the root README into a dedicated GraphQL/API reference README, and refreshes the API docs to better match the current GraphQL schema.

Changes:

  • Added a new internal/serve/graphql/README.md containing the full API reference (REST transaction endpoints + GraphQL schema usage).
  • Removed the inlined API reference sections from the root README.md.
  • Updated the root README Table of Contents to link to the new API reference document.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
internal/serve/graphql/README.md New, dedicated API reference document for transaction endpoints and the GraphQL API schema.
README.md Removes inlined API reference content and links readers to the new API reference README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@aditya1702 aditya1702 requested a review from a team February 4, 2026 14:46
aditya1702 and others added 3 commits February 4, 2026 09:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@aditya1702 aditya1702 merged commit 8b7f4d8 into main Feb 4, 2026
9 checks passed
@aditya1702 aditya1702 deleted the update-readme branch February 4, 2026 15:00
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.

2 participants