migrate docs

.github/workflows/rdme-openapi.yml

@@ -0,0 +1,88 @@
+# This GitHub Actions workflow was auto-generated by the `rdme` cli on 2024-01-02T13:48:57.826Z
+# You can view our full documentation here: https://docs.readme.com/docs/rdme
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      # This workflow will run every time you push code to the following branch: `main`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - master
+
+jobs:
+  rdme-openapi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Blockchain Data
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/blockchain_data/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c716d716fe0040919d89
+
+      - name: Blockchain Node RPC
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/blockchain_node_rpc/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c794d329e30077a0638a
+
+      - name: Subscriptions
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/subscriptions/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c7b84eb96b0034e72a4e
+
+      - name: Fee Estimation
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/fee_estimation/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c807b4d77e006316ec5a
+
+      - name: Smart Contracts
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/smart_contracts/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c834f1cd450023eab1eb
+
+      - name: Security
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/security/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c8593a8063001c639eac
+
+      - name: Storage
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/storage/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c8703a8063001c639edd
+
+      - name: Virtual Accounts
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/virtual_accounts/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c89f01bfc0001709af9f
+
+      - name: Blockchain
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/blockchain/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c8c6ba99f1006df40d78
+
+      - name: Utils
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        uses: readmeio/rdme@v8
+        with:
+          rdme: openapi categories/utils/openapi.yml --key=${{ secrets.README_API_KEY }} --id=65c0c8ebe177ab0016cda347

.gitignore

@@ -0,0 +1 @@
+rpcOasOld.json

categories/blockchain/paths/v3_ada_account_{address}_get.yml

@@ -0,0 +1,66 @@
+description: '<p><b>
+
+  You can work with Cardano by <a href="https://apidoc.tatum.io/tag/Node-RPC#operation/NodeJsonPostRpcDriver"
+  target="_blank">connecting directly to a blockchain node provided by Tatum</a>.</b></p><br/>
+
+  <h4>2 credits per API call.</h4>
+
+  <p>Gets a Ada account by address.</p>
+
+  '
+operationId: AdaGetAccount
+parameters:
+- description: Address
+  in: path
+  name: address
+  required: true
+  schema:
+    type: string
+    example: Ae2tdPwUPEZMmrkRoduJW9w7wRvnTcdeMbw7yyyjwPqo6zuaeJaDEkHUJSz
+responses:
+  '200':
+    content:
+      application/json:
+        schema:
+          items:
+            $ref: '../../../components/migrated.yml#/components/schemas/AdaAccountBalance'
+          type: array
+    description: OK
+  '400':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error400'
+    description: Bad Request. Validation failed for the given object in the HTTP Body
+      or Request parameters.
+  '401':
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401NotActive'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401Invalid'
+    description: Unauthorized. Not valid or inactive subscription key present in the
+      HTTP Header.
+  '403':
+    description: Forbidden. The request is authenticated, but it is not possible to
+      perform the required operation due to a logical error or invalid permissions.
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403BtcBlockchain'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403Broadcast'
+  '500':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error500'
+    description: Internal server error. There was an error on the server while processing
+      the request.
+security:
+- X-API-Key: []
+x-codeSamples: []
+summary: Gets a Ada account by address
+tags:
+- Cardano

categories/blockchain/paths/v3_ada_address_{xpub}_{index}_get.yml

@@ -0,0 +1,80 @@
+description: '<p><b>
+
+  You can work with Cardano by <a href="https://apidoc.tatum.io/tag/Node-RPC#operation/NodeJsonPostRpcDriver"
+  target="_blank">connecting directly to a blockchain node provided by Tatum</a>.</b></p><br/>
+
+  <h4>1 credit per API call.</h4>
+
+  <p>Generates a Ada deposit address from an Extended public key. The deposit address
+  is generated for the specific index - each extended public key can generate
+
+  up to 2^31 addresses starting from index 0 until 2^31 - 1.</p>
+
+  '
+operationId: AdaGenerateAddress
+parameters:
+- description: Extended public key of a wallet.
+  in: path
+  name: xpub
+  required: true
+  example: 30e96a57be6235c686da968c1860f69d1871a692b29626b7ebb923aff8c6731cb9fef3a26b7eba8a07653483d06427d0c07966c5f81c69a7925d714530bedb1ef9e9103547b54ad0954b3569785ca70e1fd08313f92a3a9d31efa216b2b9adac4678455e66c97b53cd589f9da70a14265cf15cd4c1e0ce914407008f4a65f316
+  schema:
+    type: string
+- description: Derivation index of the desired address to be generated.
+  in: path
+  name: index
+  required: true
+  example: 0
+  schema:
+    type: number
+    minimum: 0
+responses:
+  '200':
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            address:
+              type: string
+              description: Ada address
+              example: addr1qyyxyhaa2e7kxeqcc72w7f747zqlgwwwstlzsg9umuxc40wnhawldxl4nan95rhtlcnju9q2r8j9qz8vslwsmrkj5r4spxhep9
+    description: OK
+  '400':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error400'
+    description: Bad Request. Validation failed for the given object in the HTTP Body
+      or Request parameters.
+  '401':
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401NotActive'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401Invalid'
+    description: Unauthorized. Not valid or inactive subscription key present in the
+      HTTP Header.
+  '403':
+    description: Forbidden. The request is authenticated, but it is not possible to
+      perform the required operation due to a logical error or invalid permissions.
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403AccountIncompatibleXpubBtc'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403AccountAddressGeneral'
+  '500':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error500'
+    description: Internal server error. There was an error on the server while processing
+      the request.
+security:
+- X-API-Key: []
+x-codeSamples: []
+summary: Generate Ada deposit address from Extended public key
+tags:
+- Cardano

categories/blockchain/paths/v3_ada_block_{hash}_get.yml

@@ -0,0 +1,54 @@
+description: <p><b>You can work with Cardano by <a href="https://apidoc.tatum.io/tag/Node-RPC#operation/NodeJsonPostRpcDriver"
+  target="_blank">connecting directly to a blockchain node provided by Tatum</a>.</b></p><br/><h4>1
+  credit per API call.</h4><p>Gets Ada block detail by block hash or height.</p>
+operationId: AdaGetBlock
+parameters:
+- description: Block hash or height.
+  in: path
+  name: hash
+  required: true
+  schema:
+    type: string
+    example: 00000000ca231a439a5c0a86a5a5dd6dc1918a8e897b96522fa9499288e70183
+responses:
+  '200':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/AdaBlock'
+    description: OK
+  '400':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error400'
+    description: Bad Request. Validation failed for the given object in the HTTP Body
+      or Request parameters.
+  '401':
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401NotActive'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401Invalid'
+    description: Unauthorized. Not valid or inactive subscription key present in the
+      HTTP Header.
+  '404':
+    description: Block not found.
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error404BlockNotExists'
+  '500':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error500'
+    description: Internal server error. There was an error on the server while processing
+      the request.
+security:
+- X-API-Key: []
+x-codeSamples: []
+summary: Get Block by hash or height
+tags:
+- Cardano

categories/blockchain/paths/v3_ada_broadcast_post.yml

@@ -0,0 +1,66 @@
+description: '<p><b>
+
+  You can work with Cardano by <a href="https://apidoc.tatum.io/tag/Node-RPC#operation/NodeJsonPostRpcDriver"
+  target="_blank">connecting directly to a blockchain node provided by Tatum</a>.</b></p><br/>
+
+  <h4>2 credits per API call.</h4>
+
+  <p>Broadcasts a signed transaction to the Ada blockchain. This method is used internally
+  from Tatum KMS or Tatum Client Libraries.
+
+  It is possible to create a custom signing mechanism and only use this method for
+  broadcasting data to the blockchain.</p>
+
+  '
+operationId: AdaBroadcast
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: '../../../components/migrated.yml#/components/schemas/BroadcastKMS'
+  required: true
+responses:
+  '200':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/TransactionHash'
+    description: OK
+  '400':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error400'
+    description: Bad Request. Validation failed for the given object in the HTTP Body
+      or Request parameters.
+  '401':
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401NotActive'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error401Invalid'
+    description: Unauthorized. Not valid or inactive subscription key present in the
+      HTTP Header.
+  '403':
+    description: Forbidden. The request is authenticated, but it is not possible to
+      perform the required operation due to a logical error or invalid permissions.
+    content:
+      application/json:
+        schema:
+          oneOf:
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403BtcBlockchain'
+          - $ref: '../../../components/migrated.yml#/components/schemas/Error403Broadcast'
+  '500':
+    content:
+      application/json:
+        schema:
+          $ref: '../../../components/migrated.yml#/components/schemas/Error500'
+    description: Internal server error. There was an error on the server while processing
+      the request.
+security:
+- X-API-Key: []
+x-codeSamples: []
+summary: Broadcast signed Ada transaction
+tags:
+- Cardano