Merge pull request #1 from tatumio/feature/ALL-6521-docs-payload-title

ALL-6521: added title to all schemas
tatumio · Apr 26, 2024 · e392081 · e392081
2 parents 7749666 + 2b24584
commit e392081
Show file tree

Hide file tree

Showing 1,129 changed files with 1,129 additions and 0 deletions.
diff --git a/components/schemas/Account.yml b/components/schemas/Account.yml
@@ -1,3 +1,4 @@
+title: Account
 properties:
   id:
     description: The ID of the virtual account

diff --git a/components/schemas/AccountBalance.yml b/components/schemas/AccountBalance.yml
@@ -1,3 +1,4 @@
+title: AccountBalance
 properties:
   accountBalance:
     description: All assets on the account, both available and blocked

diff --git a/components/schemas/AccountSettingsXrpBlockchain.yml b/components/schemas/AccountSettingsXrpBlockchain.yml
@@ -1,3 +1,4 @@
+title: AccountSettingsXrpBlockchain
 type: object
 properties:
   fromAccount:

diff --git a/components/schemas/AccountSettingsXrpBlockchainKMS.yml b/components/schemas/AccountSettingsXrpBlockchainKMS.yml
@@ -1,3 +1,4 @@
+title: AccountSettingsXrpBlockchainKMS
 type: object
 properties:
   fromAccount:

diff --git a/components/schemas/ActivateGasPump.yml b/components/schemas/ActivateGasPump.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPump
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpCelo.yml b/components/schemas/ActivateGasPumpCelo.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpCelo
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpCeloKMS.yml b/components/schemas/ActivateGasPumpCeloKMS.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpCeloKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpKMS.yml b/components/schemas/ActivateGasPumpKMS.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpTatum.yml b/components/schemas/ActivateGasPumpTatum.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpTatum
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpTron.yml b/components/schemas/ActivateGasPumpTron.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpTron
 type: object
 properties:
   chain:

diff --git a/components/schemas/ActivateGasPumpTronKMS.yml b/components/schemas/ActivateGasPumpTronKMS.yml
@@ -1,3 +1,4 @@
+title: ActivateGasPumpTronKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/Activated.yml b/components/schemas/Activated.yml
@@ -1,3 +1,4 @@
+title: Activated
 type: object
 properties:
   activated:

diff --git a/components/schemas/AdaAccountBalance.yml b/components/schemas/AdaAccountBalance.yml
@@ -1,3 +1,4 @@
+title: AdaAccountBalance
 type: array
 items:
   type: object

diff --git a/components/schemas/AdaBlock.yml b/components/schemas/AdaBlock.yml
@@ -1,3 +1,4 @@
+title: AdaBlock
 type: object
 properties:
   hash:

diff --git a/components/schemas/AdaInfo.yml b/components/schemas/AdaInfo.yml
@@ -1,3 +1,4 @@
+title: AdaInfo
 type: object
 properties:
   testnet:

diff --git a/components/schemas/AdaTransaction.yml b/components/schemas/AdaTransaction.yml
@@ -1,3 +1,4 @@
+title: AdaTransaction
 type: object
 required:
   - to

diff --git a/components/schemas/AdaTransactionFromAddress.yml b/components/schemas/AdaTransactionFromAddress.yml
@@ -1,3 +1,4 @@
+title: AdaTransactionFromAddress
 type: object
 required:
   - to

diff --git a/components/schemas/AdaTransactionFromAddressKMS.yml b/components/schemas/AdaTransactionFromAddressKMS.yml
@@ -1,3 +1,4 @@
+title: AdaTransactionFromAddressKMS
 type: object
 required:
   - to

diff --git a/components/schemas/AdaTransactionFromUTXO.yml b/components/schemas/AdaTransactionFromUTXO.yml
@@ -1,3 +1,4 @@
+title: AdaTransactionFromUTXO
 type: object
 required:
   - to

diff --git a/components/schemas/AdaTransactionFromUTXOKMS.yml b/components/schemas/AdaTransactionFromUTXOKMS.yml
@@ -1,3 +1,4 @@
+title: AdaTransactionFromUTXOKMS
 type: object
 required:
   - to

diff --git a/components/schemas/AdaTx.yml b/components/schemas/AdaTx.yml
@@ -1,3 +1,4 @@
+title: AdaTx
 type: object
 properties:
   hash:

diff --git a/components/schemas/AdaUTXO.yml b/components/schemas/AdaUTXO.yml
@@ -1,3 +1,4 @@
+title: AdaUTXO
 type: object
 properties:
   value:

diff --git a/components/schemas/AddMultiTokenMinter.yml b/components/schemas/AddMultiTokenMinter.yml
@@ -1,3 +1,4 @@
+title: AddMultiTokenMinter
 type: object
 properties:
   chain:

diff --git a/components/schemas/AddMultiTokenMinterKMS.yml b/components/schemas/AddMultiTokenMinterKMS.yml
@@ -1,3 +1,4 @@
+title: AddMultiTokenMinterKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/AddNftMinter.yml b/components/schemas/AddNftMinter.yml
@@ -1,3 +1,4 @@
+title: AddNftMinter
 type: object
 properties:
   chain:

diff --git a/components/schemas/AddNftMinterKMS.yml b/components/schemas/AddNftMinterKMS.yml
@@ -1,3 +1,4 @@
+title: AddNftMinterKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/Address.yml b/components/schemas/Address.yml
@@ -1,3 +1,4 @@
+title: Address
 required:
   - address
   - currency

diff --git a/components/schemas/AlgoBlock.yml b/components/schemas/AlgoBlock.yml
@@ -1,3 +1,4 @@
+title: AlgoBlock
 type: object
 properties:
   genesisHash:

diff --git a/components/schemas/AlgoTransactionHashKMS.yml b/components/schemas/AlgoTransactionHashKMS.yml
@@ -1,3 +1,4 @@
+title: AlgoTransactionHashKMS
 type: object
 properties:
   txId:

diff --git a/components/schemas/AlgoTx.yml b/components/schemas/AlgoTx.yml
@@ -1,3 +1,4 @@
+title: AlgoTx
 type: object
 properties:
   closeRewards:

diff --git a/components/schemas/AlgoTxsWithPagination.yml b/components/schemas/AlgoTxsWithPagination.yml
@@ -1,3 +1,4 @@
+title: AlgoTxsWithPagination
 type: object
 properties:
   nextToken:

diff --git a/components/schemas/AlgoWallet.yml b/components/schemas/AlgoWallet.yml
@@ -1,3 +1,4 @@
+title: AlgoWallet
 type: object
 properties:
   address:

diff --git a/components/schemas/AlgorandMintedResult.yml b/components/schemas/AlgorandMintedResult.yml
@@ -1,3 +1,4 @@
+title: AlgorandMintedResult
 type: object
 properties:
   txId:

diff --git a/components/schemas/ApproveCeloErc20.yml b/components/schemas/ApproveCeloErc20.yml
@@ -1,3 +1,4 @@
+title: ApproveCeloErc20
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveCeloErc20KMS.yml b/components/schemas/ApproveCeloErc20KMS.yml
@@ -1,3 +1,4 @@
+title: ApproveCeloErc20KMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveErc20.yml b/components/schemas/ApproveErc20.yml
@@ -1,3 +1,4 @@
+title: ApproveErc20
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveErc20KMS.yml b/components/schemas/ApproveErc20KMS.yml
@@ -1,3 +1,4 @@
+title: ApproveErc20KMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveNftSpending.yml b/components/schemas/ApproveNftSpending.yml
@@ -1,3 +1,4 @@
+title: ApproveNftSpending
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveNftSpendingCelo.yml b/components/schemas/ApproveNftSpendingCelo.yml
@@ -1,3 +1,4 @@
+title: ApproveNftSpendingCelo
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveNftSpendingCeloKMS.yml b/components/schemas/ApproveNftSpendingCeloKMS.yml
@@ -1,3 +1,4 @@
+title: ApproveNftSpendingCeloKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveNftSpendingKMS.yml b/components/schemas/ApproveNftSpendingKMS.yml
@@ -1,3 +1,4 @@
+title: ApproveNftSpendingKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveTransferCustodialWallet.yml b/components/schemas/ApproveTransferCustodialWallet.yml
@@ -1,3 +1,4 @@
+title: ApproveTransferCustodialWallet
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveTransferCustodialWalletCelo.yml b/components/schemas/ApproveTransferCustodialWalletCelo.yml
@@ -1,3 +1,4 @@
+title: ApproveTransferCustodialWalletCelo
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveTransferCustodialWalletCeloKMS.yml b/components/schemas/ApproveTransferCustodialWalletCeloKMS.yml
@@ -1,3 +1,4 @@
+title: ApproveTransferCustodialWalletCeloKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/ApproveTransferCustodialWalletKMS.yml b/components/schemas/ApproveTransferCustodialWalletKMS.yml
@@ -1,3 +1,4 @@
+title: ApproveTransferCustodialWalletKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/BalanceItem.yml b/components/schemas/BalanceItem.yml
@@ -1,3 +1,4 @@
+title: BalanceItem
 oneOf:
   - $ref: "../migrated_v1.yml#/components/schemas/NativeTokenBalance"
   - $ref: "../migrated_v1.yml#/components/schemas/NftBalance"

diff --git a/components/schemas/BaseBalance.yml b/components/schemas/BaseBalance.yml
@@ -1,3 +1,4 @@
+title: BaseBalance
 type: object
 properties:
   balance:

diff --git a/components/schemas/BaseBlock.yml b/components/schemas/BaseBlock.yml
@@ -1,3 +1,4 @@
+title: BaseBlock
 type: object
 properties:
   difficulty:

diff --git a/components/schemas/BaseEstimateGas.yml b/components/schemas/BaseEstimateGas.yml
@@ -1,3 +1,4 @@
+title: BaseEstimateGas
 type: object
 properties:
   from:

diff --git a/components/schemas/BaseTx.yml b/components/schemas/BaseTx.yml
@@ -1,3 +1,4 @@
+title: BaseTx
 type: object
 properties:
   blockHash:

diff --git a/components/schemas/BatchCreateTransaction.yml b/components/schemas/BatchCreateTransaction.yml
@@ -1,3 +1,4 @@
+title: BatchCreateTransaction
 properties:
   senderAccountId:
     description: Internal sender account ID within Tatum platform

diff --git a/components/schemas/BatchTransactionResult.yml b/components/schemas/BatchTransactionResult.yml
@@ -1,3 +1,4 @@
+title: BatchTransactionResult
 type: array
 items:
   description:

diff --git a/components/schemas/BchBlock.yml b/components/schemas/BchBlock.yml
@@ -1,3 +1,4 @@
+title: BchBlock
 type: object
 properties:
   hash:

diff --git a/components/schemas/BchInfo.yml b/components/schemas/BchInfo.yml
@@ -1,3 +1,4 @@
+title: BchInfo
 type: object
 properties:
   chain:

diff --git a/components/schemas/BchTransaction.yml b/components/schemas/BchTransaction.yml
@@ -1,3 +1,4 @@
+title: BchTransaction
 type: object
 required:
   - to

diff --git a/components/schemas/BchTransactionKMS.yml b/components/schemas/BchTransactionKMS.yml
@@ -1,3 +1,4 @@
+title: BchTransactionKMS
 type: object
 required:
   - to

diff --git a/components/schemas/BchTx.yml b/components/schemas/BchTx.yml
@@ -1,3 +1,4 @@
+title: BchTx
 type: object
 properties:
   txid:

diff --git a/components/schemas/BidOnAuction.yml b/components/schemas/BidOnAuction.yml
@@ -1,3 +1,4 @@
+title: BidOnAuction
 type: object
 properties:
   chain:

diff --git a/components/schemas/BidOnAuctionCelo.yml b/components/schemas/BidOnAuctionCelo.yml
@@ -1,3 +1,4 @@
+title: BidOnAuctionCelo
 type: object
 properties:
   chain:

diff --git a/components/schemas/BidOnAuctionCeloKMS.yml b/components/schemas/BidOnAuctionCeloKMS.yml
@@ -1,3 +1,4 @@
+title: BidOnAuctionCeloKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/BidOnAuctionKMS.yml b/components/schemas/BidOnAuctionKMS.yml
@@ -1,3 +1,4 @@
+title: BidOnAuctionKMS
 type: object
 properties:
   chain:

diff --git a/components/schemas/BlockAmount.yml b/components/schemas/BlockAmount.yml
@@ -1,3 +1,4 @@
+title: BlockAmount
 properties:
   amount:
     description: The amount to be blocked on the account

diff --git a/components/schemas/BlockItem.yml b/components/schemas/BlockItem.yml
@@ -1,3 +1,4 @@
+title: BlockItem
 type: object
 properties:
   blockNumber:

diff --git a/components/schemas/BlockNumber.yml b/components/schemas/BlockNumber.yml
@@ -1,3 +1,4 @@
+title: BlockNumber
 type: number
 example: 16499510
 minimum: 0
diff --git a/components/schemas/BlockNumberTo.yml b/components/schemas/BlockNumberTo.yml
@@ -1,3 +1,4 @@
+title: BlockNumberTo
 type: number
 example: 16779230
 minimum: 0
diff --git a/components/schemas/Blockage.yml b/components/schemas/Blockage.yml
@@ -1,3 +1,4 @@
+title: Blockage
 properties:
   id:
     description: The ID of the blockage

diff --git a/components/schemas/BlockchainFee.yml b/components/schemas/BlockchainFee.yml
@@ -1,3 +1,4 @@
+title: BlockchainFee
 description: Recommended fees to perform blockchain transaction
 properties:
   fast:

diff --git a/components/schemas/BnbAccount.yml b/components/schemas/BnbAccount.yml
@@ -1,3 +1,4 @@
+title: BnbAccount
 type: object
 properties:
   account_number:

diff --git a/components/schemas/BnbBlock.yml b/components/schemas/BnbBlock.yml
@@ -1,3 +1,4 @@
+title: BnbBlock
 type: object
 properties:
   timestamp:

diff --git a/components/schemas/BnbTransaction.yml b/components/schemas/BnbTransaction.yml
@@ -1,3 +1,4 @@
+title: BnbTransaction
 type: object
 properties:
   txHash:

diff --git a/components/schemas/BnbTx.yml b/components/schemas/BnbTx.yml
@@ -1,3 +1,4 @@
+title: BnbTx
 type: object
 properties:
   code:

diff --git a/components/schemas/BnbTxInAccount.yml b/components/schemas/BnbTxInAccount.yml
@@ -1,3 +1,4 @@
+title: BnbTxInAccount
 type: object
 properties:
   total:

diff --git a/components/schemas/BnbWallet.yml b/components/schemas/BnbWallet.yml
@@ -1,3 +1,4 @@
+title: BnbWallet
 type: object
 properties:
   address:

diff --git a/components/schemas/Broadcast.yml b/components/schemas/Broadcast.yml
@@ -1,3 +1,4 @@
+title: Broadcast
 properties:
   txData:
     description: Raw signed transaction to be published to network.

diff --git a/components/schemas/BroadcastKMS.yml b/components/schemas/BroadcastKMS.yml
@@ -1,3 +1,4 @@
+title: BroadcastKMS
 properties:
   txData:
     description: Raw signed transaction to be published to network.

diff --git a/components/schemas/BroadcastResponse.yml b/components/schemas/BroadcastResponse.yml
@@ -1,3 +1,4 @@
+title: BroadcastResponse
 properties:
   completed:
     description: Flag, if withdrawal is successfully completed within Tatum systems.

diff --git a/components/schemas/BroadcastWithdrawal.yml b/components/schemas/BroadcastWithdrawal.yml
@@ -1,3 +1,4 @@
+title: BroadcastWithdrawal
 properties:
   currency:
     description:

diff --git a/components/schemas/BscBalance.yml b/components/schemas/BscBalance.yml
@@ -1,3 +1,4 @@
+title: BscBalance
 type: object
 properties:
   balance:

diff --git a/components/schemas/BscBlock.yml b/components/schemas/BscBlock.yml
@@ -1,3 +1,4 @@
+title: BscBlock
 type: object
 properties:
   difficulty:

diff --git a/components/schemas/BscEstimateGas.yml b/components/schemas/BscEstimateGas.yml
@@ -1,3 +1,4 @@
+title: BscEstimateGas
 type: object
 properties:
   from: