chore: retired instead of registered

blockfrost · Jan 16, 2025 · c465de9 · c465de9
1 parent 8c18a37
commit c465de9
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 25 deletions.
diff --git a/blockfrost-openapi.yaml b/blockfrost-openapi.yaml
@@ -6367,9 +6367,9 @@ components:
         has_script:
           type: boolean
           description: Flag which shows if this DRep credentials are a script hash
-        registered:
+        retired:
           type: boolean
-          description: Registration state of the DRep
+          description: Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`.
         expired:
           type: boolean
           description: Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`)
@@ -6384,7 +6384,7 @@ components:
         - active
         - active_epoch
         - has_script
-        - registered
+        - retired
         - expired
         - last_active_epoch
       example:
@@ -6395,7 +6395,7 @@ components:
         active_epoch: 420
         has_script: true
         last_active_epoch: 509
-        registered: true
+        retired: false
         expired: false
     drep_delegators:
       type: array

diff --git a/docs/blockfrost-openapi.yaml b/docs/blockfrost-openapi.yaml
@@ -6672,9 +6672,11 @@ components:
         has_script:
           type: boolean
           description: Flag which shows if this DRep credentials are a script hash
-        registered:
+        retired:
           type: boolean
-          description: Registration state of the DRep
+          description: >-
+            Indicates the registration state of the DRep. Set to `true` if the
+            DRep has been deregistered; otherwise, `false`.
         expired:
           type: boolean
           description: >-
@@ -6693,7 +6695,7 @@ components:
         - active
         - active_epoch
         - has_script
-        - registered
+        - retired
         - expired
         - last_active_epoch
       example:
@@ -6704,7 +6706,7 @@ components:
         active_epoch: 420
         has_script: true
         last_active_epoch: 509
-        registered: true
+        retired: false
         expired: false
     drep_delegators:
       type: array

diff --git a/json-schema.json b/json-schema.json
diff --git a/openapi.json b/openapi.json
@@ -8711,9 +8711,9 @@
             "type": "boolean",
             "description": "Flag which shows if this DRep credentials are a script hash"
           },
-          "registered": {
+          "retired": {
             "type": "boolean",
-            "description": "Registration state of the DRep"
+            "description": "Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`."
           },
           "expired": {
             "type": "boolean",
@@ -8732,7 +8732,7 @@
           "active",
           "active_epoch",
           "has_script",
-          "registered",
+          "retired",
           "expired",
           "last_active_epoch"
         ],
@@ -8744,7 +8744,7 @@
           "active_epoch": 420,
           "has_script": true,
           "last_active_epoch": 509,
-          "registered": true,
+          "retired": false,
           "expired": false
         }
       },

diff --git a/openapi.yaml b/openapi.yaml
@@ -6672,9 +6672,11 @@ components:
         has_script:
           type: boolean
           description: Flag which shows if this DRep credentials are a script hash
-        registered:
+        retired:
           type: boolean
-          description: Registration state of the DRep
+          description: >-
+            Indicates the registration state of the DRep. Set to `true` if the
+            DRep has been deregistered; otherwise, `false`.
         expired:
           type: boolean
           description: >-
@@ -6693,7 +6695,7 @@ components:
         - active
         - active_epoch
         - has_script
-        - registered
+        - retired
         - expired
         - last_active_epoch
       example:
@@ -6704,7 +6706,7 @@ components:
         active_epoch: 420
         has_script: true
         last_active_epoch: 509
-        registered: true
+        retired: false
         expired: false
     drep_delegators:
       type: array

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -6741,7 +6741,7 @@ export interface components {
          *       "active_epoch": 420,
          *       "has_script": true,
          *       "last_active_epoch": 509,
-         *       "registered": true,
+         *       "retired": false,
          *       "expired": false
          *     } */
         drep: {
@@ -6763,8 +6763,8 @@ export interface components {
             active_epoch: number | null;
             /** @description Flag which shows if this DRep credentials are a script hash */
             has_script: boolean;
-            /** @description Registration state of the DRep */
-            registered: boolean;
+            /** @description Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`. */
+            retired: boolean;
             /** @description Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`) */
             expired: boolean;
             /** @description Epoch of the most recent action - registration, update, deregistration or voting */

diff --git a/src/schemas/governance/drep.yaml b/src/schemas/governance/drep.yaml
@@ -21,9 +21,9 @@ properties:
   has_script:
     type: boolean
     description: Flag which shows if this DRep credentials are a script hash
-  registered:
+  retired:
     type: boolean
-    description: Registration state of the DRep
+    description: Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`.
   expired:
     type: boolean
     description: Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`)
@@ -39,7 +39,7 @@ required:
   - active
   - active_epoch
   - has_script
-  - registered
+  - retired
   - expired
   - last_active_epoch
 example:
@@ -50,5 +50,5 @@ example:
   active_epoch: 420
   has_script: true
   last_active_epoch: 509
-  registered: true
+  retired: false
   expired: false
diff --git a/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap b/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
@@ -10936,16 +10936,21 @@ under which it is valid
           "active_epoch": 420,
           "amount": "2000000",
           "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc",
+          "expired": false,
           "has_script": true,
           "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d",
+          "last_active_epoch": 509,
+          "retired": false,
         },
         "properties": {
           "active": {
+            "deprecated": true,
             "description": "Registration state of the DRep",
             "type": "boolean",
           },
           "active_epoch": {
-            "description": "Epoch of the most recent action - registration or deregistration",
+            "deprecated": true,
+            "description": "Epoch of the most recent registration",
             "nullable": true,
             "type": "integer",
           },
@@ -10957,6 +10962,10 @@ under which it is valid
             "description": "Bech32 encoded DRep address",
             "type": "string",
           },
+          "expired": {
+            "description": "Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter \`drep_activity\`)",
+            "type": "boolean",
+          },
           "has_script": {
             "description": "Flag which shows if this DRep credentials are a script hash",
             "type": "boolean",
@@ -10965,6 +10974,15 @@ under which it is valid
             "description": "The raw bytes of the DRep",
             "type": "string",
           },
+          "last_active_epoch": {
+            "description": "Epoch of the most recent action - registration, update, deregistration or voting",
+            "nullable": true,
+            "type": "integer",
+          },
+          "retired": {
+            "description": "Indicates the registration state of the DRep. Set to \`true\` if the DRep has been deregistered; otherwise, \`false\`.",
+            "type": "boolean",
+          },
         },
         "required": [
           "drep_id",
@@ -10973,6 +10991,9 @@ under which it is valid
           "active",
           "active_epoch",
           "has_script",
+          "retired",
+          "expired",
+          "last_active_epoch",
         ],
         "type": "object",
       },