Add OpenAPI 3.0.3 Specification and Interactive Documentation#22
Open
BarryArinze wants to merge 11 commits intoStellarState:mainfrom
Open
Add OpenAPI 3.0.3 Specification and Interactive Documentation#22BarryArinze wants to merge 11 commits intoStellarState:mainfrom
BarryArinze wants to merge 11 commits intoStellarState:mainfrom
Conversation
- Implement Express app with /api/v1 routing pattern - Add GET /health endpoint with standard response envelope - Add basic auth endpoints (wallet-login, refresh, me) - Create comprehensive OpenAPI 3.0.3 specification in openapi.yaml - Set up Swagger UI at /api/docs using swagger-ui-express - Document standard response envelope (success, data, error, meta) - Add Bearer JWT security scheme for protected endpoints - Include npm run validate-api script for CI-friendly spec validation - Add comprehensive documentation in docs/OPENAPI.md - Update README with interactive docs information New dependencies: - swagger-ui-express@^5.0.0 - yamljs@^0.3.0 - @types/swagger-ui-express@^4.1.6 - @types/yamljs@^0.2.34 Closes StellarState#15
|
@BarryArinze 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! 🚀 |
Contributor
|
@BarryArinze Please fix workflow errors |
- Add @types/swagger-ui-express@4.1.8 - Add @types/yamljs@0.2.34 - Add swagger-ui-express@5.0.1 - Add yamljs@0.3.0 - Add swagger-ui-dist@5.32.1 - Add @scarf/scarf@1.4.0 - Add argparse@1.0.10 Fixes npm ci failure in CI pipeline due to missing package entries
Author
|
Issue fixed
…On Wed, Mar 25, 2026 at 10:47 PM Jay ***@***.***> wrote:
*Jayrodri088* left a comment (StellarState/SS-backend#22)
<#22?email_source=notifications&email_token=CANCNJTN7T5HLGFLWGW7DST4SRHV3A5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMJTGAYDENBSGY4KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4130024268>
@BarryArinze <https://github.com/BarryArinze> Please fix workflow errors
—
Reply to this email directly, view it on GitHub
<#22?email_source=notifications&email_token=CANCNJTN7T5HLGFLWGW7DST4SRHV3A5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMJTGAYDENBSGY4KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4130024268>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/CANCNJW5IH5J6IZU4WI4WW34SRHV3AVCNFSM6AAAAACW66TE66VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DCMZQGAZDIMRWHA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Contributor
|
@BarryArinze Still failing |
- Add missing @types/swagger-ui-dist@3.30.6 package entry - Remove duplicate argparse@1.0.10 (argparse@2.0.1 already exists) - Ensure package-lock.json is fully in sync with package.json Fixes remaining npm ci failures in CI pipeline
- Fix @types/swagger-ui-express@4.1.8 integrity hash - Fix @types/yamljs@0.2.34 integrity hash - Fix swagger-ui-express@5.0.1 integrity hash - Fix yamljs@0.3.0 integrity hash - Fix swagger-ui-dist@5.32.1 integrity hash - Fix @scarf/scarf@1.4.0 integrity hash - Add @types/swagger-ui-dist@3.30.6 with correct integrity hash All package entries now have real npm registry integrity hashes
Author
|
Done. Please rerun the workflow test |
- Add argparse@1.0.10 as root-level dependency - Resolves final npm ci missing package error - All CI dependencies now present in package-lock.json
…/SS-backend into feature/openapi-docs
- Remove duplicate argparse@1.0.10 entry - Keep existing argparse@2.0.1 at root level - Resolves CI missing argparse@2.0.1 error
- CI now runs on feature/openapi-docs branch - Allows testing OpenAPI documentation changes - Resolves workflow not triggering issue
- Fix error handling type in auth.middleware.ts (unknown instead of any) - Add proper typing for Request with user property in auth.controller.ts - Import AuthenticatedRequestUser type for type safety - Resolve @typescript-eslint/no-explicit-any violations
Contributor
|
Please fix ci errors |
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.
Add OpenAPI 3.0.3 Specification and Interactive Documentation
Summary
Implements comprehensive OpenAPI 3.0.3 documentation with interactive Swagger UI, providing a single source of truth for API request/response shapes and reducing integration drift for frontend teams and partners.
Changes Made
/api/v1routing patternGET /healthwith standard response envelope/api/v1/auth/*)/api/docssuccess,data,error,meta)npm run validate-apifor CI-friendly spec validationNew Dependencies
swagger-ui-express@^5.0.0- Interactive documentation UIyamljs@^0.3.0- YAML parsing for OpenAPI spec@types/swagger-ui-express@^4.1.6- TypeScript definitions@types/yamljs@^0.2.34- TypeScript definitionsTesting