Update spec according to agreement in Sprint Planning

Author: HenrikHL

ovs_hub_ntf/v1/OVS_HUB_NTF_v1.0.0.yaml

@@ -784,39 +784,41 @@ components:
             - '278111222'
             - '278173294'
             - '234422543'
-        UNLocationCodes:
+        locations:
           type: array
           description: |
-            An array of **UN Location codes** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the values when matching.
+            An array of **UNLocationCode and/or facilitySMDGCode combinations** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the objects when matching.
 
-            If this property is empty, you will be notified for all `UNLocationCodes` that have changes you are authorized to see.
+            If this property is empty, you will be notified for all `locations` that have changes you are authorized to see.
           items:
-            type: string
-            pattern: ^[A-Z]{2}[A-Z2-9]{3}$
-            minLength: 5
-            maxLength: 5
+            type: object
             description: |
-              The UN Location code specifying where the place is located. The pattern used must be
+              It is possible to provide the `UNLocationCode`, the `facilitySMDGCode` or both when specifying the location.
 
-              - 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)
-              - 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used
+              If multiple `UNLocationCodes` or `facilitySMDGCodes` need to be provided - then it is necessary to do this in separate `location` objects.
+            properties:
+              UNLocationCode:
+                type: string
+                pattern: ^[A-Z]{2}[A-Z2-9]{3}$
+                minLength: 5
+                maxLength: 5
+                description: |
+                  The UN Location code specifying where the place is located. The pattern used must be
 
-              More info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)
-            example: NLAMS
-        facilitySMDGCodes:
-          type: array
-          description: |
-            An array of **Facility SMDG codes** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the values when matching.
+                  - 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)
+                  - 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used
 
-            If this property is empty, you will be notified for all `facilitySMDGCodes` that have changes you are authorized to see.
-          items:
-            type: string
-            maxLength: 6
-            description: |
-              The code used for identifying the specific facility. This code does not include the UN Location Code.
+                  More info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)
+                example: NLAMS
+              facilitySMDGCode:
+                type: string
+                maxLength: 6
+                description: |
+                  The code used for identifying the specific facility. This code does not include the UN Location Code.
+
+                  The codeList used by SMDG is the [SMDG Terminal Code List](https://smdg.org/wp-content/uploads/Codelists/Terminals/SMDG-Terminal-Code-List-v20210401.xlsx)
+                example: ACT
 
-              The codeList used by SMDG is the [SMDG Terminal Code List](https://smdg.org/wp-content/uploads/Codelists/Terminals/SMDG-Terminal-Code-List-v20210401.xlsx)
-            example: ACT
       required:
         - subscriptionReference
         - notificationChannel
@@ -979,39 +981,40 @@ components:
             - '278111222'
             - '278173294'
             - '234422543'
-        UNLocationCodes:
+        locations:
           type: array
           description: |
-            An array of **UN Location codes** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the values when matching.
+            An array of **UNLocationCode and/or facilitySMDGCode combinations** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the objects when matching.
 
-            If this property is empty, you will be notified for all `UNLocationCodes` that have changes you are authorized to see.
+            If this property is empty, you will be notified for all `locations` that have changes you are authorized to see.
           items:
-            type: string
-            pattern: ^[A-Z]{2}[A-Z2-9]{3}$
-            minLength: 5
-            maxLength: 5
+            type: object
             description: |
-              The UN Location code specifying where the place is located. The pattern used must be
+              It is possible to provide the `UNLocationCode`, the `facilitySMDGCode` or both when specifying the location.
 
-              - 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)
-              - 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used
+              If multiple `UNLocationCodes` or `facilitySMDGCodes` need to be provided - then it is necessary to do this in separate `location` objects.
+            properties:
+              UNLocationCode:
+                type: string
+                pattern: ^[A-Z]{2}[A-Z2-9]{3}$
+                minLength: 5
+                maxLength: 5
+                description: |
+                  The UN Location code specifying where the place is located. The pattern used must be
 
-              More info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)
-            example: NLAMS
-        facilitySMDGCodes:
-          type: array
-          description: |
-            An array of **Facility SMDG codes** to match with this subscription filter. If the array consists of more than one item - a logical **OR** is used between the values when matching.
+                  - 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)
+                  - 3 characters to code a location within that country. Letters A-Z and numbers from 2-9 can be used
 
-            If this property is empty, you will be notified for all `facilitySMDGCodes` that have changes you are authorized to see.
-          items:
-            type: string
-            maxLength: 6
-            description: |
-              The code used for identifying the specific facility. This code does not include the UN Location Code.
+                  More info can be found here: [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download)
+                example: NLAMS
+              facilitySMDGCode:
+                type: string
+                maxLength: 6
+                description: |
+                  The code used for identifying the specific facility. This code does not include the UN Location Code.
 
-              The codeList used by SMDG is the [SMDG Terminal Code List](https://smdg.org/wp-content/uploads/Codelists/Terminals/SMDG-Terminal-Code-List-v20210401.xlsx)
-            example: ACT
+                  The codeList used by SMDG is the [SMDG Terminal Code List](https://smdg.org/wp-content/uploads/Codelists/Terminals/SMDG-Terminal-Code-List-v20210401.xlsx)
+                example: ACT
       required:
         - notificationChannel
         - weekRange