Merge pull request #381 from blockfrost/chore/improve-cert-index

fix: description of cert_index parameter in governance endpoints
blockfrost · Oct 31, 2024 · efa3b8a · efa3b8a
2 parents b3f6ca2 + 492062a
commit efa3b8a
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 43 deletions.
diff --git a/blockfrost-openapi.yaml b/blockfrost-openapi.yaml
@@ -1188,7 +1188,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1226,7 +1226,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1266,7 +1266,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1306,7 +1306,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
         - in: query
           name: count
@@ -1374,7 +1374,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index of the proposal.
+          description: Index of the certificate within the proposal transaction.
           example: 0
       responses:
         '200':
@@ -6427,7 +6427,7 @@ components:
             description: Transaction ID
           cert_index:
             type: integer
-            description: Certificate within the transaction
+            description: Index of the certificate within the update transaction.
           action:
             type: string
             enum:

diff --git a/docs/blockfrost-openapi.yaml b/docs/blockfrost-openapi.yaml
@@ -1287,7 +1287,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1325,7 +1325,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1365,7 +1365,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1405,7 +1405,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
         - in: query
           name: count
@@ -1475,7 +1475,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index of the proposal.
+          description: Index of the certificate within the proposal transaction.
           example: 0
       responses:
         '200':
@@ -6725,7 +6725,7 @@ components:
             description: Transaction ID
           cert_index:
             type: integer
-            description: Certificate within the transaction
+            description: Index of the certificate within the update transaction.
           action:
             type: string
             enum:

diff --git a/docs/index.html b/docs/index.html
diff --git a/json-schema.json b/json-schema.json
diff --git a/openapi.yaml b/openapi.yaml
@@ -1287,7 +1287,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1325,7 +1325,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1365,7 +1365,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
       responses:
         '200':
@@ -1405,7 +1405,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index.
+          description: Index of the certificate within the proposal transaction.
           example: 1
         - in: query
           name: count
@@ -1475,7 +1475,7 @@ paths:
           required: true
           schema:
             type: integer
-          description: Transaction index of the proposal.
+          description: Index of the certificate within the proposal transaction.
           example: 0
       responses:
         '200':
@@ -6725,7 +6725,7 @@ components:
             description: Transaction ID
           cert_index:
             type: integer
-            description: Certificate within the transaction
+            description: Index of the certificate within the update transaction.
           action:
             type: string
             enum:

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -1099,7 +1099,7 @@ export interface paths {
                      */
                     tx_hash: string;
                     /**
-                     * @description Transaction index.
+                     * @description Index of the certificate within the proposal transaction.
                      * @example 1
                      */
                     cert_index: number;
@@ -1154,7 +1154,7 @@ export interface paths {
                      */
                     tx_hash: string;
                     /**
-                     * @description Transaction index.
+                     * @description Index of the certificate within the proposal transaction.
                      * @example 1
                      */
                     cert_index: number;
@@ -1210,7 +1210,7 @@ export interface paths {
                      */
                     tx_hash: string;
                     /**
-                     * @description Transaction index.
+                     * @description Index of the certificate within the proposal transaction.
                      * @example 1
                      */
                     cert_index: number;
@@ -1275,7 +1275,7 @@ export interface paths {
                      */
                     tx_hash: string;
                     /**
-                     * @description Transaction index.
+                     * @description Index of the certificate within the proposal transaction.
                      * @example 1
                      */
                     cert_index: number;
@@ -1330,7 +1330,7 @@ export interface paths {
                      */
                     tx_hash: string;
                     /**
-                     * @description Transaction index of the proposal.
+                     * @description Index of the certificate within the proposal transaction.
                      * @example 0
                      */
                     cert_index: number;
@@ -6854,7 +6854,7 @@ export interface components {
         drep_updates: {
             /** @description Transaction ID */
             tx_hash: string;
-            /** @description Certificate within the transaction */
+            /** @description Index of the certificate within the update transaction. */
             cert_index: number;
             /**
              * @description Action in the certificate

diff --git a/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/index.yaml b/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/index.yaml
@@ -16,7 +16,7 @@ get:
       required: true
       schema:
         type: integer
-      description: Transaction index.
+      description: Index of the certificate within the proposal transaction.
       example: 1
   responses:
     "200":

diff --git a/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/metadata.yaml b/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/metadata.yaml
@@ -16,7 +16,7 @@ get:
       required: true
       schema:
         type: integer
-      description: Transaction index of the proposal.
+      description: Index of the certificate within the proposal transaction.
       example: 0
   responses:
     "200":

diff --git a/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/parameters.yaml b/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/parameters.yaml
@@ -16,7 +16,7 @@ get:
       required: true
       schema:
         type: integer
-      description: Transaction index.
+      description: Index of the certificate within the proposal transaction.
       example: 1
   responses:
     "200":

diff --git a/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/votes.yaml b/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/votes.yaml
@@ -16,7 +16,7 @@ get:
       required: true
       schema:
         type: integer
-      description: Transaction index.
+      description: Index of the certificate within the proposal transaction.
       example: 1
     - in: query
       name: count

diff --git a/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/withdrawals.yaml b/src/paths/api/governance/proposals/{tx_hash}/{cert_index}/withdrawals.yaml
@@ -16,7 +16,7 @@ get:
       required: true
       schema:
         type: integer
-      description: Transaction index.
+      description: Index of the certificate within the proposal transaction.
       example: 1
   responses:
     "200":

diff --git a/src/schemas/governance/drep_updates.yaml b/src/schemas/governance/drep_updates.yaml
@@ -7,7 +7,7 @@ items:
       description: Transaction ID
     cert_index:
       type: integer
-      description: Certificate within the transaction
+      description: Index of the certificate within the update transaction.
     action:
       type: string
       enum: [registered, deregistered]

diff --git a/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap b/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
@@ -11578,7 +11578,7 @@ under which it is valid
               "type": "string",
             },
             "cert_index": {
-              "description": "Certificate within the transaction",
+              "description": "Index of the certificate within the update transaction.",
               "type": "integer",
             },
             "tx_hash": {