@carrot-foundation/schemas 0.2.4 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +144 -116
  2. package/dist/index.cjs +115 -113
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +7 -7
  5. package/dist/index.d.ts +7 -7
  6. package/dist/index.js +115 -113
  7. package/dist/index.js.map +1 -1
  8. package/package.json +12 -12
  9. package/schemas/ipfs/collection/collection.example.json +3 -3
  10. package/schemas/ipfs/collection/collection.schema.json +7 -7
  11. package/schemas/ipfs/credit/credit.example.json +4 -4
  12. package/schemas/ipfs/credit/credit.schema.json +6 -6
  13. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.example.json +15 -15
  14. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json +56 -56
  15. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.example.json +15 -15
  16. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json +54 -54
  17. package/schemas/ipfs/gas-id/gas-id.example.json +9 -9
  18. package/schemas/ipfs/gas-id/gas-id.schema.json +49 -41
  19. package/schemas/ipfs/mass-id/mass-id.example.json +7 -7
  20. package/schemas/ipfs/mass-id/mass-id.schema.json +60 -43
  21. package/schemas/ipfs/mass-id-audit/mass-id-audit.example.json +57 -57
  22. package/schemas/ipfs/mass-id-audit/mass-id-audit.schema.json +14 -14
  23. package/schemas/ipfs/methodology/methodology.example.json +5 -5
  24. package/schemas/ipfs/methodology/methodology.schema.json +7 -7
  25. package/schemas/ipfs/recycled-id/recycled-id.example.json +9 -9
  26. package/schemas/ipfs/recycled-id/recycled-id.schema.json +43 -35
  27. package/schemas/schema-hashes.json +10 -10
@@ -25,7 +25,7 @@
25
25
  "type": "string",
26
26
  "const": "GasID",
27
27
  "title": "GasID Schema Type",
28
- "description": "GasID NFT schema type"
28
+ "description": "Discriminator value identifying this record as a GasID prevented-emissions certificate"
29
29
  },
30
30
  "version": {
31
31
  "type": "string",
@@ -74,7 +74,7 @@
74
74
  "format": "uuid",
75
75
  "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})$",
76
76
  "title": "External ID",
77
- "description": "UUID identifier for external system references",
77
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
78
78
  "examples": [
79
79
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
80
80
  ]
@@ -174,7 +174,7 @@
174
174
  "Methane (CH₄)"
175
175
  ],
176
176
  "title": "Gas Type",
177
- "description": "Type of gas prevented",
177
+ "description": "Greenhouse gas type whose emission was prevented through the waste management activity",
178
178
  "examples": [
179
179
  "Methane (CH₄)"
180
180
  ]
@@ -186,7 +186,7 @@
186
186
  "Carbon (CH₄)"
187
187
  ],
188
188
  "title": "Credit Type",
189
- "description": "Type of credit issued",
189
+ "description": "Category of environmental credit — indicates the impact pathway (biowaste diversion or methane prevention)",
190
190
  "examples": [
191
191
  "Biowaste",
192
192
  "Carbon (CH₄)"
@@ -196,11 +196,11 @@
196
196
  "type": "number",
197
197
  "minimum": 0,
198
198
  "title": "Credit Amount",
199
- "description": "Amount of credits issued",
199
+ "description": "Number of environmental impact credits issued, purchased, or retired",
200
200
  "examples": [
201
- 0,
202
- 45.2,
203
- 72.5
201
+ 1.5,
202
+ 100,
203
+ 2500.75
204
204
  ]
205
205
  },
206
206
  "prevented_co2e_kg": {
@@ -244,7 +244,7 @@
244
244
  ],
245
245
  "additionalProperties": false,
246
246
  "title": "GasID Summary",
247
- "description": "Summary information for the GasID certificate"
247
+ "description": "Key metrics for the GasID certificate including gas type, credit details, prevented emissions, and issuance timestamps"
248
248
  },
249
249
  "methodology": {
250
250
  "type": "object",
@@ -407,7 +407,7 @@
407
407
  "format": "uuid",
408
408
  "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})$",
409
409
  "title": "External ID",
410
- "description": "UUID identifier for external system references",
410
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
411
411
  "examples": [
412
412
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
413
413
  ]
@@ -494,7 +494,7 @@
494
494
  "description": "Subtype of the source waste",
495
495
  "examples": [
496
496
  "Food, Food Waste and Beverages",
497
- "Domestic Sludge"
497
+ "Garden, Yard and Park Waste"
498
498
  ]
499
499
  },
500
500
  "weight_kg": {
@@ -524,7 +524,7 @@
524
524
  "type": "string",
525
525
  "pattern": "^[0-9a-fA-F]{64}$",
526
526
  "title": "Location ID Hash",
527
- "description": "Anonymized identifier for the location",
527
+ "description": "SHA-256 hash anonymizing the real location identifier for privacy",
528
528
  "examples": [
529
529
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
530
530
  ]
@@ -534,18 +534,22 @@
534
534
  "minLength": 1,
535
535
  "maxLength": 50,
536
536
  "title": "City",
537
- "description": "City name",
537
+ "description": "Name of the Brazilian municipality where the activity takes place",
538
538
  "examples": [
539
539
  "Brasília",
540
- "São Paulo"
540
+ "São Paulo",
541
+ "Carazinho",
542
+ "Jundiaí"
541
543
  ]
542
544
  },
543
545
  "subdivision_code": {
544
546
  "type": "string",
545
547
  "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
546
548
  "title": "Country Subdivision Code",
547
- "description": "Subdivision code following ISO 3166-2 standard",
549
+ "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
548
550
  "examples": [
551
+ "BR-SP",
552
+ "BR-RS",
549
553
  "BR-AP",
550
554
  "BR-DF"
551
555
  ]
@@ -563,7 +567,7 @@
563
567
  "type": "string",
564
568
  "pattern": "^[0-9a-fA-F]{64}$",
565
569
  "title": "Responsible Participant ID Hash",
566
- "description": "Anonymized ID of the participant responsible for this location",
570
+ "description": "SHA-256 hash identifying the participant responsible for operations at this location",
567
571
  "examples": [
568
572
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
569
573
  ]
@@ -602,7 +606,7 @@
602
606
  ],
603
607
  "additionalProperties": false,
604
608
  "title": "Coordinates",
605
- "description": "GPS coordinates of the location"
609
+ "description": "Approximate GPS coordinates of the site (city-level precision for privacy)"
606
610
  }
607
611
  },
608
612
  "required": [
@@ -615,7 +619,7 @@
615
619
  ],
616
620
  "additionalProperties": false,
617
621
  "title": "Source Waste Origin Location",
618
- "description": "Location of the waste origin"
622
+ "description": "Geographic location where the source waste was originally collected"
619
623
  },
620
624
  "prevented_emissions_calculation": {
621
625
  "type": "object",
@@ -701,10 +705,10 @@
701
705
  ],
702
706
  "additionalProperties": false,
703
707
  "title": "Calculation Value",
704
- "description": "Single value used in the emissions calculation"
708
+ "description": "Named parameter or computed result used in the prevented emissions formula"
705
709
  },
706
710
  "title": "Calculation Values",
707
- "description": "Values used to calculate the prevented emissions"
711
+ "description": "Input parameters and computed result used in the prevented emissions formula"
708
712
  }
709
713
  },
710
714
  "required": [
@@ -715,7 +719,7 @@
715
719
  ],
716
720
  "additionalProperties": false,
717
721
  "title": "Prevented Emissions Calculation",
718
- "description": "Details of the prevented emissions calculation"
722
+ "description": "Methodology-based calculation of prevented CO₂e emissions, including formula, method, input values, and computation timestamp"
719
723
  }
720
724
  },
721
725
  "required": [
@@ -729,7 +733,7 @@
729
733
  ],
730
734
  "additionalProperties": false,
731
735
  "title": "GasID Data",
732
- "description": "Complete data structure for GasID certificate"
736
+ "description": "Complete GasID certificate data including summary metrics, methodology reference, audit trail, source MassID, waste properties, origin location, and emissions calculation"
733
737
  },
734
738
  "audit_data_hash": {
735
739
  "type": "string",
@@ -887,8 +891,8 @@
887
891
  "title": "Link Label",
888
892
  "description": "Display name for the external link",
889
893
  "examples": [
890
- "Example text",
891
- "Sample value"
894
+ "example-value",
895
+ "Hello World"
892
896
  ]
893
897
  },
894
898
  "url": {
@@ -985,7 +989,7 @@
985
989
  "Methane (CH₄)"
986
990
  ],
987
991
  "title": "Gas Type",
988
- "description": "Type of gas prevented",
992
+ "description": "Greenhouse gas type whose emission was prevented through the waste management activity",
989
993
  "examples": [
990
994
  "Methane (CH₄)"
991
995
  ]
@@ -1019,7 +1023,7 @@
1019
1023
  ],
1020
1024
  "additionalProperties": false,
1021
1025
  "title": "Gas Type Attribute",
1022
- "description": "Gas type attribute"
1026
+ "description": "Type of greenhouse gas whose emissions were prevented (e.g., Methane (CH₄))"
1023
1027
  },
1024
1028
  {
1025
1029
  "type": "object",
@@ -1077,9 +1081,9 @@
1077
1081
  "title": "Credit Amount",
1078
1082
  "description": "Credit amount",
1079
1083
  "examples": [
1080
- 0,
1081
- 45.2,
1082
- 72.5
1084
+ 1.5,
1085
+ 100,
1086
+ 2500.75
1083
1087
  ]
1084
1088
  },
1085
1089
  "display_type": {
@@ -1121,7 +1125,7 @@
1121
1125
  "Carbon (CH₄)"
1122
1126
  ],
1123
1127
  "title": "Credit Type",
1124
- "description": "Type of credit issued",
1128
+ "description": "Category of environmental credit — indicates the impact pathway (biowaste diversion or methane prevention)",
1125
1129
  "examples": [
1126
1130
  "Biowaste",
1127
1131
  "Carbon (CH₄)"
@@ -1171,7 +1175,7 @@
1171
1175
  "Organic"
1172
1176
  ],
1173
1177
  "title": "Waste Type",
1174
- "description": "Category or type of waste material",
1178
+ "description": "Broad classification of the waste material being tracked (e.g., Organic)",
1175
1179
  "examples": [
1176
1180
  "Organic"
1177
1181
  ]
@@ -1261,10 +1265,12 @@
1261
1265
  "minLength": 1,
1262
1266
  "maxLength": 50,
1263
1267
  "title": "City",
1264
- "description": "City name",
1268
+ "description": "Name of the Brazilian municipality where the activity takes place",
1265
1269
  "examples": [
1266
1270
  "Brasília",
1267
- "São Paulo"
1271
+ "São Paulo",
1272
+ "Carazinho",
1273
+ "Jundiaí"
1268
1274
  ]
1269
1275
  },
1270
1276
  "display_type": {
@@ -1309,8 +1315,10 @@
1309
1315
  "type": "string",
1310
1316
  "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
1311
1317
  "title": "Country Subdivision Code",
1312
- "description": "Subdivision code following ISO 3166-2 standard",
1318
+ "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
1313
1319
  "examples": [
1320
+ "BR-SP",
1321
+ "BR-RS",
1314
1322
  "BR-AP",
1315
1323
  "BR-DF"
1316
1324
  ]
@@ -1360,10 +1368,10 @@
1360
1368
  "title": "MassID Token ID",
1361
1369
  "description": "Token ID of the source MassID NFT as #<token_id>",
1362
1370
  "examples": [
1363
- "Example text",
1364
- "Sample value"
1371
+ "#456789",
1372
+ "#1000000"
1365
1373
  ],
1366
- "example": "#123"
1374
+ "example": "#456789"
1367
1375
  },
1368
1376
  "display_type": {
1369
1377
  "title": "Display Type",
@@ -1514,7 +1522,7 @@
1514
1522
  ],
1515
1523
  "additionalProperties": false,
1516
1524
  "title": "GasID NFT IPFS Record",
1517
- "description": "Complete GasID NFT IPFS record including fixed attributes and detailed carbon emissions prevention data",
1518
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/gas-id/gas-id.schema.json",
1519
- "version": "0.2.4"
1520
- }
1525
+ "description": "Complete GasID NFT IPFS record including prevented emissions calculation, source waste provenance, methodology reference, and NFT display attributes",
1526
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.1/schemas/ipfs/gas-id/gas-id.schema.json",
1527
+ "version": "0.3.1"
1528
+ }
@@ -1,9 +1,9 @@
1
1
  {
2
- "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/mass-id/mass-id.schema.json",
2
+ "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.1/schemas/ipfs/mass-id/mass-id.schema.json",
3
3
  "schema": {
4
- "hash": "2fa8985353d204fab324d717f239f44e9c394eb24a5b7a71fb019c558b9fbab7",
4
+ "hash": "547a069deb61f542ac49b7e5118c9f898a69b365f84756753ca3e9be222989ca",
5
5
  "type": "MassID",
6
- "version": "0.2.4",
6
+ "version": "0.3.1",
7
7
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm"
8
8
  },
9
9
  "environment": {
@@ -12,7 +12,7 @@
12
12
  "data_set_name": "TEST"
13
13
  },
14
14
  "blockchain": {
15
- "token_id": "1034",
15
+ "token_id": "100001",
16
16
  "smart_contract_address": "0x1234567890abcdef1234567890abcdef12345678",
17
17
  "chain_id": 80002,
18
18
  "network_name": "Amoy"
@@ -24,8 +24,8 @@
24
24
  "created_at": "2024-12-05T11:02:47.000Z",
25
25
  "external_id": "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
26
26
  "external_url": "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
27
- "name": "MassID #1034 • Organic • 3.25t",
28
- "short_name": "MassID #1034",
27
+ "name": "MassID #100001 • Organic • 3.25t",
28
+ "short_name": "MassID #100001",
29
29
  "description": "This MassID represents 3.25 metric tons of organic food waste from Brasília, Brazil, tracked through complete chain of custody from pick-up to composting.",
30
30
  "image": "ipfs://QmTy8w65yBXgyfG2ZBg5TrfB2hPjrDQH3RCQFJGkARStJb",
31
31
  "animation_url": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
@@ -108,7 +108,7 @@
108
108
  "display_type": "date"
109
109
  }
110
110
  ],
111
- "audit_data_hash": "d9370d263a617c71b14837397f19d5317c540ef0e6d89547675f2f6d5dc987b5",
111
+ "audit_data_hash": "b88422a49cb204e36782b8ea0c02f7d8e8e9dbbbcdde3968b6c0d5c208bb2924",
112
112
  "data": {
113
113
  "waste_properties": {
114
114
  "type": "Organic",
@@ -25,7 +25,7 @@
25
25
  "type": "string",
26
26
  "const": "MassID",
27
27
  "title": "MassID Schema Type",
28
- "description": "Schema type identifier for this record"
28
+ "description": "Discriminator value identifying this record as a MassID waste-traceability certificate"
29
29
  },
30
30
  "version": {
31
31
  "type": "string",
@@ -74,7 +74,7 @@
74
74
  "format": "uuid",
75
75
  "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})$",
76
76
  "title": "External ID",
77
- "description": "UUID identifier for external system references",
77
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
78
78
  "examples": [
79
79
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
80
80
  ]
@@ -194,7 +194,7 @@
194
194
  "description": "Specific subcategory of waste material",
195
195
  "examples": [
196
196
  "Food, Food Waste and Beverages",
197
- "Domestic Sludge"
197
+ "Garden, Yard and Park Waste"
198
198
  ]
199
199
  },
200
200
  "local_classification": {
@@ -258,7 +258,7 @@
258
258
  "type": "string",
259
259
  "pattern": "^[0-9a-fA-F]{64}$",
260
260
  "title": "Location ID Hash",
261
- "description": "Anonymized identifier for the location",
261
+ "description": "SHA-256 hash anonymizing the real location identifier for privacy",
262
262
  "examples": [
263
263
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
264
264
  ]
@@ -268,18 +268,22 @@
268
268
  "minLength": 1,
269
269
  "maxLength": 50,
270
270
  "title": "City",
271
- "description": "City name",
271
+ "description": "Name of the Brazilian municipality where the activity takes place",
272
272
  "examples": [
273
273
  "Brasília",
274
- "São Paulo"
274
+ "São Paulo",
275
+ "Carazinho",
276
+ "Jundiaí"
275
277
  ]
276
278
  },
277
279
  "subdivision_code": {
278
280
  "type": "string",
279
281
  "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
280
282
  "title": "Country Subdivision Code",
281
- "description": "Subdivision code following ISO 3166-2 standard",
283
+ "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
282
284
  "examples": [
285
+ "BR-SP",
286
+ "BR-RS",
283
287
  "BR-AP",
284
288
  "BR-DF"
285
289
  ]
@@ -297,7 +301,7 @@
297
301
  "type": "string",
298
302
  "pattern": "^[0-9a-fA-F]{64}$",
299
303
  "title": "Responsible Participant ID Hash",
300
- "description": "Anonymized ID of the participant responsible for this location",
304
+ "description": "SHA-256 hash identifying the participant responsible for operations at this location",
301
305
  "examples": [
302
306
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
303
307
  ]
@@ -336,7 +340,7 @@
336
340
  ],
337
341
  "additionalProperties": false,
338
342
  "title": "Coordinates",
339
- "description": "GPS coordinates of the location"
343
+ "description": "Approximate GPS coordinates of the site (city-level precision for privacy)"
340
344
  }
341
345
  },
342
346
  "required": [
@@ -364,7 +368,7 @@
364
368
  "type": "string",
365
369
  "pattern": "^[0-9a-fA-F]{64}$",
366
370
  "title": "Participant ID Hash",
367
- "description": "Anonymized identifier for the participant",
371
+ "description": "SHA-256 hash anonymizing the real participant identifier for privacy",
368
372
  "examples": [
369
373
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
370
374
  ]
@@ -403,7 +407,7 @@
403
407
  ],
404
408
  "additionalProperties": false,
405
409
  "title": "Participant",
406
- "description": "A participant in the waste management supply chain"
410
+ "description": "An entity (person, company, or cooperative) involved in the waste management supply chain"
407
411
  },
408
412
  "title": "Participants",
409
413
  "description": "Supply chain participants involved in waste management operations. Roles include Waste Generator, Hauler, Processor, Recycler, Network Integrator, Methodology Author, Methodology Developer, Network, and Community Impact Pool"
@@ -440,7 +444,7 @@
440
444
  "type": "string",
441
445
  "pattern": "^[0-9a-fA-F]{64}$",
442
446
  "title": "Participant ID Hash",
443
- "description": "SHA-256 hash representing a participant identifier (SHA-256 hex string)",
447
+ "description": "SHA-256 hash anonymizing a participant identity used to link records without exposing personal data",
444
448
  "examples": [
445
449
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
446
450
  ]
@@ -465,7 +469,7 @@
465
469
  },
466
470
  "data": {
467
471
  "title": "Pick-up Event Data",
468
- "description": "Data associated with the pick-up event",
472
+ "description": "Optional vehicle and weight details captured during waste pick-up",
469
473
  "type": "object",
470
474
  "properties": {
471
475
  "vehicle_type": {
@@ -485,7 +489,9 @@
485
489
  ],
486
490
  "title": "Vehicle Type",
487
491
  "examples": [
488
- "Truck"
492
+ "Truck",
493
+ "Motorcycle",
494
+ "Cart"
489
495
  ]
490
496
  },
491
497
  "weight_kg": {
@@ -538,7 +544,7 @@
538
544
  "type": "string",
539
545
  "pattern": "^[0-9a-fA-F]{64}$",
540
546
  "title": "Participant ID Hash",
541
- "description": "SHA-256 hash representing a participant identifier (SHA-256 hex string)",
547
+ "description": "SHA-256 hash anonymizing a participant identity used to link records without exposing personal data",
542
548
  "examples": [
543
549
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
544
550
  ]
@@ -575,10 +581,10 @@
575
581
  "Transport Manifest"
576
582
  ],
577
583
  "title": "Weighing Capture Method",
578
- "description": "Method used to capture weight data",
584
+ "description": "How the weight measurement was recorded — digital readout, manual entry, photo evidence, or transport manifest",
579
585
  "examples": [
580
586
  "Digital",
581
- "Manual"
587
+ "Photo (Scale + Cargo)"
582
588
  ]
583
589
  },
584
590
  "scale_type": {
@@ -596,9 +602,10 @@
596
602
  "Weighbridge (Truck Scale)"
597
603
  ],
598
604
  "title": "Scale Type",
599
- "description": "Type of scale used to weigh the load",
605
+ "description": "Type of weighing equipment used to measure the waste load at a collection or processing site",
600
606
  "examples": [
601
- "Weighbridge (Truck Scale)"
607
+ "Weighbridge (Truck Scale)",
608
+ "Floor Scale"
602
609
  ]
603
610
  },
604
611
  "container_type": {
@@ -616,7 +623,8 @@
616
623
  "title": "Container Type",
617
624
  "examples": [
618
625
  "Bag",
619
- "Bin"
626
+ "Bin",
627
+ "Truck"
620
628
  ]
621
629
  },
622
630
  "vehicle_type": {
@@ -636,7 +644,9 @@
636
644
  ],
637
645
  "title": "Vehicle Type",
638
646
  "examples": [
639
- "Truck"
647
+ "Truck",
648
+ "Motorcycle",
649
+ "Cart"
640
650
  ]
641
651
  },
642
652
  "container_capacity_kg": {
@@ -709,7 +719,7 @@
709
719
  "type": "string",
710
720
  "pattern": "^[0-9a-fA-F]{64}$",
711
721
  "title": "Participant ID Hash",
712
- "description": "SHA-256 hash representing a participant identifier (SHA-256 hex string)",
722
+ "description": "SHA-256 hash anonymizing a participant identity used to link records without exposing personal data",
713
723
  "examples": [
714
724
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
715
725
  ]
@@ -771,7 +781,7 @@
771
781
  "type": "string",
772
782
  "pattern": "^[0-9a-fA-F]{64}$",
773
783
  "title": "Participant ID Hash",
774
- "description": "SHA-256 hash representing a participant identifier (SHA-256 hex string)",
784
+ "description": "SHA-256 hash anonymizing a participant identity used to link records without exposing personal data",
775
785
  "examples": [
776
786
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
777
787
  ]
@@ -859,7 +869,7 @@
859
869
  "type": "string",
860
870
  "pattern": "^[0-9a-fA-F]{64}$",
861
871
  "title": "Participant ID Hash",
862
- "description": "SHA-256 hash representing a participant identifier (SHA-256 hex string)",
872
+ "description": "SHA-256 hash anonymizing a participant identity used to link records without exposing personal data",
863
873
  "examples": [
864
874
  "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
865
875
  ]
@@ -959,7 +969,7 @@
959
969
  ],
960
970
  "additionalProperties": false,
961
971
  "title": "MassID Attachment",
962
- "description": "Attachment associated with a specific MassID event, linked by event_id"
972
+ "description": "Regulatory document (Transport Manifest or Recycling Manifest) linked to a specific lifecycle event via event_id"
963
973
  }
964
974
  }
965
975
  },
@@ -971,7 +981,7 @@
971
981
  ],
972
982
  "additionalProperties": false,
973
983
  "title": "MassID Data",
974
- "description": "MassID data containing waste tracking events and supporting information"
984
+ "description": "Complete MassID data including waste properties, geographic locations, supply-chain participants, chronological lifecycle events, and regulatory attachments"
975
985
  },
976
986
  "audit_data_hash": {
977
987
  "type": "string",
@@ -1129,8 +1139,8 @@
1129
1139
  "title": "Link Label",
1130
1140
  "description": "Display name for the external link",
1131
1141
  "examples": [
1132
- "Example text",
1133
- "Sample value"
1142
+ "example-value",
1143
+ "Hello World"
1134
1144
  ]
1135
1145
  },
1136
1146
  "url": {
@@ -1179,7 +1189,7 @@
1179
1189
  "Organic"
1180
1190
  ],
1181
1191
  "title": "Waste Type",
1182
- "description": "Category or type of waste material",
1192
+ "description": "Broad classification of the waste material being tracked (e.g., Organic)",
1183
1193
  "examples": [
1184
1194
  "Organic"
1185
1195
  ]
@@ -1234,10 +1244,10 @@
1234
1244
  "Wood and Wood Products"
1235
1245
  ],
1236
1246
  "title": "Waste Subtype",
1237
- "description": "Specific subcategory of waste within a waste type",
1247
+ "description": "Detailed subcategory of the waste material, refining the broad waste type classification",
1238
1248
  "examples": [
1239
1249
  "Food, Food Waste and Beverages",
1240
- "Domestic Sludge"
1250
+ "Garden, Yard and Park Waste"
1241
1251
  ]
1242
1252
  },
1243
1253
  "display_type": {
@@ -1325,10 +1335,12 @@
1325
1335
  "minLength": 1,
1326
1336
  "maxLength": 50,
1327
1337
  "title": "City",
1328
- "description": "City name",
1338
+ "description": "Name of the Brazilian municipality where the activity takes place",
1329
1339
  "examples": [
1330
1340
  "Brasília",
1331
- "São Paulo"
1341
+ "São Paulo",
1342
+ "Carazinho",
1343
+ "Jundiaí"
1332
1344
  ]
1333
1345
  },
1334
1346
  "display_type": {
@@ -1373,8 +1385,10 @@
1373
1385
  "type": "string",
1374
1386
  "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
1375
1387
  "title": "Country Subdivision Code",
1376
- "description": "Subdivision code following ISO 3166-2 standard",
1388
+ "description": "State or region code following the ISO 3166-2 standard (e.g., BR-SP for São Paulo)",
1377
1389
  "examples": [
1390
+ "BR-SP",
1391
+ "BR-RS",
1378
1392
  "BR-AP",
1379
1393
  "BR-DF"
1380
1394
  ]
@@ -1434,7 +1448,9 @@
1434
1448
  "title": "Pick-up Vehicle Type",
1435
1449
  "description": "Type of vehicle used for waste pick-up operations",
1436
1450
  "examples": [
1437
- "Truck"
1451
+ "Truck",
1452
+ "Motorcycle",
1453
+ "Cart"
1438
1454
  ]
1439
1455
  },
1440
1456
  "display_type": {
@@ -1774,10 +1790,10 @@
1774
1790
  "Transport Manifest"
1775
1791
  ],
1776
1792
  "title": "Weighing Capture Method",
1777
- "description": "Method used to capture weight data",
1793
+ "description": "How the weight measurement was recorded — digital readout, manual entry, photo evidence, or transport manifest",
1778
1794
  "examples": [
1779
1795
  "Digital",
1780
- "Manual"
1796
+ "Photo (Scale + Cargo)"
1781
1797
  ]
1782
1798
  },
1783
1799
  "display_type": {
@@ -1833,9 +1849,10 @@
1833
1849
  "Weighbridge (Truck Scale)"
1834
1850
  ],
1835
1851
  "title": "Scale Type",
1836
- "description": "Type of scale used to weigh the load",
1852
+ "description": "Type of weighing equipment used to measure the waste load at a collection or processing site",
1837
1853
  "examples": [
1838
- "Weighbridge (Truck Scale)"
1854
+ "Weighbridge (Truck Scale)",
1855
+ "Floor Scale"
1839
1856
  ]
1840
1857
  },
1841
1858
  "display_type": {
@@ -1894,7 +1911,7 @@
1894
1911
  ],
1895
1912
  "additionalProperties": false,
1896
1913
  "title": "MassID NFT IPFS Record",
1897
- "description": "Complete MassID NFT IPFS record schema defining waste tracking metadata, chain of custody events, and NFT display attributes",
1898
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/mass-id/mass-id.schema.json",
1899
- "version": "0.2.4"
1900
- }
1914
+ "description": "Complete MassID NFT IPFS record including waste classification, chain-of-custody lifecycle events, geographic locations, supply-chain participants, and NFT display attributes",
1915
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.1/schemas/ipfs/mass-id/mass-id.schema.json",
1916
+ "version": "0.3.1"
1917
+ }