Merge pull request #268 from blockfrost/chore/decimals-source

chore(docs): document source of 'decimals' in addresses/addr/extended
blockfrost · Jan 2, 2023 · 9054db3 · 9054db3
2 parents 1592278 + e71841f
commit 9054db3
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@ Unreleased changes are in the `master` branch.
 
 - `validateCIP68Metadata` util function returns the validated metadata with proper TS type
 
+## Changed
+
+- document data source of `decimals` field in `/addresses/{address}/extended`
+
 ## [0.1.51] - 2022-12-29
 
 ## Added

diff --git a/openapi.yaml b/openapi.yaml
@@ -7169,7 +7169,10 @@ components:
               decimals:
                 type: integer
                 nullable: true
-                description: Number of decimal places of the asset unit
+                description: >-
+                  Number of decimal places of the asset unit. Primary data
+                  source is CIP68 reference NFT with a fallback to off-chain
+                  metadata.
               has_nft_onchain_metadata:
                 type: boolean
                 description: >-

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -4674,7 +4674,7 @@ export interface components {
         unit: string;
         /** @description The quantity of the unit */
         quantity: string;
-        /** @description Number of decimal places of the asset unit */
+        /** @description Number of decimal places of the asset unit. Primary data source is CIP68 reference NFT with a fallback to off-chain metadata. */
         decimals: number | null;
         /** @description True if the latest minting transaction includes metadata (best-effort) */
         has_nft_onchain_metadata: boolean;

diff --git a/src/schemas/addresses/address_content_extended.yaml b/src/schemas/addresses/address_content_extended.yaml
@@ -20,7 +20,7 @@ properties:
         decimals:
           type: integer
           nullable: true
-          description: Number of decimal places of the asset unit
+          description: Number of decimal places of the asset unit. Primary data source is CIP68 reference NFT with a fallback to off-chain metadata.
         has_nft_onchain_metadata:
           type: boolean
           description: True if the latest minting transaction includes metadata (best-effort)
@@ -30,12 +30,12 @@ properties:
         - decimals
         - has_nft_onchain_metadata
     example:
-      - unit: 'lovelace'
-        quantity: '42000000'
+      - unit: "lovelace"
+        quantity: "42000000"
         decimals: 6
         has_nft_onchain_metadata: false
-      - unit: 'b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e'
-        quantity: '12'
+      - unit: "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e"
+        quantity: "12"
         decimals: null
         has_nft_onchain_metadata: true
   stake_address: