Skip to content

Write docs/api-reference.md for the indexer REST API #296

Description

@Nursca

Description
Third-party developers building on the ILN ecosystem (bots, dashboards, integrations) need a standalone REST API reference that covers every indexer endpoint without reading the indexer source code.

Requirements and context

  • OpenAPI-style documentation for every endpoint: method, path, query parameters, request body, response schema, error codes
  • Include curl example for each endpoint
  • Cover: /invoices, /invoices/:id, /stats, /stats/history, /reputation/:address, /leaderboard, /events, /health
  • Include authentication section (API key header)
  • Auto-generate from the indexer's route definitions where possible (e.g. via swagger-jsdoc)

Suggested execution

git checkout -b docs/api-reference
  • Create docs/api-reference.md (or generate via OpenAPI)
  • Validate examples against the testnet indexer deployment
  • Link from indexer README.md

Example commit message
docs: write comprehensive indexer REST API reference

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions