Skip to content

docs(indexer): public HTTP reference for the list API with a route-parity test - #42

Open
jdjioe5-cpu wants to merge 1 commit into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/indexer-public-api-reference
Open

jdjioe5-cpu wants to merge 1 commit into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/indexer-public-api-reference

Conversation

@jdjioe5-cpu

Copy link
Copy Markdown

What and why

Closes #35.
Provides a checked, readable public HTTP reference (\services/indexer/docs/API.md) for the indexer's list API so dashboard builders, payees, and pilot partners can integrate without inspecting TypeScript schemas. Accompanied by an automated route-parity vitest suite (\services/indexer/test/api-docs.test.ts) ensuring docs and Fastify routes stay permanently in lockstep.

Changes

  • \services/indexer/docs/API.md\ (new): Covers all 5 routes (\GET /health, \GET /locks, \GET /locks/:id, \GET /payees, \GET /events/:txHash/:eventIndex). Documents request parameters (types, validation constraints, pagination), response shapes, nullability, HTTP error codes (400, 404, 503), decimal string amount scaling (explicitly noting minimal discrete unit \

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.

Document the list API as a checked reference: docs/API.md plus a route-parity test

2 participants