Merge pull request #66 from sine-fdn/tad/consignmentid

feat: update TAD/consignmentIds and add changelog entry

Author: raimundo-henriques

specs/index.bs

@@ -179,7 +179,7 @@ framework for delineating subsequent [[#txns|data transactions]] and the [[#data
 
 ## Quantification of (Avoided) Emissions ## {#business-case-1}
 
-A [=Transport Service User=] requests its [=Transport Service Organizers=] or [=Transport Operators=] to provide it with the GHG emissions of [=Shipments=]. 
+A [=Transport Service User=] requests its [=Transport Service Organizers=] or [=Transport Operators=] to provide it with the GHG emissions of [=Shipments=].
 The transport service user is particularly interested in having access to accurate emission and emission intensity values based on the measurement of actual data ("primary data").
 
 Accurate logistics emissions values also enable the Transport Service User to compare logistics emissions and the resulting reductions from operational measures.
@@ -192,7 +192,7 @@ Data Transactions #1 ([[#txn1]]) and #2 ([[#txn2]]) enable this business case.
 A [=Transport Service Organizer=] requests their [=Transport Operators=] to share GHG emission intensity information at the [=TOC=] or [=HOC=] level.
 Similarly, a [=Transport Service User=] requests intensity information from their [=Transport Service Organizers=] and [=Transport Operators=].
 
-By incorporating emission intensities in procurement processes, the parties are enabled to select services by carbon-efficiency advantages. 
+By incorporating emission intensities in procurement processes, the parties are enabled to select services by carbon-efficiency advantages.
 
 Data Transaction #2 [[#txn2]] enable this business case.
 
@@ -207,7 +207,7 @@ After collecting Transport Activity Data, the Party can then contract a third pa
 
 This business case is particularly relevant for SMEs to reduce the barrier to entry for logistics emissions reporting.
 
-The way this business case is realized through iLEAP, generally simplifies data collection efforts for the parties involved. 
+The way this business case is realized through iLEAP, generally simplifies data collection efforts for the parties involved.
 For instance, each party needs to collect the activity data only once. Afterwards, the Party can make the activity data available to multiple parties (see [[#txn3]]) or for different purposes, including business cases beyond emissions calculations.
 
 Data Transaction #3 ([[#txn3]]) enables this business case.
@@ -1162,36 +1162,36 @@ The Data Type <{HOC}> has the following properties:
 
 ## Transport Activity Data (<dfn element>TAD</dfn>) ## {#dt-tad}
 
-The <dfn>Transport Activity Data </dfn> (<{TAD}>) data type contains activity 
+The <dfn>Transport Activity Data </dfn> (<{TAD}>) data type contains activity
 data, referring to a single consignment, leg, and mode of transport, or to a
-single transshipment within a hub. 
+single transshipment within a hub.
 
 Each TAD CAN contain values for attributes which are categorial to the
 operations of a fleet or hub (such as load factor or mix of feedstock(s)).
 In this case, the values CAN be calculated from the actual data of more
-than one consignment (“representative” or “average data”). 
+than one consignment (“representative” or “average data”).
 
 <div class=example>
-  Instead of exchanging the load factor for a single assignment, 
-  the load factor can be calculated from a multitude of consignments 
-  following the principles of TOC calculation. 
+  Instead of exchanging the load factor for a single assignment,
+  the load factor can be calculated from a multitude of consignments
+  following the principles of TOC calculation.
 </div>
 
-The TAD data type is designed for entities 
-([=Transport Operators=] or [=Transport Service Organizers=]) that lack 
-the capabilities to perform carbon emission calculations 
-(see [[#business-case-3|Business Case 3]]) or are 
+The TAD data type is designed for entities
+([=Transport Operators=] or [=Transport Service Organizers=]) that lack
+the capabilities to perform carbon emission calculations
+(see [[#business-case-3|Business Case 3]]) or are
 contractually obliged to exchange activity data with another party.
 
-It can also be used by the service providers (Transport Operator or 
-Transport Service Organizer) to provide additional transparency 
-to their business partners where relevant. 
+It can also be used by the service providers (Transport Operator or
+Transport Service Organizer) to provide additional transparency
+to their business partners where relevant.
 
 ### Data Attributes ### {#tad-attributes}
 
 Below table lists the properties defined for the <{TAD}> data type.
 
-When exchanging it through the Action TransportActivityData, it MUST be 
+When exchanging it through the Action TransportActivityData, it MUST be
 encoded as a JSON object. See [[#action-tad]] for details.
 
 <figure id="tad-properties-table" dfn-type="element-attr" dfn-for="TAD">
@@ -1209,10 +1209,10 @@ encoded as a JSON object. See [[#action-tad]] for details.
         <td>M
         <td>The non-empty unique ID of this activity relative to the [=host system=].
       <tr>
-        <td><dfn>consignmentId</dfn>
-        <td>String
+        <td><dfn>consignmentIds</dfn>
+        <td>String[]
         <td>M
-        <td>The non-empty unique ID of the consignment related to the activity.
+        <td>The non-empty array of unique IDs of the consignments related to the activity.
       <tr>
         <td><dfn>distance</dfn>
         <td><{GLECDistance}>
@@ -2033,6 +2033,13 @@ Note: Section [[#appendix-b-toc-example]] contains an example.
 
 # Appendix A: Changelog # {#changelog}
 
+## Version 0.2.1-20240529 (2024-05-29) ## {#version-20240529}
+
+- reorganized and reworded chapter [[#business-cases]]
+- updated introduction to the [[#dt-tad]] chapter
+- replaced property `consignmentId` in <{TAD}> by an array of strings <{TAD/consignmentIds}>
+  achieving coherence with introductory text
+
 ## Version 0.2.1-20240528 (2024-05-28) ## {#version-20240528}
 
 - rewording of chapter [[#business-cases]] and splitting of the business cases into individual subchapters