Merge pull request #32 from sine-fdn/enumerations

Enumerations

Author: raimundo-henriques

specs/index.bs

@@ -686,9 +686,9 @@ Note: The properties `tocId` and `hocId` are mutually exclusive, but one of them
 
       <tr>
         <td><dfn>packagingOrTrEqType</dfn>
-        <td>String
+        <td><{PackagingOrTrEqType}>
         <td>O
-        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment (e.g. box, pallet, container) by the [=Transport Operator=] or [=Transport Service Organizer=].
+        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment. See data type <{PackagingOrTrEqType}> for further information.
 
       <tr>
         <td><dfn>packagingOrTrEqAmount</dfn>
@@ -1089,7 +1089,7 @@ The Data Type <{HOC}> has the following properties:
         <td><dfn>packagingOrTrEqType</dfn>
         <td>String
         <td>O
-        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment (e.g. box, pallet, container) by the [=Transport Operator=] or [=Transport Service Organizer=].
+        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment. See data type <{PackagingOrTrEqType}> for further information.
 
       <tr>
         <td><dfn>packagingOrTrEqAmount</dfn>
@@ -1230,19 +1230,19 @@ both SHOULD be defined.
         <td><dfn>packagingOrTrEqType</dfn>
         <td>String
         <td>O
-        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment (e.g. box, pallet, container) by the [=Transport Operator=] or [=Transport Service Organizer=].
+        <td>Category of relevant packaging or transport equipment units utilized for the transport of the consignment. See data type <{PackagingOrTrEqType}> for further information.
       <tr>
         <td><dfn>packagingOrTrEqAmount</dfn>
         <td>Number
         <td>O
         <td>Number of packaging or transport equipment units utilized to transport the related consignment by the [=Transport Operator=] or [=Transport Service Organizer=].
       <tr>
         <td><dfn>energyCarrier</dfn>
-        <td>String
+        <td><{EnergyCarrierType}>
         <td>O
         <td>
             The substance used to generate mechanical movement or heat and to generate chemical or
-            physical processes as per the [[!GLEC]] Framework. For example: Diesel, HVO, petrol, CNG, LNG, LPG, HFO, MGO, Aviation fuel, Hydrogen, Methanol, Electric, etc.
+            physical processes as per the [[!GLEC]] Framework. See data type <{EnergyCarrierType}> for further information.
 
             If <{TAD/energyCarrier}> is not defined, then <{TAD/feedstocks}> MUST be defined. If possible, both SHOULD be defined.
       <tr>
@@ -1458,10 +1458,10 @@ The following properties are defined for data type <dfn element>EnergyCarrier</d
     <tbody>
       <tr>
         <td><dfn>energyCarrier</dfn>
-        <td>String
+        <td><{EnergyCarrierType}>
         <td>M
         <td>The substance used to generate mechanical movement or heat and to generate chemical or
-        physical processes as per the [[!GLEC]] Framework. For example: Diesel, HVO, petrol, CNG, LNG, LPG, HFO, MGO, Aviation fuel, Hydrogen, Methanol, Electric, etc.
+        physical processes as per the [[!GLEC]] Framework. See data type <{EnergyCarrierType}> for further information.
       <tr>
         <td><dfn>feedstocks</dfn>
         <td><{Feedstock}>[]
@@ -1496,7 +1496,43 @@ The following properties are defined for data type <dfn element>EnergyCarrier</d
     </table>
 </figure>
 
-### Data Type <dfn>Feedstock</dfn> ### {#dt-feed-stock}
+### Data Type <dfn>EnergyCarrierType</dfn> ### {#dt-energy-carrier-type}
+
+Data type <dfn element>EnergyCarrierType</dfn> represents the substance used to generate mechanical
+movement or heat and to generate chemical or physical processes as per the [[!GLEC]] Framework.
+
+It MUST be encoded as a String using one of the following values:
+
+Advisement: The enumeration of energy carrier types below will be evolved in future revisions.
+Account for this when implementing the validation of this property.
+
+: Diesel
+:: refers to diesel
+: HVO
+:: refers to Hydrotreated Vegetable Oil
+: Petrol
+:: refers to petrol
+: CNG
+:: refers to Compressed Natural Gas
+: LNG
+:: refers to Liquefied Natural Gas
+: LPG
+:: refers to Liquefied Petroleum Gas
+: HFO
+:: refers to Heavy Fuel Oil
+: MGO
+:: refers to Marine Gas Oil
+: Aviation fuel
+:: refers to aviation fuel
+: Hydrogen
+:: refers to hydrogen
+: Methanol
+:: refers to methanol
+: Electric
+:: refers to electricity
+
+
+### Data Type <dfn>Feedstock</dfn> ### {#dt-feedstock}
 
 Data type `Feedstock` represents one feedstock of an [=EnergyCarrier=].
 
@@ -1517,8 +1553,23 @@ The following properties are defined for data type <dfn element>Feedstock</dfn>:
           <td><dfn>feedstock</dfn>
           <td>String
           <td>M
-          <td>A feedstock of an [=EnergyCarrier=], e.g., fossil, natural gas, grid, renewable electricity, waste.
-
+          <td>A feedstock of an [=EnergyCarrier=].
+
+            The value MUST be one of the following:
+
+            Advisement: The enumeration of feedstocks below will be evolved in future revisions.
+            Account for this when implementing the validation of this property.
+
+            : Fossil
+            :: refers to fossil sources
+            : Natural gas
+            :: refers to natural gas
+            : Grid
+            :: refers to grid electricity
+            : Renewable electricity
+            :: refers to renewable sources of electricity
+            : Cooking oil
+            :: refers to cooking (e.g., vegetable) oil
         <tr>
           <td><dfn>feedstockPercentage</dfn> : [0..1]
           <td>Number
@@ -1532,6 +1583,24 @@ The following properties are defined for data type <dfn element>Feedstock</dfn>:
     </table>
 </figure>
 
+### Data Type <dfn>PackagingOrTrEqType</dfn> ### {#dt-packaging-or-tr-eq-type}
+
+Data type <dfn element>PackagingOrTrEqType</dfn> represents the category of relevant packaging or transport equipment
+units utilized for the transport of the consignment by the [=Transport Operator=] or [=Transport
+Service Organizer=].
+
+It MUST be encoded as a String using one of the following values:
+
+Advisement: The enumeration of packaging or transport equipment units below will be evolved in future revisions. Account for this when
+implementing the validation of this property.
+
+: Box
+:: refers to boxes
+: Pallet
+:: refers to pallets
+: Container
+:: refers to containers
+
 # HTTP REST API # {#http-rest-api}
 
 A [=host system=] MUST implement: