Skip to content

Commit bce7a44

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent e1181f3 commit bce7a44

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

api.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26722,6 +26722,26 @@ paths:
2672226722
error: backend:common:invalidArgument key=type
2672326723
errorName: backend:common:invalidArgument
2672426724
reqId: unk-nqo97l23l2ofpvgkbb8z
26725+
invalidArgumentWithFieldMessage:
26726+
summary: Parameter validation with structured field and message (subOrderSize)
26727+
value:
26728+
error: backend:common:invalidArgument key=subOrderSize
26729+
errorName: backend:common:invalidArgument
26730+
reqId: unk-nqo97l23l2ofpvgkbb8z
26731+
context:
26732+
errorName: backend:common:invalidArgument
26733+
field: subOrderSize
26734+
message: Sub-order size must be smaller than the total order quantity.
26735+
invalidLimitPricePrecisionWithContext:
26736+
summary: Limit price exceeds quote precision (structured field and message)
26737+
value:
26738+
error: backend:trade:invalidLimitPrice key=limitPrice
26739+
errorName: backend:trade:invalidLimitPrice
26740+
reqId: unk-nqo97l23l2ofpvgkbb8z
26741+
context:
26742+
errorName: backend:trade:invalidLimitPrice
26743+
field: limitPrice
26744+
message: limitPrice exceeds maximum decimal precision of 2
2672526745
invalidQuantity:
2672626746
summary: Invalid quantity specified (e.g., below minimum or above maximum order size). For marketable limit orders (where the limit price would execute immediately), the message includes additional context explaining that validation is performed at the current market price.
2672726747
value:
@@ -57434,10 +57454,29 @@ components:
5743457454
type: string
5743557455
reqId:
5743657456
type: string
57457+
context:
57458+
$ref: '#/components/schemas/ErrorContext'
5743757459
example:
5743857460
error: invalid permission
5743957461
errorName: backend:common:forbidden
5744057462
reqId: unk-nqo97l23l2ofpvgkbb8z
57463+
ErrorContext:
57464+
type: object
57465+
description: |
57466+
Optional structured metadata for REST validation failures.
57467+
The schema is fixed for client contract stability.
57468+
required:
57469+
- errorName
57470+
properties:
57471+
errorName:
57472+
type: string
57473+
description: Same value as the top-level errorName.
57474+
field:
57475+
type: string
57476+
description: Request field associated with the validation failure.
57477+
message:
57478+
type: string
57479+
description: Human-readable field-level validation message.
5744157480
EstimateTransactionFees:
5744257481
title: Bitcoin
5744357482
type: object

express-api.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3671,10 +3671,29 @@ components:
36713671
type: string
36723672
reqId:
36733673
type: string
3674+
context:
3675+
$ref: '#/components/schemas/ErrorContext'
36743676
example:
36753677
error: invalid permission
36763678
errorName: backend:common:forbidden
36773679
reqId: unk-nqo97l23l2ofpvgkbb8z
3680+
ErrorContext:
3681+
type: object
3682+
description: |
3683+
Optional structured metadata for REST validation failures.
3684+
The schema is fixed for client contract stability.
3685+
required:
3686+
- errorName
3687+
properties:
3688+
errorName:
3689+
type: string
3690+
description: Same value as the top-level errorName.
3691+
field:
3692+
type: string
3693+
description: Request field associated with the validation failure.
3694+
message:
3695+
type: string
3696+
description: Human-readable field-level validation message.
36783697
ErrorResponse:
36793698
title: ErrorResponse
36803699
type: object

0 commit comments

Comments
 (0)