Skip to content

Publish the OpenAPI schema as a build artifact #662

Description

@feyishola

Swagger is configured and the API is richly decorated, but the spec only exists at runtime behind the running server. There is no committed or published openapi.json.

This has a concrete cost visible in this repo: the frontend and backend disagreed about the /api/v1 prefix (see the docker-compose issue), and /certificates/search rejects the obvious parameter name with no documented contract. A generated spec makes both mechanically checkable.

Suggested: add a script that boots the Nest app in-process, writes openapi.json via SwaggerModule.createDocument, and uploads it as a CI artifact. A follow-up could diff it per PR to surface unintended breaking changes.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions