Skip to content

BE-111: OpenAPI Spec Completeness Gate #810

Description

@Cedarich

Labels: Backend, Stellar Wave, api, documentation, ci-cd
Complexity: Medium (150)

Description
The backend now exposes a large surface across roughly 45 modules, but nothing enforces that endpoints are documented with request/response schemas. Clients integrating against it have to read controllers. Add a CI gate that fails when endpoints lack schema annotations.

Acceptance Criteria

  • An OpenAPI document is generated during CI from the running application metadata.
  • CI fails when a route is missing a response schema, or a DTO field is missing a type.
  • A documented allowlist covers intentional exclusions (for example internal-only routes).
  • The generated spec is published as a CI artifact on every run.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    BackendStellar WaveIssues in the Stellar wave programapici-cdAuto-createddocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions