@carrot-foundation/schemas 0.2.4 → 0.3.0

package/schemas/ipfs/recycled-id/recycled-id.schema.json

@@ -25,7 +25,7 @@
           "type": "string",
           "const": "RecycledID",
           "title": "RecycledID Schema Type",
-          "description": "RecycledID NFT schema type"
+          "description": "Discriminator value identifying this record as a RecycledID recycling-outcome certificate"
         },
         "version": {
           "type": "string",
@@ -74,7 +74,7 @@
       "format": "uuid",
       "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
       "title": "External ID",
-      "description": "UUID identifier for external system references",
+      "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
       "examples": [
         "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
       ]
@@ -185,7 +185,7 @@
                 "Carbon (CH₄)"
               ],
               "title": "Credit Type",
-              "description": "Type of credit issued",
+              "description": "Category of environmental credit — indicates the impact pathway (biowaste diversion or methane prevention)",
               "examples": [
                 "Biowaste",
                 "Carbon (CH₄)"
@@ -195,11 +195,11 @@
               "type": "number",
               "minimum": 0,
               "title": "Credit Amount",
-              "description": "Amount of credits issued",
+              "description": "Number of environmental impact credits issued, purchased, or retired",
               "examples": [
-                0,
-                45.2,
-                72.5
+                1.5,
+                100,
+                2500.75
               ]
             },
             "recycling_date": {
@@ -232,7 +232,7 @@
           ],
           "additionalProperties": false,
           "title": "RecycledID Summary",
-          "description": "Summary information for the RecycledID certificate"
+          "description": "Key metrics for the RecycledID certificate including recycled weight, credit details, and issuance timestamps"
         },
         "methodology": {
           "type": "object",
@@ -395,7 +395,7 @@
               "format": "uuid",
               "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
               "title": "External ID",
-              "description": "UUID identifier for external system references",
+              "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
               "examples": [
                 "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
               ]
@@ -482,7 +482,7 @@
               "description": "Subtype of the source waste",
               "examples": [
                 "Food, Food Waste and Beverages",
-                "Domestic Sludge"
+                "Garden, Yard and Park Waste"
               ]
             },
             "weight_kg": {
@@ -512,7 +512,7 @@
               "type": "string",
               "pattern": "^[0-9a-fA-F]{64}$",
               "title": "Location ID Hash",
-              "description": "Anonymized identifier for the location",
+              "description": "SHA-256 hash anonymizing the real location identifier for privacy",
               "examples": [
                 "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
               ]
@@ -522,18 +522,22 @@
               "minLength": 1,
               "maxLength": 50,
               "title": "City",
-              "description": "City name",
+              "description": "Name of the Brazilian municipality where the activity takes place",
               "examples": [
                 "Brasília",
-                "São Paulo"
+                "São Paulo",
+                "Carazinho",
+                "Jundiaí"
               ]
             },
             "subdivision_code": {
               "type": "string",
               "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
               "title": "Country Subdivision Code",
-              "description": "Subdivision code following ISO 3166-2 standard",
+              "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
               "examples": [
+                "BR-SP",
+                "BR-RS",
                 "BR-AP",
                 "BR-DF"
               ]
@@ -551,7 +555,7 @@
               "type": "string",
               "pattern": "^[0-9a-fA-F]{64}$",
               "title": "Responsible Participant ID Hash",
-              "description": "Anonymized ID of the participant responsible for this location",
+              "description": "SHA-256 hash identifying the participant responsible for operations at this location",
               "examples": [
                 "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
               ]
@@ -590,7 +594,7 @@
               ],
               "additionalProperties": false,
               "title": "Coordinates",
-              "description": "GPS coordinates of the location"
+              "description": "Approximate GPS coordinates of the site (city-level precision for privacy)"
             }
           },
           "required": [
@@ -603,7 +607,7 @@
           ],
           "additionalProperties": false,
           "title": "RecycledID Origin Location",
-          "description": "Source waste origin location details"
+          "description": "Geographic location where the source waste was originally collected"
         }
       },
       "required": [
@@ -616,7 +620,7 @@
       ],
       "additionalProperties": false,
       "title": "RecycledID Data",
-      "description": "Complete data structure for RecycledID certificate"
+      "description": "Complete RecycledID certificate data including summary metrics, methodology reference, audit trail, source MassID, waste properties, and origin location"
     },
     "audit_data_hash": {
       "type": "string",
@@ -774,8 +778,8 @@
             "title": "Link Label",
             "description": "Display name for the external link",
             "examples": [
-              "Example text",
-              "Sample value"
+              "example-value",
+              "Hello World"
             ]
           },
           "url": {
@@ -914,9 +918,9 @@
               "title": "Credit Amount",
               "description": "Credit amount",
               "examples": [
-                0,
-                45.2,
-                72.5
+                1.5,
+                100,
+                2500.75
               ]
             },
             "display_type": {
@@ -958,7 +962,7 @@
                 "Carbon (CH₄)"
               ],
               "title": "Credit Type",
-              "description": "Type of credit issued",
+              "description": "Category of environmental credit — indicates the impact pathway (biowaste diversion or methane prevention)",
               "examples": [
                 "Biowaste",
                 "Carbon (CH₄)"
@@ -1008,7 +1012,7 @@
                 "Organic"
               ],
               "title": "Waste Type",
-              "description": "Category or type of waste material",
+              "description": "Broad classification of the waste material being tracked (e.g., Organic)",
               "examples": [
                 "Organic"
               ]
@@ -1098,10 +1102,12 @@
               "minLength": 1,
               "maxLength": 50,
               "title": "City",
-              "description": "City name",
+              "description": "Name of the Brazilian municipality where the activity takes place",
               "examples": [
                 "Brasília",
-                "São Paulo"
+                "São Paulo",
+                "Carazinho",
+                "Jundiaí"
               ]
             },
             "display_type": {
@@ -1146,8 +1152,10 @@
               "type": "string",
               "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
               "title": "Country Subdivision Code",
-              "description": "Subdivision code following ISO 3166-2 standard",
+              "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
               "examples": [
+                "BR-SP",
+                "BR-RS",
                 "BR-AP",
                 "BR-DF"
               ]
@@ -1197,10 +1205,10 @@
               "title": "MassID Token ID",
               "description": "Token ID of the source MassID NFT as #<token_id>",
               "examples": [
-                "Example text",
-                "Sample value"
+                "#456789",
+                "#1000000"
               ],
-              "example": "#123"
+              "example": "#456789"
             },
             "display_type": {
               "title": "Display Type",
@@ -1351,7 +1359,7 @@
   ],
   "additionalProperties": false,
   "title": "RecycledID NFT IPFS Record",
-  "description": "Complete RecycledID NFT IPFS record including fixed attributes and recycling outcome data",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/recycled-id/recycled-id.schema.json",
-  "version": "0.2.4"
-}
+  "description": "Complete RecycledID NFT IPFS record including recycling outcome metrics, source waste provenance, methodology reference, and NFT display attributes",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/recycled-id/recycled-id.schema.json",
+  "version": "0.3.0"
+}

package/schemas/schema-hashes.json

@@ -1,40 +1,40 @@
 {
-  "version": "0.2.4",
+  "version": "0.3.0",
   "schemas": {
     "ipfs/recycled-id/recycled-id.schema.json": {
-      "hash": "0fcf882e2a350500b088d67a70a05a790c6e1d167162727e5ef62980b6edf855",
+      "hash": "41a4461ce2b5016f4d8ed198a332e9383ee10cae9eba2477d908456a4e8c7261",
       "path": "ipfs/recycled-id/recycled-id.schema.json"
     },
     "ipfs/methodology/methodology.schema.json": {
-      "hash": "a500cb27f3a45be0fae508d56f0f521985e03bf2183fa85cdb24b2db3d31357c",
+      "hash": "1d6a4da7bed4a07d3dd55158322b02773fe1ec20ce698135990eb92a7ab01ffe",
       "path": "ipfs/methodology/methodology.schema.json"
     },
     "ipfs/mass-id-audit/mass-id-audit.schema.json": {
-      "hash": "cadceba61403d130144163d5383533cce3509e27c75756b6c12a8b680fc525cd",
+      "hash": "05d4c353673565d0c681653d52703993b973695d4cffc0bd51aa6f7d31fbafef",
       "path": "ipfs/mass-id-audit/mass-id-audit.schema.json"
     },
     "ipfs/mass-id/mass-id.schema.json": {
-      "hash": "2fa8985353d204fab324d717f239f44e9c394eb24a5b7a71fb019c558b9fbab7",
+      "hash": "56574983a91036f30e6084fd595e757d447f5ae56304d1dcf544c78a773cad77",
       "path": "ipfs/mass-id/mass-id.schema.json"
     },
     "ipfs/gas-id/gas-id.schema.json": {
-      "hash": "ebdf8c7431b044eeafe90db1566e550768c5912dbd148ae5e8e6e60993ee81ac",
+      "hash": "60b29365fbf174625e269094174f139d858f45f9a187350924e25952d8f1c465",
       "path": "ipfs/gas-id/gas-id.schema.json"
     },
     "ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json": {
-      "hash": "c25f5bfff9bc895097118ad8b012d26f2b667abbb3d65e2a21aa4e1e18084459",
+      "hash": "7c938d21afec1de8a8a6aee7a1ad3bbb07e091294b8d85a8464d47939b846b78",
       "path": "ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json"
     },
     "ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json": {
-      "hash": "4c2acfb482d73246fc6bead2cbe0fe45c37d51ef6058eaba8da95501ec9a02e4",
+      "hash": "e8fb945c092cd457a352949a3aa2a12a8788ee9cc74d9196f17bd692c17121f1",
       "path": "ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json"
     },
     "ipfs/credit/credit.schema.json": {
-      "hash": "e79bd7aba0a859d8c7c1864177629322603a105b8e68ad6c51d324ecc2c621b6",
+      "hash": "e043c3689a769dfad05f4d20a83821e659266a61d7bfa3a01462d24a91c26e5e",
       "path": "ipfs/credit/credit.schema.json"
     },
     "ipfs/collection/collection.schema.json": {
-      "hash": "494bfbbd8e8721131571031aee97d23b825461e6c8c76de258b06c296ce30d60",
+      "hash": "2f8e7ae43fabfa0b8d4d18af1413fc375eca4622a4df75829b36492261a2a46d",
       "path": "ipfs/collection/collection.schema.json"
     }
   }