feat(mbe): add unified api spec for mbe#30
Merged
mohammadalfaiyazbitgo merged 1 commit intomasterfrom Jun 16, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR implements a unified API specification for the mbe, aligning route definitions within the API spec with their mounting in the Express application.
- Removed the hardcoded '/api' mount prefix from master.ts to align with the API spec endpoints.
- Updated masterApiSpec.ts to include the '/api' prefix in route paths.
- Consolidated API specifications in a new index.ts and added a script to generate the OpenAPI spec output in package.json.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/routes/master.ts | Changed mounting of the master API router to remove '/api' to use the spec-defined paths. |
| src/masterBitgoExpress/routers/masterApiSpec.ts | Updated route paths to include '/api' for consistency with spec requirements. |
| src/masterBitgoExpress/routers/index.ts | Combined API specs and exported the OpenAPI spec for internal and external usage. |
| package.json | Added an OpenAPI generation script and modified the test ssl command. |
| masterBitgoExpress.json | Generated OpenAPI JSON spec reflecting the new API definitions. |
Comments suppressed due to low confidence (1)
package.json:17
- The trailing comma inside the openssl command string may cause unintended behavior when executing the command. Consider removing the extra comma.
"generate-test-ssl": "openssl req -x509 -newkey rsa:2048 -keyout test-ssl-key.pem -out test-ssl-cert.pem -days 365 -nodes -subj '/CN=localhost',"
pranavjain97
approved these changes
Jun 16, 2025
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
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.
Ticket: WP-000000