doc(mbe): add documentation for recoveries and accelerations#84
doc(mbe): add documentation for recoveries and accelerations#84pranavjain97 merged 1 commit intomasterfrom
Conversation
pranavjain97
left a comment
pranavjain97
left a comment
There was a problem hiding this comment.
You have some lint failures. Also, i see lot of the desc's have 2 sentences without a . in the middle. Is it getting formatted like that as well, or is it a new line?
masterBitgoExpress.json
Outdated
| "txid": { | ||
| "type": "string" | ||
| "type": "string", | ||
| "description": "The transaction ID (hash) of the acceleration transaction This can be used to track the transaction on a block explorer", |
There was a problem hiding this comment.
nit: ```suggestion
"description": "The transaction ID (hash) of the acceleration transaction. This can be used to track the transaction on a block explorer",
mohammadalfaiyazbitgo
force-pushed
the
WP-5301/developer-documentaion
branch
3 times, most recently
from
47be25b to
c890fea
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive JSDoc documentation for BitGo Express wallet recovery and transaction acceleration endpoints. The main focus is documenting API request/response structures and recovery parameters for different blockchain types (UTXO, EVM, Solana).
Key changes include:
- Added detailed JSDoc comments to recovery parameter types and acceleration request structures
- Enhanced OpenAPI schema with descriptions and examples for all recovery and acceleration endpoints
- Updated documentation to clarify usage of TSS vs multisig recovery parameters
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/shared/errors.ts | Added JSDoc documentation for ErrorResponse properties |
| src/api/master/routers/masterApiSpec.ts | Added comprehensive documentation for recovery parameters, acceleration requests, and response types |
| masterBitgoExpress.json | Updated OpenAPI schema with detailed descriptions and examples for recovery and acceleration endpoints |
| CLAUDE.md | Added error handling documentation and expanded API endpoint listings |
|
|
||
| /** | ||
| * Request type for wallet recovery consolidations endpoint | ||
| * Used to consolidate and funds from multiple addresses in a wallet, via signing with user and backup keys |
There was a problem hiding this comment.
There's a missing word in the comment. It should be "consolidate and recover funds" instead of "consolidate and funds".
| * Used to consolidate and funds from multiple addresses in a wallet, via signing with user and backup keys | |
| * Used to consolidate and recover funds from multiple addresses in a wallet, via signing with user and backup keys |
masterBitgoExpress.json
Outdated
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "description": "Request type for wallet recovery consolidations endpoint Used to consolidate and funds from multiple addresses in a wallet, via signing with user and backup keys", |
There was a problem hiding this comment.
There's a missing word in the description. It should be "consolidate and recover funds" instead of "consolidate and funds".
| "description": "Request type for wallet recovery consolidations endpoint Used to consolidate and funds from multiple addresses in a wallet, via signing with user and backup keys", | |
| "description": "Request type for wallet recovery consolidations endpoint Used to consolidate and recover funds from multiple addresses in a wallet, via signing with user and backup keys", |
mohammadalfaiyazbitgo
force-pushed
the
WP-5301/developer-documentaion
branch
from
c890fea to
9550476
Compare
pranavjain97
left a comment
pranavjain97
left a comment
There was a problem hiding this comment.
All the descriptions have 2 sentences without any period or , seperating them. Lets fix that
mohammadalfaiyazbitgo
force-pushed
the
WP-5301/developer-documentaion
branch
from
9550476 to
64f0140
Compare
2 participants
Ticket: WP-5301