Merge pull request #344 from blockfrost/fix/tx_metadata_label_json

fix: anyOf compatibility with fast-json-stringify for pimtiive types
blockfrost · Feb 29, 2024 · 7a39f8e · 7a39f8e
2 parents 739233a + 899fac6
commit 7a39f8e
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@ Unreleased changes are in the `master` branch.
 
 - Parsing version 2 of `CIP68` metadata
 
+### Fixed
+
+- `tx_metadata_label_json` and `script_json` compatibility with fast-json-stringify for non-object/primitive types (eg. string)
+
 ## [0.1.61] - 2024-02-06
 
 ### Added

diff --git a/json-schema.json b/json-schema.json
diff --git a/openapi.json b/openapi.json
@@ -9551,7 +9551,6 @@
               "description": "Transaction hash that contains the specific metadata"
             },
             "json_metadata": {
-              "additionalProperties": true,
               "anyOf": [
                 {
                   "type": "string"
@@ -9572,9 +9571,11 @@
                 },
                 {
                   "type": "boolean"
+                },
+                {
+                  "type": "null"
                 }
               ],
-              "nullable": true,
               "description": "Content of the JSON metadata"
             }
           },
@@ -10968,7 +10969,6 @@
         "type": "object",
         "properties": {
           "json": {
-            "additionalProperties": true,
             "anyOf": [
               {
                 "type": "string"
@@ -10989,9 +10989,11 @@
               },
               {
                 "type": "boolean"
+              },
+              {
+                "type": "null"
               }
             ],
-            "nullable": true,
             "description": "JSON contents of the `timelock` script, null for `plutus` scripts"
           }
         },

diff --git a/openapi.yaml b/openapi.yaml
@@ -7042,7 +7042,6 @@ components:
             type: string
             description: Transaction hash that contains the specific metadata
           json_metadata:
-            additionalProperties: true
             anyOf:
               - type: string
               - type: object
@@ -7052,7 +7051,7 @@ components:
               - type: integer
               - type: number
               - type: boolean
-            nullable: true
+              - type: 'null'
             description: Content of the JSON metadata
         required:
           - tx_hash
@@ -8065,7 +8064,6 @@ components:
       type: object
       properties:
         json:
-          additionalProperties: true
           anyOf:
             - type: string
             - type: object
@@ -8075,7 +8073,7 @@ components:
             - type: integer
             - type: number
             - type: boolean
-          nullable: true
+            - type: 'null'
           description: JSON contents of the `timelock` script, null for `plutus` scripts
       required:
         - json

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -5274,11 +5274,9 @@ export interface components {
         /** @description Transaction hash that contains the specific metadata */
         tx_hash: string;
         /** @description Content of the JSON metadata */
-        json_metadata: ({
+        json_metadata: string | {
           [key: string]: unknown;
-        } & (string | {
-          [key: string]: unknown;
-        } | unknown[] | number | boolean)) | null;
+        } | unknown[] | number | boolean | null;
       })[];
     /**
      * @example [
@@ -6207,11 +6205,9 @@ export interface components {
      */
     script_json: {
       /** @description JSON contents of the `timelock` script, null for `plutus` scripts */
-      json: ({
-        [key: string]: unknown;
-      } & (string | {
+      json: string | {
         [key: string]: unknown;
-      } | unknown[] | number | boolean)) | null;
+      } | unknown[] | number | boolean | null;
     };
     /**
      * @example {

diff --git a/src/schemas/scripts/script_json.yaml b/src/schemas/scripts/script_json.yaml
@@ -1,7 +1,6 @@
 type: object
 properties:
   json:
-    additionalProperties: true
     anyOf:
       - type: string
       - type: object
@@ -11,7 +10,7 @@ properties:
       - type: integer
       - type: number
       - type: boolean
-    nullable: true
+      - type: "null"
     description: JSON contents of the `timelock` script, null for `plutus` scripts
 required:
   - json

diff --git a/src/schemas/txs/tx_metadata_label_json.yaml b/src/schemas/txs/tx_metadata_label_json.yaml
@@ -6,7 +6,6 @@ items:
       type: string
       description: Transaction hash that contains the specific metadata
     json_metadata:
-      additionalProperties: true
       anyOf:
         - type: string
         - type: object
@@ -16,7 +15,7 @@ items:
         - type: integer
         - type: number
         - type: boolean
-      nullable: true
+        - type: "null"
       description: Content of the JSON metadata
   required:
     - tx_hash

diff --git a/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap b/test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
@@ -12543,7 +12543,6 @@ State \`gc\` means that a previously \`unpinned\` item has been garbage collecte
         "items": {
           "properties": {
             "json_metadata": {
-              "additionalProperties": true,
               "anyOf": [
                 {
                   "type": "string",
@@ -12565,9 +12564,11 @@ State \`gc\` means that a previously \`unpinned\` item has been garbage collecte
                 {
                   "type": "boolean",
                 },
+                {
+                  "type": "null",
+                },
               ],
               "description": "Content of the JSON metadata",
-              "nullable": true,
             },
             "tx_hash": {
               "description": "Transaction hash that contains the specific metadata",

diff --git a/test/tests/get-schema-for-endpoint.test.ts b/test/tests/get-schema-for-endpoint.test.ts
@@ -1458,7 +1458,6 @@ describe('getSchemaForEndpoint', () => {
               "items": {
                 "properties": {
                   "json_metadata": {
-                    "additionalProperties": true,
                     "anyOf": [
                       {
                         "type": "string",
@@ -1480,9 +1479,11 @@ describe('getSchemaForEndpoint', () => {
                       {
                         "type": "boolean",
                       },
+                      {
+                        "type": "null",
+                      },
                     ],
                     "description": "Content of the JSON metadata",
-                    "nullable": true,
                   },
                   "tx_hash": {
                     "description": "Transaction hash that contains the specific metadata",