feat(api-docs): serve OpenAPI 3.1 spec via interactive Swagger UI - #1245
Merged
ayomideadeniran merged 1 commit intoSep 1, 2026
Merged
Conversation
Upgrades the swagger-jsdoc definition to OpenAPI 3.1 and mounts swagger-ui-express at /api/docs with machine-readable JSON and YAML spec exports at /api/docs/spec.json and /api/docs/spec.yaml for automated SDK generation. Adds a /api/docs/info endpoint summarizing spec coverage. Closes StellarDevHub#1128
|
@lorenzo-romano Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@lorenzo-romano is attempting to deploy a commit to the Ayomide Adeniran's projects Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
Pr under review |
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
Upgrades the API documentation stack to OpenAPI 3.1 and exposes it interactively:
/api/docs(viaswagger-ui-express) for exploring the full API.swagger.ts)./api/docs/spec.json— OpenAPI 3.1 document as JSON/api/docs/spec.yaml— OpenAPI 3.1 document as YAML/api/docs/info— summary endpoint reporting spec version, path count, and schema count for CI assertions.yamlto dependencies for deterministic YAML serialization.Test Plan
npx tsc --noEmit— new/changed files compile clean.openapi: 3.1.0, 42 paths, YAML serialization round-trips.Closes #1128