updated docs

paritytech · Apr 3, 2024 · 294f9a1 · 294f9a1
1 parent 53a2a0d
commit 294f9a1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 71 deletions.
diff --git a/docs/dist/app.bundle.js b/docs/dist/app.bundle.js
diff --git a/docs/src/openapi-v1.yaml b/docs/src/openapi-v1.yaml
@@ -1153,57 +1153,24 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-  /transaction/material/v14:
+  /transaction/material/{metadataVersion}:
     get:
       tags:
       - transaction
       summary: Get all the network information needed to construct a transaction offline and
-        the v14 of metadata.
+        the version of metadata specified in `metadataVersion`.
       description: Returns the material that is universal to constructing any
         signed transaction offline and the v14 of metadata. Replaces `/tx/artifacts`
         from versions < v1.0.0.
-      operationId: getTransactionMaterial
+      operationId: getTransactionMaterialwithVersionedMetadata
       parameters:
-      - name: at
-        in: query
-        description: Block at which to retrieve the transaction construction
-          material.
-        required: false
-        schema:
-          type: string
-          description: Block identifier, as the block height or block hash.
-          format: unsignedInteger or $hex
-      - name: metadata
-        in: query
-        description: Specifies the format of the metadata to be returned. Accepted values are
-          'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata.
-          When `metadata` is not inputted, the `metadata` field will be absent.
+      - name: metadataVersion
+        in: path
+        description: The version of metadata. The input is expected in a `vX` format, where `X`
+          represents the version number (e.g. `v14`, `v15`).
+        required: true
         schema:
           type: string
-      responses:
-        "200":
-          description: successful operation
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/TransactionMaterial'
-        "400":
-          description: invalid blockId supplied for at query param
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-  /transaction/material/v15:
-    get:
-      tags:
-      - transaction
-      summary: Get all the network information needed to construct a transaction offline and
-        the v15 of metadata.
-      description: Returns the material that is universal to constructing any
-        signed transaction offline and the v15 of metadata. Replaces `/tx/artifacts`
-        from versions < v1.0.0.
-      operationId: getTransactionMaterial
-      parameters:
       - name: at
         in: query
         description: Block at which to retrieve the transaction construction
@@ -1217,7 +1184,6 @@ paths:
         in: query
         description: Specifies the format of the metadata to be returned. Accepted values are
           'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata.
-          When `metadata` is not inputted, the `metadata` field will be absent.
         schema:
           type: string
       responses:
@@ -1833,44 +1799,24 @@ paths:
               schema:
                 type: object
                 description: Response is dependent on the runtime metadata contents.
-  /runtime/metadata/v14:
+  /runtime/metadata/{metadataVersion}:
     get:
       tags:
       - runtime
-      summary: Get the version 14 of runtime metadata in decoded, JSON form.
+      summary: Get the requested version of runtime metadata in decoded, JSON form.
       description: >-
-       Returns the version 14 of runtime metadata as a JSON object.
+       Returns the requested version of runtime metadata as a JSON object.
        Substrate Reference:
        - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html
        - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
       parameters:
-      - name: at
-        in: query
-        description: Block at which to retrieve the metadata at.
-        required: false
+      - name: metadataVersion
+        in: path
+        description: The version of metadata. The input is expected in a `vX` format, where `X`
+          represents the version number (e.g. `v14`, `v15`).
+        required: true
         schema:
           type: string
-          description: Block identifier, as the block height or block hash.
-          format: unsignedInteger or $hex
-      responses:
-        "200":
-          description: successful operation
-          content:
-            application/json:
-              schema:
-                type: object
-                description: Response is dependent on the runtime metadata contents.
-  /runtime/metadata/v15:
-    get:
-      tags:
-      - runtime
-      summary: Get the version 15 of runtime metadata in decoded, JSON form.
-      description: >-
-       Returns the version 15 of runtime metadata as a JSON object.
-       Substrate Reference:
-       - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html
-       - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
-      parameters:
       - name: at
         in: query
         description: Block at which to retrieve the metadata at.