Skip to content

Commit 96048e1

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 002a307 commit 96048e1

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

api.yaml

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2696,16 +2696,16 @@ paths:
26962696
- Client Allocations & Deallocations
26972697
parameters:
26982698
- name: allocationIds
2699-
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
2699+
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids. allocationIds are unique identifiers (UUIDs) for allocations. UUIDs must be submitted as a comma-separated string.
27002700
in: query
27012701
schema:
27022702
type: array
27032703
items:
27042704
type: string
27052705
title: uuid
2706-
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
2706+
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids. allocationIds are unique identifiers (UUIDs) for allocations. UUIDs must be submitted as a comma-separated string.
27072707
- name: types
2708-
description: Optional array of types. If provided will only return allocations/deallocations with those types. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
2708+
description: Optional array of types. If provided will only return allocations/deallocations with those types. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
27092709
in: query
27102710
schema:
27112711
type: array
@@ -2714,9 +2714,9 @@ paths:
27142714
enum:
27152715
- allocation
27162716
- deallocation
2717-
description: Optional array of types. If provided will only return allocations/deallocations with those types. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
2717+
description: Optional array of types. If provided will only return allocations/deallocations with those types. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
27182718
- name: statuses
2719-
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
2719+
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
27202720
in: query
27212721
schema:
27222722
type: array
@@ -2726,42 +2726,42 @@ paths:
27262726
- cleared
27272727
- released
27282728
- reserved
2729-
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
2729+
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
27302730
- name: currencies
2731-
description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies.
2731+
description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies. Currencies must be submitted as a comma-separated string.
27322732
in: query
27332733
schema:
27342734
type: array
27352735
items:
27362736
type: string
2737-
description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies.
2737+
description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies. Currencies must be submitted as a comma-separated string.
27382738
- name: connectionIds
2739-
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
2739+
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds. ConnectionIds must be submitted as a comma-separated string.
27402740
in: query
27412741
schema:
27422742
type: array
27432743
items:
27442744
type: string
27452745
title: uuid
2746-
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
2746+
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds. ConnectionIds must be submitted as a comma-separated string.
27472747
- name: partnerIds
2748-
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
2748+
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds. PartnerIds must be submitted as a comma-separated string.
27492749
in: query
27502750
schema:
27512751
type: array
27522752
items:
27532753
type: string
27542754
title: uuid
2755-
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
2755+
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds. PartnerIds must be submitted as a comma-separated string.
27562756
- name: createdOnOrAfter
2757-
description: Optional date start range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or after this date.
2757+
description: Optional date start range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or after this date. This date should be in ISO 8601 format (e.g., "2023-01-01T00:00:00Z").
27582758
in: query
27592759
schema:
27602760
type: string
27612761
format: date-time
27622762
title: ISO Date String
27632763
- name: createdBefore
2764-
description: Optional date end range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or before this date.
2764+
description: Optional date end range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or before this date. This date should be in ISO 8601 format (e.g., "2023-01-01T00:00:00Z").
27652765
in: query
27662766
schema:
27672767
type: string
@@ -5062,16 +5062,16 @@ paths:
50625062
- Partner Allocations & Deallocations
50635063
parameters:
50645064
- name: allocationIds
5065-
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
5065+
description: Optional array of allocationIds. allocationIds are unique identifiers (UUIDs) for allocations. If UUIDs are provided, only allocations/deallocations with those UUIDs are returned. UUIDs must be submitted as a comma-separated string.
50665066
in: query
50675067
schema:
50685068
type: array
50695069
items:
50705070
type: string
50715071
title: uuid
5072-
description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
5072+
description: Optional array of allocationIds. allocationIds are unique identifiers (UUIDs) for allocations. If UUIDs are provided, only allocations/deallocations with those UUIDs are returned. UUIDs must be submitted as a comma-separated string.
50735073
- name: types
5074-
description: Optional array of types. If provided will only return allocations/deallocations with those types. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
5074+
description: Optional array of types. If types are provided, only allocations/deallocations with those types are returned. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
50755075
in: query
50765076
schema:
50775077
type: array
@@ -5080,9 +5080,9 @@ paths:
50805080
enum:
50815081
- allocation
50825082
- deallocation
5083-
description: Optional array of types. If provided will only return allocations/deallocations with those types. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
5083+
description: Optional array of types. If types are provided, only allocations/deallocations with those types are returned. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.
50845084
- name: statuses
5085-
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
5085+
description: Optional array of statuses. If statuses are provided, only allocations/deallocations with those statuses are returned. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
50865086
in: query
50875087
schema:
50885088
type: array
@@ -5092,43 +5092,43 @@ paths:
50925092
- cleared
50935093
- released
50945094
- reserved
5095-
description: Optional array of statuses. If provided will only return allocations/deallocations with those statuses. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
5095+
description: Optional array of statuses. If statuses are provided, only allocations/deallocations with those statuses are returned. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.
50965096
- name: currencies
5097-
description: Optional array of partner mapped currencies. If provided will only return allocations/deallocations with those currencies.
5097+
description: Optional array of partner mapped currencies. If currencies are provided, only allocations/deallocations with those currencies are returned. Currencies must be submitted as a comma-separated string.
50985098
in: query
50995099
schema:
51005100
type: array
51015101
items:
51025102
type: string
51035103
minLength: 1
5104-
description: Optional array of partner mapped currencies. If provided will only return allocations/deallocations with those currencies.
5104+
description: Optional array of partner mapped currencies. If currencies are provided, only allocations/deallocations with those currencies are returned. Currencies must be submitted as a comma-separated string.
51055105
- name: connectionIds
5106-
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
5106+
description: Optional array of connectionIds. If connectionIds are provided, only allocations/deallocations for those connectionIds are returned. ConnectionIds must be submitted as a comma-separated string.
51075107
in: query
51085108
schema:
51095109
type: array
51105110
items:
51115111
type: string
51125112
title: uuid
5113-
description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
5113+
description: Optional array of connectionIds. If connectionIds are provided, only allocations/deallocations for those connectionIds are returned. ConnectionIds must be submitted as a comma-separated string.
51145114
- name: partnerIds
5115-
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
5115+
description: Optional array of partnerIds. If partnerIds are provided, only allocations/deallocations for those partnerIds are returned. PartnerIds must be submitted as a comma-separated string.
51165116
in: query
51175117
schema:
51185118
type: array
51195119
items:
51205120
type: string
51215121
title: uuid
5122-
description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
5122+
description: Optional array of partnerIds. If partnerIds are provided, only allocations/deallocations for those partnerIds are returned. PartnerIds must be submitted as a comma-separated string.
51235123
- name: clientIds
5124-
description: Optional array of clientIds. If provided will only return allocations/deallocations for those clientIds.
5124+
description: Optional array of clientIds. If clientIds are provided, only allocations/deallocations for those clientIds are returned. ClientIds must be submitted as a comma-separated string.
51255125
in: query
51265126
schema:
51275127
type: array
51285128
items:
51295129
type: string
51305130
title: uuid
5131-
description: Optional array of clientIds. If provided will only return allocations/deallocations for those clientIds.
5131+
description: Optional array of clientIds. If clientIds are provided, only allocations/deallocations for those clientIds are returned. ClientIds must be submitted as a comma-separated string.
51325132
- name: pageNumber
51335133
description: The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
51345134
in: query

0 commit comments

Comments
 (0)