Skip to content

Publish an OpenAPI specification and serve interactive docs #20

Description

@Manuel1234477

Context

The API is documented only in prose in the README. There is no machine-readable spec for client generation or a try-it-out UI.

Tasks

  • Produce an OpenAPI 3 spec for /payments (create/get/list) and /health — generated (e.g. utoipa) or hand-written.
  • Serve it plus a Swagger UI / Redoc page.
  • Keep it in sync with handler request/response shapes.

Acceptance criteria

  • A valid OpenAPI document is served and matches the implemented endpoints.

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions