Merge pull request #184 from BitGo/update-bitgo-api-docs

Update API reference on BitGo Developer Portal

Author: ericcrosson-bitgo

api.yaml

@@ -2696,16 +2696,16 @@ paths:
         - Client Allocations & Deallocations
       parameters:
         - name: allocationIds
-          description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
+              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.
         - name: types
-          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.
+          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.
           in: query
           schema:
             type: array
@@ -2714,9 +2714,9 @@ paths:
               enum:
                 - allocation
                 - deallocation
-              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.
+              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.
         - name: statuses
-          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.
+          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.
           in: query
           schema:
             type: array
@@ -2726,42 +2726,42 @@ paths:
                 - cleared
                 - released
                 - reserved
-              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.
+              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.
         - name: currencies
-          description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies.
+          description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies. Currencies must be submitted as a comma-separated string.
           in: query
           schema:
             type: array
             items:
               type: string
-              description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies.
+              description: Optional array of currencies. If provided will only return allocations/deallocations with those currencies. Currencies must be submitted as a comma-separated string.
         - name: connectionIds
-          description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
+          description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds. ConnectionIds must be submitted as a comma-separated string.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
+              description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds. ConnectionIds must be submitted as a comma-separated string.
         - name: partnerIds
-          description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
+          description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds. PartnerIds must be submitted as a comma-separated string.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
+              description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds. PartnerIds must be submitted as a comma-separated string.
         - name: createdOnOrAfter
-          description: Optional date start range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or after this date.
+          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").
           in: query
           schema:
             type: string
             format: date-time
             title: ISO Date String
         - name: createdBefore
-          description: Optional date end range filter for createdAt (ISO Date). If provided will only return allocations/deallocations created on or before this date.
+          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").
           in: query
           schema:
             type: string
@@ -5062,16 +5062,16 @@ paths:
         - Partner Allocations & Deallocations
       parameters:
         - name: allocationIds
-          description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of allocationIds. If provided will only return allocations/deallocations with those ids.
+              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.
         - name: types
-          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.
+          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.
           in: query
           schema:
             type: array
@@ -5080,9 +5080,9 @@ paths:
               enum:
                 - allocation
                 - deallocation
-              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.
+              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.
         - name: statuses
-          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.
+          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.
           in: query
           schema:
             type: array
@@ -5092,43 +5092,43 @@ paths:
                 - cleared
                 - released
                 - reserved
-              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.
+              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.
         - name: currencies
-          description: Optional array of partner mapped currencies. If provided will only return allocations/deallocations with those currencies.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               minLength: 1
-              description: Optional array of partner mapped currencies. If provided will only return allocations/deallocations with those currencies.
+              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.
         - name: connectionIds
-          description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of connectionIds. If provided will only return allocations/deallocations for those connectionIds.
+              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.
         - name: partnerIds
-          description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of partnerIds. If provided will only return allocations/deallocations for those partnerIds.
+              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.
         - name: clientIds
-          description: Optional array of clientIds. If provided will only return allocations/deallocations for those clientIds.
+          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.
           in: query
           schema:
             type: array
             items:
               type: string
               title: uuid
-              description: Optional array of clientIds. If provided will only return allocations/deallocations for those clientIds.
+              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.
         - name: pageNumber
           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.
           in: query