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

Update API reference on BitGo Developer Portal

Author: ericcrosson-bitgo

api.yaml

@@ -44291,24 +44291,39 @@ components:
               rewardBalanceString:
                 type: string
                 description: The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the `includeStakingBalances` query parameter is set to `true`.
-              inboundBalance:
-                type: string
-                description: Inbound balance in millisatoshis (remote balance)
-              inboundPendingBalance:
-                type: string
-                description: Pending inbound balance in millisatoshis (pending open remote balance)
-              inboundUnsettledBalance:
-                type: string
-                description: Unsettled inbound balance in millisatoshis (unsettled remote balance)
-              outboundBalance:
-                type: string
-                description: Outbound balance in millisatoshis (local balance)
-              outboundPendingBalance:
-                type: string
-                description: Pending outbound balance in millisatoshis (pending open local balance)
-              outboundUnsettledBalance:
-                type: string
-                description: Unsettled outbound balance in millisatoshis (unsettled local balance)
+              offchain:
+                type: object
+                description: Lightning Balances
+                properties:
+                  inboundBalance:
+                    type: string
+                    description: Inbound balance in millisatoshis (remote balance)
+                  inboundPendingBalance:
+                    type: string
+                    description: Pending inbound balance in millisatoshis (pending open remote balance)
+                  inboundUnsettledBalance:
+                    type: string
+                    description: Unsettled inbound balance in millisatoshis (unsettled remote balance)
+                  outboundBalance:
+                    type: string
+                    description: Outbound balance in millisatoshis (local balance)
+                  outboundPendingBalance:
+                    type: string
+                    description: Pending outbound balance in millisatoshis (pending open local balance)
+                  outboundUnsettledBalance:
+                    type: string
+                    description: Unsettled outbound balance in millisatoshis (unsettled local balance)
+                  outboundLockedBalance:
+                    type: string
+                    description: Locked (from pending force closed channels) outbound balance in millisatoshis (locked local balance)
+                required:
+                  - inboundBalance
+                  - inboundPendingBalance
+                  - inboundUnsettledBalance
+                  - outboundBalance
+                  - outboundPendingBalance
+                  - outboundUnsettledBalance
+                  - outboundLockedBalance
             required:
               - coin
               - balanceString
@@ -47144,9 +47159,7 @@ components:
       title: MutabilityConstraint
       type: string
       enum:
-        - unlocked
         - permanent
-        - sticky
         - managed
     MutabilityConstraint1:
       type: string