CS 1.0: SD-2690: Add carbon footprint

cs/v1/CS_v1.0.2.yaml

@@ -9,9 +9,9 @@ info:
 
     **Commercial schedules - point-to-point routings**: provides the product offering of single or multiple estimated end-to-end route options for a shipment in the pre-booking phase. This includes point-to-point specification of all transport legs, estimated timings, estimated schedules and interdependencies between transport legs.
 
-    **Commercial schedules – port schedules**: provides, for a required specific port and starting date, the set of all vessels arriving and departing from the port with the corresponding estimated timestamps.
+    **Commercial schedules - port schedules**: provides, for a required specific port and starting date, the set of all vessels arriving and departing from the port with the corresponding estimated timestamps.
 
-    **Commercial schedules – vessel schedules**: provides, for a required specific service and/or voyage and/or vessel and/or location, the timetable of estimated departure and arrival times for each port call on the rotation of the vessel(s).
+    **Commercial schedules - vessel schedules**: provides, for a required specific service and/or voyage and/or vessel and/or location, the timetable of estimated departure and arrival times for each port call on the rotation of the vessel(s).
 
     **All use cases mentioned in this API specification refer to use cases defined in the Commercial Schedules Interface Standard.**
 
@@ -825,6 +825,35 @@ components:
           description: The estimated total time in days that it takes a shipment to move from place of receipt to place of delivery. Transit time includes stop-over time during transhipments and waiting time at connection points, if applicable, thus can vary between the same locations.
           format: int32
           example: 10
+        solutionFootprint:
+          type: object
+          description: |
+            Carbon footprint emission calculation for the full routing solution.
+          properties:
+            co2:
+              type: number
+              format: double
+              description: |
+                CO<sub>2</sub> (Carbon Dioxide) emissions in metric tonnes (t / Mg).
+              example: 506.4
+            sox:
+              type: number
+              format: double
+              description: |
+                SO<sub>x</sub> (Sulphur Oxide) emissions in kilograms (kg).
+              example: 12.4
+            nox:
+              type: number
+              format: double
+              description: |
+                NO<sub>x</sub> (Nitrogen Oxide) emissions in kilograms (kg).
+              example: 15.4
+            pm10:
+              type: number
+              format: double
+              description: |
+                PM<sub>10</sub> (Small Particle) emissions in kilograms (kg).
+              example: 0.8
         legs:
           type: array
           minItems: 1
@@ -975,6 +1004,8 @@ components:
     Timestamp:
       title: Timestamp
       type: object
+      description: |
+        Timestamp defined by a type (Arrival or Departure), a classifier (Planned, Estimated or Actual) and a date and time.
       required:
         - eventTypeCode
         - eventClassifierCode
@@ -1201,6 +1232,8 @@ components:
     Vessel:
       title: Vessel
       type: object
+      description: |
+        Static vessel information like `IMONumber`, `MMSINumber`, `name`, `flag`, `callSign` and operator.
       properties:
         vesselIMONumber:
           type: string
@@ -1253,6 +1286,8 @@ components:
     Barge:
       title: Barge
       type: object
+      description: |
+        Static barge information like `IMONumber`, `MMSINumber`, `name`, `flag`, `callSign` and operator.
       properties:
         vesselIMONumber:
           type: string
@@ -1576,6 +1611,7 @@ components:
           maxLength: 50
           pattern: ^\S(?:.*\S)?$
           description: The identifier of an export voyage. The carrier-specific identifier of the export Voyage.
+
     Leg:
       title: Leg
       type: object
@@ -1599,6 +1635,35 @@ components:
           $ref: '#/components/schemas/PlaceOfDeparture'
         arrival:
           $ref: '#/components/schemas/PlaceOfArrival'
+        footprint:
+          type: object
+          description: |
+            Carbon footprint emission values for this particular leg.
+          properties:
+            co2:
+              type: number
+              format: double
+              description: |
+                CO<sub>2</sub> (Carbon Dioxide) emissions in metric tonnes (t / Mg).
+              example: 506.4
+            sox:
+              type: number
+              format: double
+              description: |
+                SO<sub>x</sub> (Sulphur Oxide) emissions in kilograms (kg).
+              example: 12.4
+            nox:
+              type: number
+              format: double
+              description: |
+                NO<sub>x</sub> (Nitrogen Oxide) emissions in kilograms (kg).
+              example: 15.4
+            pm10:
+              type: number
+              format: double
+              description: |
+                PM<sub>10</sub> (Small Particle) emissions in kilograms (kg).
+              example: 0.8
     Location:
       title: Location
       type: object