Publish Versioned OpenAPI Spec as Build Artefact

[RUKAYAT-CODER]

Overview

swagger.config.ts generates the OpenAPI spec at runtime only. There is no versioned JSON spec checked into the repo or published as a CI artefact, making API integration harder for frontend and third-party consumers.

Background

The spec should be generated during the build step and saved as openapi.json. It should also be versioned alongside the code so breaking changes are visible in PRs.

Specifications

Features:

pm run generate:openapi script that writes docs/openapi.json`n- CI step uploads the spec as a build artefact

• Spec version pinned to the app version in package.json`n

Tasks:

• Add generate:openapi script using NestJS CLI
• Add CI step to generate and upload spec
• Add spec diff check to PR CI to flag breaking changes

Impacted Files:

• BackEnd/package.jsonn- .github/workflows/ci.ymln- BackEnd/docs/openapi.json (generated)

Acceptance Criteria:

• docs/openapi.json is generated and committed during CI
• PR diff shows API changes clearly

[YfengJ]

Hi maintainers, I would like to take this issue if it is available.\n\nPlanned approach:\n- add a backend script that generates a versioned OpenAPI JSON file into BackEnd/docs/openapi.json\n- keep the spec version aligned with BackEnd/package.json\n- add a CI step that generates and uploads the spec as an artifact\n- add a lightweight check so PRs surface API contract changes clearly\n- document the generation/validation workflow for contributors\n\nI will wait for assignment or maintainer confirmation before opening a PR, so this follows the GrantFox workflow.

[NeduTheDev1]

@NeduTheDev1 has applied to work on this issue as part of the Stellar Wave Program's 6th wave.

Please assign to me maintainer i can get it done no issues

ℹ️ Repo Maintainers: To accept this application, review their application or assign @NeduTheDev1 to this issue.

[drips-wave]

Congratulations, @NeduTheDev1! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 30, 2026.

🧑‍💻 @NeduTheDev1: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊