Skip to content

Backend: Publish and enforce a complete OpenAPI specification #1216

Description

@Cedarich

Complexity: Medium (150)

Description
test-swagger-docs.sh exists at the repo root, which implies Swagger is wired up, but there is no guarantee that every controller, DTO, and error shape is described. Frontend issue 10 depends on a trustworthy specification to generate client types, and external integrators have no reliable contract.

Acceptance Criteria

  • Every controller and DTO carries the decorators needed for a complete schema, including error responses.
  • The specification is emitted to a committed artifact as part of the build.
  • CI fails when the committed specification is stale relative to the code.
  • Authentication schemes and required headers, including the idempotency header from Issue 3, are described.
  • The artifact path is documented so the webapp generation script can consume it.

Wave 8 · source: backend.md

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

BackendStellar WaveIssues in the Stellar wave programapiAPI developmentdocumentationImprovements or additions to documentationdxDeveloper experiencenestjsNestJS framework

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions