Skip to content

Commit bcd1049

Browse files
GabrielaRubioDomingoGabrielaRubioDomingo
authored
Merge pull request #124 from sine-fdn/schemajson
feat: improve guidance for `DataModelExtension` PACT data type
2 parents 0da36dd + 87804a7 commit bcd1049

File tree

1 file changed

+84
-5
lines changed

1 file changed

+84
-5
lines changed

‎specs/index.bs

+84-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<pre class='metadata'>
2-
Title: iLEAP Technical Specifications (Version 0.2.1-20241113)
2+
Title: iLEAP Technical Specifications (Version 0.2.1-20241210)
33
Shortname: ileap-extension
44
Status: LD
55
Status Text: Draft Technical Specification
@@ -2064,7 +2064,31 @@ Note: Section [[#appendix-b-sf-example]] contains an example.
20642064
The relative share of logistics emissions for which primary data has been used for the calculation.
20652065

20662066
See [[!PACTDX]] and the PACT Framework ([[!PACT-FRAMEWORK]]) for further details.
2067+
<tr>
2068+
<td>DataModelExtension
2069+
<td>`specVersion`
2070+
<td>
2071+
MUST be set `"2.0.0"`, the current version of [[DATA-MODEL-EXTENSIONS]].
2072+
2073+
<tr>
2074+
<td>DataModelExtension
2075+
<td>`dataSchema`
2076+
<td>
2077+
MUST be set to `"https://api.ileap.sine.dev/shipment-footprint.json"`, the URL of the JSON schema for <{ShipmentFootprint}>.
20672078

2079+
Advisement: The URL of the JSON schema will be updated in future revisions.
2080+
2081+
<tr>
2082+
<td>DataModelExtension
2083+
<td>`documentation`
2084+
<td>
2085+
SHOULD be set. If set, its value MUST be `"https://sine-fdn.github.io/ileap-extension/"`.
2086+
2087+
<tr>
2088+
<td>DataModelExtension
2089+
<td>`data`
2090+
<td>
2091+
MUST contain the <{ShipmentFootprint}> as a JSON object.
20682092
</table>
20692093
<figcaption>Mapping of PACT Data Model properties to <{ShipmentFootprint}> properties</figcaption>
20702094
</figure>
@@ -2217,6 +2241,31 @@ Note: Section [[#appendix-b-toc-example]] contains an example.
22172241
The relative share of logistics emissions for which primary data has been used for the calculation.
22182242

22192243
See [[!PACTDX]] and the PACT Framework ([[!PACT-FRAMEWORK]]) for further details.
2244+
<tr>
2245+
<td>DataModelExtension
2246+
<td>`specVersion`
2247+
<td>
2248+
MUST be set `"2.0.0"`, the current version of [[DATA-MODEL-EXTENSIONS]].
2249+
2250+
<tr>
2251+
<td>DataModelExtension
2252+
<td>`dataSchema`
2253+
<td>
2254+
MUST be set to `"https://api.ileap.sine.dev/toc.json"`, the URL of the JSON schema for <{TOC}>.
2255+
2256+
Advisement: The URL of the JSON schema will be updated in future revisions.
2257+
2258+
<tr>
2259+
<td>DataModelExtension
2260+
<td>`documentation`
2261+
<td>
2262+
SHOULD be set. If set, its value MUST be `"https://sine-fdn.github.io/ileap-extension/"`.
2263+
2264+
<tr>
2265+
<td>DataModelExtension
2266+
<td>`data`
2267+
<td>
2268+
MUST contain the <{TOC}> as a JSON object.
22202269
</table>
22212270
<figcaption>Mapping of PACT Data Model properties to <{TOC}> properties</figcaption>
22222271
</figure>
@@ -2373,6 +2422,32 @@ Note: Section [[#appendix-b-hoc-example]] contains an example.
23732422
The relative share of logistics emissions for which primary data has been used for the calculation.
23742423

23752424
See [[!PACTDX]] and the PACT Framework ([[!PACT-FRAMEWORK]]) for further details.
2425+
2426+
<tr>
2427+
<td>DataModelExtension
2428+
<td>`specVersion`
2429+
<td>
2430+
MUST be set `"2.0.0"`, the current version of [[DATA-MODEL-EXTENSIONS]].
2431+
2432+
<tr>
2433+
<td>DataModelExtension
2434+
<td>`dataSchema`
2435+
<td>
2436+
MUST be set to `"https://api.ileap.sine.dev/hoc.json"`, the URL of the JSON schema for <{HOC}>.
2437+
2438+
Advisement: The URL of the JSON schema will be updated in future revisions.
2439+
2440+
<tr>
2441+
<td>DataModelExtension
2442+
<td>`documentation`
2443+
<td>
2444+
SHOULD be set. If set, its value MUST be `"https://sine-fdn.github.io/ileap-extension/"`.
2445+
2446+
<tr>
2447+
<td>DataModelExtension
2448+
<td>`data`
2449+
<td>
2450+
MUST contain the <{HOC}> as a JSON object.
23762451
</table>
23772452
<figcaption>Mapping of PACT Data Model properties to <{HOC}> properties</figcaption>
23782453
</figure>
@@ -2410,6 +2485,13 @@ properties that cannot be derived from `HOC` CAN be populated in a best-effort m
24102485

24112486
# Appendix A: Changelog # {#changelog}
24122487

2488+
## Version 0.2.1-20241210 (2024-12-10) ## {#version-20241210}
2489+
2490+
- add guidance on how to populate PACT's `DataModelExtension` data type in [[#pcf-mapping-sf]],
2491+
[[#pcf-mapping-toc]], and [[#pcf-mapping-hoc]]
2492+
- remove outdated advisement from [[#appendix-b]]
2493+
- fix typo in `dataSchema` of [[#appendix-b-hoc-example]]
2494+
24132495
## Version 0.2.1-20241113 (2024-11-13) ## {#version-20241113}
24142496

24152497
- add appendix [[#ileap-specific-conformance-tests]]
@@ -2503,9 +2585,6 @@ Summary: Initial release of the specification.
25032585

25042586
# Appendix B: Example PCFs with iLEAP Data embedded # {#appendix-b}
25052587

2506-
Advisement: In both examples, the value of `dataSchema` is currently placeholder and should not be
2507-
taken as a link to the actual data schema. This will be updated as soon as possible.
2508-
25092588
## ShipmentFootprint example ## {#appendix-b-sf-example}
25102589

25112590
A Product Footprint with a <{ShipmentFootprint}> highlighted:
@@ -2724,7 +2803,7 @@ A Product Footprint with a <{HOC}> highlighted:
27242803
"extensions": [
27252804
{
27262805
"specVersion": "2.0.0",
2727-
"dataSchema": "https://api.ileap.sine.dev/toc.json",
2806+
"dataSchema": "https://api.ileap.sine.dev/hoc.json",
27282807
"documentation": "https://sine-fdn.github.io/ileap-extension/",
27292808
"data": {
27302809
"hocId": "7890123",

0 commit comments

Comments
 (0)