Backlog reference: #494 · docs
Summary
Generate OpenAPI 3.0 spec from route annotations and serve at GET /api/docs
Context
Reference material a new contributor or self-hosting operator needs that isn't already covered by a category-specific doc: the OpenAPI spec, the deployment guide, and the onboarding walkthrough.
The path to a public, mainnet launch: KYC/compliance groundwork, price/localization/mobile polish, performance hardening, documentation, and the final production go-live checklist.
Acceptance Criteria
Definition of Done
Generated from the CoopLumen backlog (issue.md). See CONTRIBUTING.md for the contribution workflow.
Backlog reference: #494 ·
docsSummary
Generate OpenAPI 3.0 spec from route annotations and serve at
GET /api/docsContext
Reference material a new contributor or self-hosting operator needs that isn't already covered by a category-specific doc: the OpenAPI spec, the deployment guide, and the onboarding walkthrough.
The path to a public, mainnet launch: KYC/compliance groundwork, price/localization/mobile polish, performance hardening, documentation, and the final production go-live checklist.
Acceptance Criteria
GET /api/docs— implemented as described above.README.mdor the relevant docs index so it is discoverable.Definition of Done
Closes #494won't auto-link since this is a repo-internal reference — mention the issue number GitHub assigned instead).CONTRIBUTING.mdconventions (Conventional Commits, code style).CHANGELOG.mdupdated under[Unreleased]if the change is user- or API-visible.main.Generated from the CoopLumen backlog (
issue.md). SeeCONTRIBUTING.mdfor the contribution workflow.