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

Update API reference on BitGo Developer Portal
BitGo · Jan 28, 2025 · b5134f1 · b5134f1
2 parents a64afed + b82e78c
commit b5134f1
Showing 1 changed file with 42 additions and 42 deletions.
diff --git a/api.yaml b/api.yaml
@@ -2218,11 +2218,11 @@ paths:
                 $ref: '#/components/schemas/V1ErrorResponse'
   /api/network/v1/enterprises/{enterpriseId}/clients:
     post:
-      summary: Create Client
-      description: Create a new BitGo Network client.
+      summary: Create client
+      description: Create a new Go Network client.
       operationId: v1ClientsPostRoute
       tags:
-        - Onboarding
+        - Client Onboarding
       parameters:
         - name: enterpriseId
           in: path
@@ -2289,9 +2289,9 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/allocations:
     get:
-      summary: List Client Allocations and Deallocations
+      summary: List client allocations and deallocations
       description: |-
-        This API call allows clients to get a list of allocations & deallocations for any connected network account.
+        This API call allows clients to get a list of allocations and deallocations for any connected network account.
         Note that this endpoint requires a “types” query parameter set to “allocation” to view allocations
         or "deallocation" to view deallocations.
       operationId: v1ClientAllocationsGetRoute
@@ -2452,8 +2452,8 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/allocations/{allocationId}:
     get:
-      summary: Get client Allocation or Deallocation
-      description: Returns an allocation or deallocation. For use only by BitGo Network clients.
+      summary: Get client allocation or deallocation
+      description: Returns an allocation or deallocation. For use only by Go Network clients.
       operationId: v1ClientAllocationGetRoute
       tags:
         - Client Allocations & Deallocations
@@ -2535,7 +2535,7 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/balances:
     get:
-      summary: List Client Balances
+      summary: List client balances
       description: |-
         This API call allows clients to get trading and allocated balances at BitGo for any connected trading partner.
         The trading balances are live data. The data under networkBalances are not the live balances at the partner,
@@ -2639,11 +2639,11 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/connections:
     get:
-      summary: List Client Connections
-      description: Lists all your BitGo Network connections. For use only by BitGo Network clients.
+      summary: List client connections
+      description: List all your Go network connections. For use only by Go network clients.
       operationId: v1ClientConnectionsGetRoute
       tags:
-        - Activation
+        - Client Activation
       parameters:
         - name: pageNumber
           in: query
@@ -2752,14 +2752,14 @@ paths:
               schema:
                 $ref: '#/components/schemas/V1ErrorPayload'
     post:
-      summary: Connect to Partner
+      summary: Connect to partner
       description: |-
-        Connect your BitGo Network client account to a BitGo Network partner, enabling you to
+        Connect your Go Network client account to a Go Network partner, enabling you to
         trade funds that you have custodied with BitGo. You must have an account on the partner's site.
         Clients can have multiple connections to the same partner.
       operationId: v1ClientConnectionsPostRoute
       tags:
-        - Activation
+        - Client Activation
       parameters:
         - name: enterpriseId
           in: path
@@ -2872,7 +2872,7 @@ paths:
       description: Returns a BitGo Network connection by its connection ID. For use only by BitGo Network clients.
       operationId: v1ClientConnectionGetRoute
       tags:
-        - Activation
+        - Client Activation
       parameters:
         - name: connectionId
           in: path
@@ -2954,7 +2954,7 @@ paths:
       description: Update a BitGo Network connection by its connection ID. For use only by BitGo Network clients.
       operationId: v1ClientConnectionPutRoute
       tags:
-        - Activation
+        - Client Activation
       parameters:
         - name: enterpriseId
           in: path
@@ -3050,12 +3050,12 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/allocations:
     post:
-      summary: Allocate funds to Partner Connection
+      summary: Allocate funds to partner connection
       description: |-
         This API call allows clients to allocate funds to a connected partner for trade.
         A successful allocation indicates that funds are locked at BitGo and available for spend on the connected partner.
         Note: Allocations will happen synchronously and allocated amounts can be viewed in the
-        BitGo Application or via a balances endpoint.
+        BitGo application or via a balances endpoint.
       operationId: V1ClientAllocationsPostRoute
       tags:
         - Client Allocations & Deallocations
@@ -3301,7 +3301,7 @@ paths:
                 $ref: '#/components/schemas/V1ReservedDeallocationOrErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/settlements:
     get:
-      summary: List Client Settlements
+      summary: List client settlements
       description: This API call allows clients to get a list of settlements that involve their accounts and their metadata.
       operationId: v1ClientSettlementsGetRoute
       tags:
@@ -3415,7 +3415,7 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/settlements/{settlementId}:
     get:
-      summary: Get Client Settlement
+      summary: Get client settlement
       description: |-
         This API call allows clients to get a list of settlement transactions for any connected network account,
         for a specific settlement. The settlement and its metadata will be returned along with all
@@ -3516,8 +3516,8 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/clients/settlementTransfers:
     get:
-      summary: List Client Settlement Transfers
-      description: Lists all settlement transfers for your BitGo Network client account.
+      summary: List client settlement transfers
+      description: Lists all settlement transfers for your Go Network client account.
       operationId: v1ClientSettlementTransfersGetRoute
       tags:
         - Client Settlements & Transfers
@@ -3666,10 +3666,10 @@ paths:
   /api/network/v1/enterprises/{enterpriseId}/partners:
     get:
       summary: List Partners
-      description: Lists all BitGo Network Partners.
+      description: Lists all Go Network Partners.
       operationId: v1PartnersGetRoute
       tags:
-        - Onboarding
+        - Partner Onboarding
       parameters:
         - name: pageNumber
           in: query
@@ -3780,7 +3780,7 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
     post:
       summary: Create Partner
-      description: Create a new BitGo Network Partner.
+      description: Create a new Go Network Partner.
       operationId: v1PartnersPostRoute
       tags:
         - Onboarding
@@ -3873,7 +3873,7 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/partners/allocations:
     get:
-      summary: List partner Allocations and Deallocations
+      summary: List partner allocations and deallocations
       description: Lists all allocations and deallocations. For use only by BitGo Network partners.
       operationId: v1PartnerAllocationsGetRoute
       tags:
@@ -4028,8 +4028,8 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/partners/allocations/{allocationId}:
     get:
-      summary: Get Partner Allocation or Deallocation
-      description: Returns an allocation or deallocation. For use only by BitGo Network partners.
+      summary: Get partner allocation or deallocation
+      description: Returns an allocation or deallocation. For use only by Go Network partners.
       operationId: v1PartnerAllocationGetRoute
       tags:
         - Partner Allocations & Deallocations
@@ -4226,10 +4226,10 @@ paths:
   /api/network/v1/enterprises/{enterpriseId}/partners/connections:
     get:
       summary: List Partner Connections
-      description: Returns all your BitGo Network connections. For use only by BitGo Network partners.
+      description: Returns all your Go network connections. For use only by Go Network partners.
       operationId: v1PartnerConnectionsGetRoute
       tags:
-        - Activation
+        - Partner Activation
       parameters:
         - name: pageNumber
           in: query
@@ -4354,10 +4354,10 @@ paths:
   /api/network/v1/enterprises/{enterpriseId}/partners/connections/{connectionId}:
     get:
       summary: Get Partner Connection
-      description: Returns a BitGo Network connection by its connection ID. For use only by BitGo Network partners.
+      description: Returns a Go Network connection by its connection ID. For use only by Go Network partners.
       operationId: v1PartnerConnectionGetRoute
       tags:
-        - Activation
+        - Partner Activation
       parameters:
         - name: connectionId
           in: path
@@ -4430,8 +4430,8 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/partners/settlements:
     get:
-      summary: List Partner Settlements
-      description: Lists all settlements for your BitGo Network partner account.
+      summary: List partner settlements
+      description: Lists all settlements for your Go Network partner account.
       operationId: v1PartnerSettlementsGetRoute
       tags:
         - Partner Settlements & Transfers
@@ -4537,8 +4537,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/V1ErrorPayload'
     post:
-      summary: Perform Partner Settlement
-      description: Partner route to perform a Settlement.
+      summary: Perform partner settlement
+      description: Partner route to perform a settlement.
       operationId: v1PartnerSettlementsPostRoute
       tags:
         - Partner Settlements & Transfers
@@ -4643,8 +4643,8 @@ paths:
                 $ref: '#/components/schemas/V1PartnerIncompleteSettlementOrErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/partners/settlements/{settlementId}:
     get:
-      summary: Get Partner Settlement
-      description: Returns a settlement for your BitGo Network partner account.
+      summary: Get partner settlement
+      description: Returns a settlement for your Go Network partner account.
       operationId: v1PartnerSettlementGetRoute
       tags:
         - Partner Settlements & Transfers
@@ -4769,9 +4769,9 @@ paths:
                 $ref: '#/components/schemas/V1ErrorPayload'
   /api/network/v1/enterprises/{enterpriseId}/partners/settlements/nonReconciled:
     post:
-      summary: '[DEPRECATED] Perform Partner Settlement'
+      summary: '[DEPRECATED] Perform partner settlement'
       description: |-
-        [DEPRECATED] Partner route to perform a Settlement.
+        [DEPRECATED] Partner route to perform a settlement.
 
         NOTE: this route is being deprecated in favor
         of the POST /api/network/v1/enterprises/{enterpriseId}/partners/settlements route.
@@ -4992,7 +4992,7 @@ paths:
   /api/network/v1/enterprises/{enterpriseId}/partners/settlements/onchain/deposits:
     post:
       summary: Post deposit info for an on-chain settlement
-      description: Partner route to provide external deposit information tied to an on-chain settlement.
+      description: Partner route for providing external deposit information tied to an on-chain settlement.
       operationId: v1PartnerExtDepositsPostRoute
       tags:
         - Partner Settlements & Transfers
@@ -5112,7 +5112,7 @@ paths:
   /api/network/v1/enterprises/{enterpriseId}/supportedCurrencies:
     get:
       summary: List Partner-Supported Currencies
-      description: List currencies which can be allocated/deallocated to/from a connection to a BitGo Network Partner.
+      description: List all the currencies a given Go Network Partner supports for allocation and deallocation.
       operationId: v1EnterpriseSupportedCurrenciesRoute
       tags:
         - Client Allocations & Deallocations