Skip to content

[M1] Add OpenAPI documentation for the V2 API #11

Description

@rodrigolinhas

Goal

Establish API documentation conventions early for the NestJS V2 backend.

Expected Scope

  • Swagger/OpenAPI setup (@nestjs/swagger).
  • API title, description, and version metadata.
  • V2 endpoint discovery.
  • Health/readiness documentation.
  • First real migrated capability (Quotes) documented later in M1.

Acceptance Criteria

  • OpenAPI document is generated from the NestJS application.
  • API documentation can be accessed in development (e.g. /api/docs).
  • M1 endpoints appear correctly.
  • Request/response schemas are represented where applicable.
  • Swagger setup does not expose secrets/configuration.

Dependencies

Suggested PR

PR 3 — Health/readiness + OpenAPI + testing foundation (with Issues E and G)

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

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions