add missing authorization

tatumio · Feb 6, 2024 · 459e1d0 · 459e1d0
1 parent 7ced60b
commit 459e1d0
Show file tree

Hide file tree

Showing 10 changed files with 683 additions and 602 deletions.
diff --git a/categories/blockchain/openapi.yml b/categories/blockchain/openapi.yml
diff --git a/categories/blockchain_data/openapi.yml b/categories/blockchain_data/openapi.yml
@@ -78,6 +78,9 @@ paths:
   /v3/data/utxos:
     get:
       $ref: categories/blockchain_data/paths/v3_data_utxos_get.yml
-
 servers:
   - url: https://api.tatum.io/
+components:
+  securitySchemes:
+    X-API-Key:
+      $ref: components/schemas.yml#/components/securitySchemes/X-API-Key
diff --git a/categories/blockchain_node_rpc/openapi.yml b/categories/blockchain_node_rpc/openapi.yml
@@ -3,16 +3,17 @@ info:
   title: Blockchain Node RPC
   version: 3.18.3
 tags:
-- description: '<p>Interact with the blockchain directly by connecting to the blockchain
-    node and communicating with it through JSON-RPC.</p>
+  - description:
+      "<p>Interact with the blockchain directly by connecting to the blockchain
+      node and communicating with it through JSON-RPC.</p>
 
-    <p>Each node-related API supports its own set of the blockchains. The list of
-    the supported blockchains is provided in the API description further in this section.</p>
+      <p>Each node-related API supports its own set of the blockchains. The list of
+      the supported blockchains is provided in the API description further in this section.</p>
 
-    '
-  name: Node RPC
+      "
+    name: Node RPC
 servers:
-- url: https://api.tatum.io
+  - url: https://api.tatum.io
 paths:
   /v3/blockchain/node/{chain}/{xApiKey}/{rpcPath}:
     post:
@@ -21,3 +22,7 @@ paths:
       $ref: categories/blockchain_node_rpc/paths/v3_blockchain_node_{chain}_{xApiKey}_{rpcPath}_put.yml
     get:
       $ref: categories/blockchain_node_rpc/paths/v3_blockchain_node_{chain}_{xApiKey}_{rpcPath}_get.yml
+components:
+  securitySchemes:
+    X-API-Key:
+      $ref: components/schemas.yml#/components/securitySchemes/X-API-Key
diff --git a/categories/fee_estimation/openapi.yml b/categories/fee_estimation/openapi.yml
@@ -4,7 +4,7 @@ info:
   version: 3.18.3
 tags: []
 servers:
-- url: https://api.tatum.io
+  - url: https://api.tatum.io
 paths:
   /v3/blockchain/fee/{chain}:
     get:
@@ -48,3 +48,7 @@ paths:
   /v3/offchain/blockchain/estimate:
     post:
       $ref: categories/fee_estimation/paths/v3_offchain_blockchain_estimate_post.yml
+components:
+  securitySchemes:
+    X-API-Key:
+      $ref: components/schemas.yml#/components/securitySchemes/X-API-Key
diff --git a/categories/security/openapi.yml b/categories/security/openapi.yml
@@ -3,84 +3,87 @@ info:
   title: Security
   version: 3.18.3
 tags:
-- description: '<p><a href="https://github.com/tatumio/tatum-kms" target="_blank">Key
-    Management System</a> (KMS) is a comprehensive solution for building custodial
-    applications. KMS runs locally on your server and provides security for generating
-    wallets, addresses, and private keys, and for signing transactions.</p>
+  - description:
+      '<p><a href="https://github.com/tatumio/tatum-kms" target="_blank">Key
+      Management System</a> (KMS) is a comprehensive solution for building custodial
+      applications. KMS runs locally on your server and provides security for generating
+      wallets, addresses, and private keys, and for signing transactions.</p>
 
-    <p>KMS builds a list of pending transaction to sign and provides the options to
-    complete a transaction after it has been signed and to obtain transaction details
-    with the result of the blockchain operation via the transaction ID.</p>
+      <p>KMS builds a list of pending transaction to sign and provides the options to
+      complete a transaction after it has been signed and to obtain transaction details
+      with the result of the blockchain operation via the transaction ID.</p>
 
-    <p>In KMS, each managed wallet or private key is assigned a unique signature ID
-    (<code>signatureId</code>) that represents that wallet or private key. This signature
-    ID is then used in an API request to identify the wallet.</p>
+      <p>In KMS, each managed wallet or private key is assigned a unique signature ID
+      (<code>signatureId</code>) that represents that wallet or private key. This signature
+      ID is then used in an API request to identify the wallet.</p>
 
-    <p>Depending on the API, you can use the signature ID in an API call request in
-    the following ways:</p>
+      <p>Depending on the API, you can use the signature ID in an API call request in
+      the following ways:</p>
 
-    <ul>
+      <ul>
 
-    <li>
+      <li>
 
-    To represent the <b>mnemonic</b> type of the wallet; for example, in the <a href="https://apidoc.tatum.io/tag/Blockchain-operations#operation/BtcTransfer"
-    target="_blank">API for sending BTC from a virtual account to the blockchain</a>
-    (see the <code>transferBtcKMS</code> request schema).</li>
+      To represent the <b>mnemonic</b> type of the wallet; for example, in the <a href="https://apidoc.tatum.io/tag/Blockchain-operations#operation/BtcTransfer"
+      target="_blank">API for sending BTC from a virtual account to the blockchain</a>
+      (see the <code>transferBtcKMS</code> request schema).</li>
 
-    <li>To represent the <b>privateKey</b> type of the wallet; for example, in the
-    <a href="https://apidoc.tatum.io/tag/Bitcoin#operation/BtcTransferBlockchain"
-    target="_blank">API for sending BTC to a blockchain address</a> (see the <code>BtcTransactionFromUTXOKMS</code>
-    request schema).</li>
+      <li>To represent the <b>privateKey</b> type of the wallet; for example, in the
+      <a href="https://apidoc.tatum.io/tag/Bitcoin#operation/BtcTransferBlockchain"
+      target="_blank">API for sending BTC to a blockchain address</a> (see the <code>BtcTransactionFromUTXOKMS</code>
+      request schema).</li>
 
-    <li>To represent the <b>mnemonic</b> and <b>index</b> type of the wallet; for
-    example, in the <a href="https://apidoc.tatum.io/tag/Blockchain-operations#operation/EthTransfer"
-    target="_blank">API for sending ETH from a virtual account to the blockchain</a>
-    (see the <code>transferEthKMS</code> request schema).<br />In this case, the index
-    of the specific private key generated from the mnemonic must be used in addition
-    to the signature ID.</li>
+      <li>To represent the <b>mnemonic</b> and <b>index</b> type of the wallet; for
+      example, in the <a href="https://apidoc.tatum.io/tag/Blockchain-operations#operation/EthTransfer"
+      target="_blank">API for sending ETH from a virtual account to the blockchain</a>
+      (see the <code>transferEthKMS</code> request schema).<br />In this case, the index
+      of the specific private key generated from the mnemonic must be used in addition
+      to the signature ID.</li>
 
-    </ul>
+      </ul>
 
-    <p>You can run KMS on the following operating systems:</p>
+      <p>You can run KMS on the following operating systems:</p>
 
-    <ul>
+      <ul>
 
-    <li><b>macOS:</b> Natively or via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
-    target="_blank">Docker</a></li>
+      <li><b>macOS:</b> Natively or via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
+      target="_blank">Docker</a></li>
 
-    <li><b>Unix:</b> Natively or via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
-    target="_blank">Docker</a></li>
+      <li><b>Unix:</b> Natively or via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
+      target="_blank">Docker</a></li>
 
-    <li><b>MS Windows:</b> Only via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
-    target="_blank">Docker</a></li>
+      <li><b>MS Windows:</b> Only via <a href="https://hub.docker.com/repository/docker/tatumio/tatum-kms"
+      target="_blank">Docker</a></li>
 
-    </ul>
+      </ul>
 
-    <p>For more information about KMS, see the <a href="https://github.com/tatumio/tatum-kms"
-    target="_blank">KMS GitHub repository</a> and the <a href="https://docs.tatum.io/private-key-management/private-key-management"
-    target="_blank">user documentation</a>.</p>
+      <p>For more information about KMS, see the <a href="https://github.com/tatumio/tatum-kms"
+      target="_blank">KMS GitHub repository</a> and the <a href="https://docs.tatum.io/private-key-management/private-key-management"
+      target="_blank">user documentation</a>.</p>
 
-    </ul></p>
+      </ul></p>
 
-    '
-  name: Key Management System
-- description: '<p>An endpoint to check if the blockchain address is safe to work
-    with or not.</p>
+      '
+    name: Key Management System
+  - description:
+      "<p>An endpoint to check if the blockchain address is safe to work
+      with or not.</p>
 
-    '
-  name: Malicious address
-- description: '<p>Custodial API is a set of operations, which allows you to work
-    with managed blockchain addresses without having its private key.
+      "
+    name: Malicious address
+  - description:
+      "<p>Custodial API is a set of operations, which allows you to work
+      with managed blockchain addresses without having its private key.
 
-    You can easily create new managed address and export its details - with private
-    key as well - once required.<br/>
+      You can easily create new managed address and export its details - with private
+      key as well - once required.<br/>
 
-    This features are currently in <b>Alpha version</b>.</p>
+      This features are currently in <b>Alpha version</b>.</p>
 
-    '
-  name: Custodial managed wallets
+      "
+    name: Custodial managed wallets
 servers:
-- url: https://api.tatum.io
+  - url: https://api.tatum.io
 paths:
   /v3/kms/pending/{chain}:
     get:
@@ -111,3 +114,7 @@ paths:
   /v3/custodial/transaction:
     post:
       $ref: categories/security/paths/v3_custodial_transaction_post.yml
+components:
+  securitySchemes:
+    X-API-Key:
+      $ref: components/schemas.yml#/components/securitySchemes/X-API-Key