Fix OVS Hub Notification API

Author: HenrikHL

ovs_hub_ntf/v1/OVS_HUB_NTF_v1.0.0.yaml

@@ -134,6 +134,8 @@ paths:
         - Subscription
       summary: Receive a list of your active subscriptions
       operationId: get-all-subscriptions
+      description: |
+        Get a list of all subscriptions.
       parameters:
         - name: limit
           in: query
@@ -263,8 +265,8 @@ paths:
                     secret: MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDM2NTc4NjIzODk3NDY5MDgyNzM0OTg3MTIzNzg2NA==
                   weekRange: 1
                   vesselIMONumbers:
-                    - 9321483
-                    - 9929429
+                    - '9321483'
+                    - '9929429'
               emailAllExample:
                 summary: |
                   Subscription using emails to be notified about everything
@@ -341,6 +343,8 @@ paths:
         - Subscription
       summary: Find a subscription by subscription reference
       operationId: get-subscription
+      description: |
+        Get the subscription matching `subscriptionReference`.
       parameters:
         - name: subscriptionReference
           in: path
@@ -403,6 +407,8 @@ paths:
         - Subscription
       summary: Stop a subscription by subscription reference
       operationId: delete-subscription
+      description: |
+        Deletes the subscription with `subscriptionReference`.
       parameters:
         - name: subscriptionReference
           in: path
@@ -461,6 +467,8 @@ paths:
         - Subscription
       summary: Update a subscription by subscription reference
       operationId: put-subscription
+      description: |
+        Updates the subscription with `subscriptionReference`.
       parameters:
         - name: subscriptionReference
           in: path
@@ -531,6 +539,8 @@ paths:
         - Secret
       summary: Resets the Secret on an existing subscription
       operationId: put-secret
+      description: |
+        Updates the secret of subscription with `subscriptionReference`.
       parameters:
         - name: subscriptionReference
           in: path
@@ -650,7 +660,7 @@ components:
                 The `callbackUrl` **MUST** be an open endpoint for OVS Hub to call when sending a notification. The receiver **MUST** validate the authenticity of the notification by looking at the `Notification-Signature` header.
 
                 **Condition:** If `callbackUrl` is provided, the `secret` property must also be provided. It can be updated via the [update-secret](https://app.swaggerhub.com/apis/dcsaorg/DCSA_OVS_NTF/1.0.0#/Secret/put-secret) endpoint.
-              example: https://myserver.com/send/callback/here?shipperRef=<shipper defined unique id>
+              example: https://myserver.com/send/callback/here?shipperRef=myID123
             useEmail:
               type: boolean
               description: |
@@ -801,7 +811,6 @@ components:
             If this property is empty, you will be notified for all `facilitySMDGCodes` that have changes you are authorized to see.
           items:
             type: string
-            pattern: ^[A-Z]{2}[A-Z2-9]{3}$
             maxLength: 6
             description: |
               The code used for identifying the specific facility. This code does not include the UN Location Code.
@@ -836,7 +845,7 @@ components:
                 The `callbackUrl` **MUST** be an open endpoint for OVS Hub to call when sending a notification. The receiver **MUST** validate the authenticity of the notification by looking at the `Notification-Signature` header.
 
                 **Condition:** If `callbackUrl` is provided then `secret` property is mandatory to provide also.
-              example: https://myserver.com/send/callback/here?shipperRef=<shipper defined unique id>
+              example: https://myserver.com/send/callback/here?shipperRef=myID123
             secret:
               type: string
               format: byte
@@ -997,7 +1006,6 @@ components:
             If this property is empty, you will be notified for all `facilitySMDGCodes` that have changes you are authorized to see.
           items:
             type: string
-            pattern: ^[A-Z]{2}[A-Z2-9]{3}$
             maxLength: 6
             description: |
               The code used for identifying the specific facility. This code does not include the UN Location Code.