Update OVS Hub Terminal Timestamp API

Author: HenrikHL

ovs_hub_ter/v1/OVS_HUB_TER_v1.0.0.yaml

@@ -5,7 +5,7 @@ info:
   description: |
     <h1>DCSA OpenAPI specification for Terminal Data upload for OVS Hub (Operational Vessel Schedule Hub)</h1>
 
-    This API is intended as an API between a terminal and OVS Hub (Operational Vessel Schedule Hub). The purpose of the API is for terminals to be able to provide `ETA`/`ETD`/`ATA` and `ATD` timestamps near-to-realtime to OVS Hub.
+    This API is intended as an API between a terminal and OVS Hub (Operational Vessel Schedule Hub). The purpose of the API is for terminals to be able to provide `ETA`/`ETD`/`ATA` and `ATD` timestamps near real-time to OVS Hub.
 
     ### API Design & Implementation Principles
     This API follows the guidelines defined in version 2.0 of the API Design & Implementation Principles which can be found on the [DCSA Developer Portal](https://developer.dcsa.org/api_design)
@@ -23,9 +23,9 @@ info:
     email: info@dcsa.org
 tags:
   - name: Terminal Timestamp
-    description: Terminal Timestamp endPoint for providing near realtime `ETA`/`ETD`/`ATA` and `ATD` data
+    description: Terminal Timestamp endpoint for providing near realtime `ETA`/`ETD`/`ATA` and `ATD` data
   - name: Terminal Schedules
-    description: Terminal Schedules endPoint for fetching `ETA`/`ETD`/`ATA` and `ATD` data for Services
+    description: Terminal Schedules endpoint for fetching `ETA`/`ETD`/`ATA` and `ATD` data for Services
 paths:
   /v1/terminal-timestamps:
     post:
@@ -49,7 +49,7 @@ paths:
                 summary: |
                   Send an `ETA` timestamp not using `transportCallReference`
                 description: |
-                  Send an `ETA` timestamp for the Vessel: `Jacques Saadé` arriving at `Amsterdam Port` on the 18 of August 2025 at 18.00 Amsterdam time. This example does not include a `transportCallReference`.
+                  Send an `ETA` timestamp for the Vessel: `Jacques Saadé` arriving at `Amsterdam Port` on the 18th of August 2025 at 18.00 Amsterdam time. This example does not include a `transportCallReference`.
                 value:
                   carrierServiceName: 'French Asia Line 3'
                   carrierServiceCode: 'AEU6'
@@ -175,10 +175,10 @@ paths:
                   summary: |
                     Sending too many timestamps
                   description: |
-                    Calling the endPoint
+                    Calling the endpoint
 
                         POST /v1/terminal-timestamps
-                        
+                    
                     too many times within a time period results in an error.
 
                     **NB**: The `errorCode` is not yet standardized by DCSA. The value `7003` is just a "random example".
@@ -187,7 +187,7 @@ paths:
                     requestUri: /v1/terminal-timestamps
                     statusCode: 429
                     statusCodeText: Too Many Requests
-                    statusCodeMessage: Too many Timestamps has been sent. Please try again in 1 hour
+                    statusCodeMessage: Too many Timestamps have been sent. Please try again in 1 hour
                     providerCorrelationReference: 4426d965-0dd8-4005-8c63-dc68b01c4962
                     errorDateTime: '2025-08-18T12:34:00Z'
                     errors:
@@ -197,67 +197,67 @@ paths:
   /v1/terminal-schedules:
     get:
       tags:
-      - Terminal Schedules
+        - Terminal Schedules
       summary: |
         Get a list of Terminal Schedules
       operationId: get-terminal-schedules
       description: |
         Get a list of terminal service schedules.
       parameters:
-      - name: carrierServiceCode
-        in: query
-        description: |
-          The carrier specific service code to filter by. The result will only return schedules including the service code.
-        schema:
-          type: string
-          maxLength: 11
-          example: FE1
-      - name: universalServiceReference
-        in: query
-        description: |
-          The Universal Service Reference (USR) as defined by DCSA to filter by.
-        schema:
-          type: string
-          pattern: ^SR\d{5}[A-Z]$
-          maxLength: 8
-          minLength: 8
-          example: SR12345A
-      - name: startDate
-        in: query
-        description: |
-          The start date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a Schedule matches a date on or after (≥) the `startDate` the entire Voyage (import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call.
-          If this filter is not provided, the default value is **3 months** prior to the request time.
-        schema:
-          type: string
-          format: date
-          example: 2020-04-06
-      - name: endDate
-        in: query
-        description: |
-          The end date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a Schedule matches a date on or before (≤) the `endDate` the entire Voyage(import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call.
-          If this filter is not provided, the default value is **6 months** after the request time.
-        schema:
-          type: string
-          format: date
-          example: 2020-04-10
-      - name: limit
-        in: query
-        description: |
-          Specifies the maximum number of `Terminal Schedule` objects to return.
-        schema:
-          type: integer
-          format: int32
-          minimum: 0
-          default: 100
-          example: 100
-      - name: cursor
-        in: query
-        description: |
-          A server generated value to specify a specific point in a collection result, used for pagination.
-        schema:
-          type: string
-          maxLength: 1024
-          example: fE9mZnNldHw9MTAmbGltaXQ9MTA
+        - name: carrierServiceCode
+          in: query
+          description: |
+            The carrier specific service code to filter by. The result will only return schedules including the service code.
+          schema:
+            type: string
+            maxLength: 11
+            example: FE1
+        - name: universalServiceReference
+          in: query
+          description: |
+            The Universal Service Reference (USR) as defined by DCSA to filter by.
+          schema:
+            type: string
+            pattern: ^SR\d{5}[A-Z]$
+            maxLength: 8
+            minLength: 8
+            example: SR12345A
+        - name: startDate
+          in: query
+          description: |
+            The start date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a Schedule matches a date on or after (≥) the `startDate` the entire Voyage (import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call.
+            If this filter is not provided, the default value is **3 months** prior to the request time.
+          schema:
+            type: string
+            format: date
+            example: 2020-04-06
+        - name: endDate
+          in: query
+          description: |
+            The end date of the period for which schedule information is requested. If a date of any Timestamp (ATA, ETA or PTA) inside a Schedule matches a date on or before (≤) the `endDate` the entire Voyage (import- and export-Voyage) matching the PortCall will be included in the result. All matching is done towards local Date at the place of the port call.
+            If this filter is not provided, the default value is **6 months** after the request time.
+          schema:
+            type: string
+            format: date
+            example: 2020-04-10
+        - name: limit
+          in: query
+          description: |
+            Specifies the maximum number of `Terminal Schedule` objects to return.
+          schema:
+            type: integer
+            format: int32
+            minimum: 0
+            default: 100
+            example: 100
+        - name: cursor
+          in: query
+          description: |
+            A server generated value to specify a specific point in a collection result, used for pagination.
+          schema:
+            type: string
+            maxLength: 1024
+            example: fE9mZnNldHw9MTAmbGltaXQ9MTA
       responses:
         '200':
           description: OK
@@ -379,9 +379,9 @@ components:
           items:
             $ref: '#/components/schemas/VesselSchedule'
       required:
-      - carrierServiceName
-      - carrierServiceCode
-      - vesselSchedules
+        - carrierServiceName
+        - carrierServiceCode
+        - vesselSchedules
 
     VesselSchedule:
       title: Vessel Schedule
@@ -427,7 +427,7 @@ components:
           maxLength: 10
           pattern: ^\S(?:.*\S)?$
           description: |
-            A unique alphanumeric identity that belongs to the vessel and is assigned by the International Telecommunication Union (ITU). It consists of a threeletter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a vessel changes its flag.
+            A unique alphanumeric identity that belongs to the vessel and is assigned by the International Telecommunication Union (ITU). It consists of a three letter alphanumeric prefix that indicates nationality, followed by one to four characters to identify the individual vessel. For instance, vessels registered under Denmark are assigned the prefix ranges 5PA-5QZ, OUAOZZ, and XPA-XPZ. The Call Sign changes whenever a vessel changes its flag.
           example: NCVV
         transportCalls:
           type: array
@@ -437,8 +437,8 @@ components:
           items:
             $ref: '#/components/schemas/TransportCall'
       required:
-      - vesselOperatorSMDGLinerCode
-      - transportCalls
+        - vesselOperatorSMDGLinerCode
+        - transportCalls
 
     TransportCall:
       title: Transport Call
@@ -495,8 +495,8 @@ components:
             - `1 character` for the direction/haul (`N`orth, `E`ast, `W`est, `S`outh or `R`oundtrip)
           example: 2103N
         location:
-          type: object    
-          title: 'Location'      
+          type: object
+          title: 'Location'
           description: |
             An object to capture the location of the timestamp(s).
 
@@ -545,9 +545,9 @@ components:
           items:
             $ref: '#/components/schemas/Timestamp'
       required:
-      - carrierImportVoyageNumber
-      - transportCallReference
-      - timestamps
+        - carrierImportVoyageNumber
+        - transportCallReference
+        - timestamps
 
     Timestamp:
       title: Timestamp
@@ -595,10 +595,10 @@ components:
             The UTC date and time, when the **Vessel** of a **Port Call** is estimated or has happened.
           example: '2025-08-18T17:41:00+08:30'
       required:
-      - typeCode
-      - classifierCode
-      - positionCode
-      - dateTime
+        - typeCode
+        - classifierCode
+        - positionCode
+        - dateTime
 
     TerminalTimestamp:
       title: Terminal Timestamp
@@ -717,8 +717,8 @@ components:
           maxLength: 5
           pattern: ^\d{2}[0-9A-Z]{2}[NEWSR]$
           description: |
-            A global unique voyage reference for the import Voyage, as per DCSA standard, agreed by VSA partners for the voyage.The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWSR]`
- 
+            A global unique voyage reference for the import Voyage, as per DCSA standard, agreed by VSA partners for the voyage. The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWSR]`
+            
             - `2 digits` for the year
             - `2 alphanumeric characters` for the sequence number of the voyage
             - `1 character` for the direction/haul (`N`orth, `E`ast, `W`est, `S`outh or `R`oundtrip).
@@ -729,13 +729,13 @@ components:
           maxLength: 5
           pattern: ^\d{2}[0-9A-Z]{2}[NEWSR]$
           description: |
-            A global unique voyage reference for the export Voyage, as per DCSA standard, agreed by VSA partners for the voyage.The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWSR]`
- 
+            A global unique voyage reference for the export Voyage, as per DCSA standard, agreed by VSA partners for the voyage. The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWSR]`
+            
             - `2 digits` for the year
             - `2 alphanumeric characters` for the sequence number of the voyage
             - `1 character` for the direction/haul (`N`orth, `E`ast, `W`est, `S`outh or `R`oundtrip).
           example: 2103N
-            
+
         UNLocationCode:
           type: string
           minLength: 5
@@ -911,7 +911,7 @@ components:
           type: string
           maxLength: 500
           description: |
-            A path to the property causing the error, formatted according to [JSONpath](https://github.com/json-path/JsonPath).
+            A path to the property causing the error, formatted according to [JSONPath](https://github.com/json-path/JsonPath).
           example: $.location.facilityCode
         errorCodeText:
           description: |
@@ -927,4 +927,4 @@ components:
           example: Spaces not allowed in facility code
       required:
         - errorCodeText
-        - errorCodeMessage
+        - errorCodeMessage