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

Update API reference on BitGo Developer Portal

Author: ericcrosson-bitgo

api.yaml

@@ -18680,56 +18680,6 @@ paths:
                 $ref: '#/components/schemas/PlatformError3'
         '404':
           description: Not Found
-  /api/v2/{coin}/wallet/{walletId}/unspents:
-    get:
-      tags:
-        - Wallet
-      summary: Get unspents
-      description: Returns unspent transaction outputs for a wallet
-      operationId: v2.wallet.unspents
-      parameters:
-        - $ref: '#/components/parameters/pathCoin'
-        - $ref: '#/components/parameters/pathWalletId'
-        - $ref: '#/components/parameters/limit'
-        - $ref: '#/components/parameters/maxValue'
-        - $ref: '#/components/parameters/minConfirms'
-        - $ref: '#/components/parameters/enforceMinConfirmsForChange'
-        - $ref: '#/components/parameters/minHeight'
-        - $ref: '#/components/parameters/minValue'
-        - $ref: '#/components/parameters/prevId'
-        - $ref: '#/components/parameters/segwit'
-        - name: includeRbf
-          in: query
-          description: True, if including Replace-By-Fee (RBF) unspents.
-          schema:
-            type: boolean
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/WalletUnspents'
-        '400':
-          description: Bad Request
-          content:
-            application/json:
-              schema:
-                oneOf:
-                  - $ref: '#/components/schemas/PlatformError3'
-                  - $ref: '#/components/schemas/InvalidWalletId'
-        '403':
-          description: Forbidden
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/PlatformError3'
-        '404':
-          description: Not Found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/PlatformError3'
   /api/v2/{coin}/wallet/{walletId}/maximumSpendable:
     get:
       tags:
@@ -25533,6 +25483,72 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/PlatformError'
+  /api/v2/{coin}/wallet/{walletId}/unspents:
+    get:
+      summary: List unspents on a wallet
+      operationId: v2.wallet.unspents
+      tags:
+        - Wallet
+      parameters:
+        - name: limit
+          description: Limit the number of results.
+          in: query
+          schema:
+            type: string
+            default: '25'
+            minimum: 0
+            maximum: 2000
+            format: number
+        - name: prevId
+          description: Only return results created after this ID
+          in: query
+          schema:
+            type: string
+            minLength: 1
+        - name: chains
+          description: Filter by chains. May be given mutiple times
+          in: query
+          schema:
+            type: array
+            items:
+              type: string
+              format: number
+              description: Filter by chains. May be given mutiple times
+        - name: target
+          description: The combined target value of the unspents
+          in: query
+          schema:
+            type: string
+            format: number
+        - name: numRecipients
+          description: number of recipients of the unspents
+          in: query
+          schema:
+            type: string
+            format: number
+        - name: coin
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/CoinNonEmptyString'
+        - name: walletId
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/WalletIdNonEmptyString'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WalletUnspentsResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformError'
   /api/v2/{coin}/wallet/balances:
     get:
       summary: List total balances by coin
@@ -29506,7 +29522,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/InvoiceInfo'
+                $ref: '#/components/schemas/LightningInvoice'
         '400':
           description: Bad Request
           content:
@@ -34895,12 +34911,6 @@ components:
       description: Query for `Wallets` with a label containing this string
       schema:
         type: string
-    segwit:
-      name: segwit
-      in: query
-      description: DEPRECATED. Mutually exclusive with `chains`. Returns only `p2shP2wsh` unspents/addresses on true. Returns only `p2sh` unspents/addresses on false. Equivalent to passing 10 and 11 as the only value in `chains` on true, 0 and 1 on false.
-      schema:
-        type: boolean
     showAllWallets:
       name: showAllWallets
       description: Include wallets that have `deleted` or `creationFailed` set to **true**
@@ -43722,40 +43732,63 @@ components:
           items:
             type: object
             properties:
-              valueMsat:
+              memo:
                 type: string
-                format: number
-              paymentHash:
+                description: A memo or description for the invoice
+                example: Payment for the coffee
+              amtPaidMsat:
                 type: string
+                description: The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.
+                format: number
               invoice:
                 type: string
-              walletId:
+                description: The BOLT \#11 encoded invoice
+                example: lnbc500n1p3zv5vkpp5x0thcaz8wep54clc2xt5895azjdzmthyskzzh9yslggy74qtvl6sdpdg3hkuct5d9hkugrxdaezqjn0dphk2fmnypkk2mtsdahkccqzpgxqyz5vqsp5v80q4vq4pwakq2l0hcqgtelgajsymv4ud4jdcrqtnzhvet55qlus9qyyssquqh2wl2m866qs5n72c5vg6wmqx9vzwhs5ypualq4mcu76h2tdkcq3jtjwtggfff7xwtdqxlnwqk8cxpzryjghrmmq3syraswp9vjr7cqry9l96
+              paymentHash:
                 type: string
-              status:
-                $ref: '#/components/schemas/InvoiceStatus'
+                description: The payment hash of the invoice
+                example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175
+              valueMsat:
+                type: string
+                description: The value of the invoice in satoshis
+                example: '50000'
+                format: number
               expiresAt:
                 type: string
+                description: ISO-8601 string representing when the invoice will expire
+                example: '2022-04-01T18:46:24.677Z'
                 format: date-time
                 title: ISO Date String
+              status:
+                type: string
+                enum:
+                  - open
+                  - settled
+                  - canceled
+                description: The status of the invoice
+              walletId:
+                allOf:
+                  - $ref: '#/components/schemas/WalletIdString'
+                description: The wallet to which this invoice belongs
               createdAt:
                 type: string
+                description: ISO-8601 string representing when the invoice was created
+                example: '2022-04-01T18:46:24.677Z'
                 format: date-time
                 title: ISO Date String
               updatedAt:
                 type: string
+                description: ISO-8601 string representing when the invoice was updated
+                example: '2022-04-01T18:46:24.677Z'
                 format: date-time
                 title: ISO Date String
-              amtPaidMsat:
-                type: string
-                description: The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.
-                format: number
             required:
-              - valueMsat
-              - paymentHash
               - invoice
-              - walletId
-              - status
+              - paymentHash
+              - valueMsat
               - expiresAt
+              - status
+              - walletId
               - createdAt
               - updatedAt
         nextBatchPrevId:
@@ -45356,53 +45389,6 @@ components:
           required:
             - name
         - $ref: '#/components/schemas/InvalidId'
-    InvoiceInfo:
-      title: InvoiceInfo
-      type: object
-      properties:
-        valueMsat:
-          type: string
-          format: number
-        paymentHash:
-          type: string
-        invoice:
-          type: string
-        walletId:
-          type: string
-        status:
-          $ref: '#/components/schemas/InvoiceStatus'
-        expiresAt:
-          type: string
-          format: date-time
-          title: ISO Date String
-        createdAt:
-          type: string
-          format: date-time
-          title: ISO Date String
-        updatedAt:
-          type: string
-          format: date-time
-          title: ISO Date String
-        amtPaidMsat:
-          type: string
-          description: The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.
-          format: number
-      required:
-        - valueMsat
-        - paymentHash
-        - invoice
-        - walletId
-        - status
-        - expiresAt
-        - createdAt
-        - updatedAt
-    InvoiceStatus:
-      title: InvoiceStatus
-      type: string
-      enum:
-        - open
-        - settled
-        - canceled
     Ip:
       type: string
       format: ipv4
@@ -45977,6 +45963,10 @@ components:
           type: string
           description: A memo or description for the invoice
           example: Payment for the coffee
+        amtPaidMsat:
+          type: string
+          description: The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.
+          format: number
         invoice:
           type: string
           description: The BOLT \#11 encoded invoice
@@ -46007,13 +45997,27 @@ components:
           allOf:
             - $ref: '#/components/schemas/WalletIdString'
           description: The wallet to which this invoice belongs
+        createdAt:
+          type: string
+          description: ISO-8601 string representing when the invoice was created
+          example: '2022-04-01T18:46:24.677Z'
+          format: date-time
+          title: ISO Date String
+        updatedAt:
+          type: string
+          description: ISO-8601 string representing when the invoice was updated
+          example: '2022-04-01T18:46:24.677Z'
+          format: date-time
+          title: ISO Date String
       required:
         - invoice
         - paymentHash
         - valueMsat
         - expiresAt
         - status
         - walletId
+        - createdAt
+        - updatedAt
     LightningOnchainRequest:
       title: LightningOnchainRequest
       type: object
@@ -62055,15 +62059,53 @@ components:
         - hot
         - trading
         - distributedCustody
-    WalletUnspents:
+    WalletUnspentsResponse:
+      title: WalletUnspentsResponse
       type: object
       properties:
-        coin:
-          $ref: '#/components/schemas/Coin'
         unspents:
           type: array
           items:
-            $ref: '#/components/schemas/Unspent'
+            type: object
+            properties:
+              chain:
+                type: number
+                description: The chain of the UTXO
+              index:
+                type: number
+                description: The index of the UTXO
+              redeemScript:
+                type: string
+                description: The redeem script of the UTXO
+              witnessScript:
+                type: string
+                description: The witness script of the UTXO
+              id:
+                type: string
+                description: The ID of the UTXO
+              address:
+                type: string
+                description: The address of the UTXO
+              value:
+                type: number
+                description: The value of the UTXO
+              blockHeight:
+                type: number
+                description: The block this Unspent was created in
+              coinbase:
+                type: boolean
+                description: True if this unspent came from the coinbase transaction
+        nextBatchPrevId:
+          type: string
+          description: The ID from where the results can continue
+        coin:
+          $ref: '#/components/schemas/CoinString'
+        bumpFee:
+          type: string
+          description: fee bump
+          format: number
+      required:
+        - unspents
     WalletUpdateCoinSpecific:
       type: object
       properties: