feat: serve OpenAPI spec at /api/docs endpoint (closes #87) - #154
Merged
oraimoitel merged 1 commit intoAug 2, 2026
Merged
Conversation
The /api/docs route (src/middleware/openapi.js, wired in src/server.js) and its test coverage (tests/openapi.test.js) were added in 813a4d2, but that commit didn't reference this issue, so it never auto-closed. This commit links the existing work to the issue. - GET /api/docs serves a Swagger UI HTML page rendering the spec - GET /api/docs/openapi.json serves the raw OpenAPI 3.1 spec as JSON - GET /api/docs/openapi.yaml serves a YAML content-type response - CORS headers (Access-Control-Allow-Origin/Methods/Headers) applied to all of the above, including OPTIONS preflight - Spec paths match existing routes (/health, /circles, etc.) - npm test passes (31/31) Closes cocor-tech#87
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Links already-merged OpenAPI docs route to issue #87, which never auto-closed because the commit that added it (813a4d2) didn't reference the issue number.
GET /api/docsserves a Swagger UI HTML page rendering the specGET /api/docs/openapi.jsonserves the raw OpenAPI 3.1 spec as JSONGET /api/docs/openapi.yamlserves a YAML content-type responseAccess-Control-Allow-Origin/Methods/Headers) applied across all of the above, including OPTIONS preflight/health,/circles, etc.)src/server.jsrequest routingThis PR itself carries no code changes (empty commit) — it exists solely to close #87 via the commit trailer, since that work already shipped to master.
Test plan
npm testpasses (31/31) on master with this historytests/openapi.test.jscovers JSON, HTML, and CORS/preflight behaviorCloses #87