docs(mbe): add api descriptions for recoveries and accelerations#101
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds API documentation for BitGo Express recovery and acceleration endpoints by extracting inline route definitions into documented constants and adding OpenAPI descriptions. The changes improve code organization and provide better API documentation for developers using these endpoints.
- Extracted route definitions for accelerate, recovery, and recovery consolidations endpoints into documented constants
- Added comprehensive JSDoc comments explaining the purpose and functionality of each endpoint
- Updated the generated OpenAPI specification with summaries and descriptions for the endpoints
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/api/master/routers/masterBitGoExpressApiSpec.ts | Extracted inline route definitions into documented constants with JSDoc comments |
| masterBitgoExpress.json | Added OpenAPI summaries and descriptions for the documented endpoints |
| } | ||
| } | ||
| }, | ||
| "400": { |
There was a problem hiding this comment.
The 400 Bad Request response is only added to the accelerate endpoint but not to the recovery endpoints. For consistency, all endpoints should have the same error response codes documented.
pranavjain97
approved these changes
Aug 1, 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-5301