Merge pull request #635 from opengeospatial/multiple_locations-update

Multiple locations update

Author: chris-little

core/standard/abstract_tests/ATS_class_collections.adoc

@@ -20,6 +20,7 @@ conformance-test:: /conf/edr/rc-common-variables
 conformance-test:: /conf/edr/rc-radius-variables
 conformance-test:: /conf/edr/rc-cube-variables
 conformance-test:: /conf/edr/rc-corridor-variables
+conformance-test:: /conf/edr/rc-locations-variables
 conformance-test:: /conf/edr/rc-items-variables
 conformance-test:: /conf/edr/rc-md-query-links
 conformance-test:: /conf/core/rc-collection-info-links
@@ -84,6 +85,8 @@ include::collections/ATS_rc-cube-variables.adoc[]
 
 include::collections/ATS_rc-corridor-variables.adoc[]
 
+include::collections/ATS_rc-locations-variables.adoc[]
+
 include::collections/ATS_rc-items-variables.adoc[]
 
 include::collections/ATS_rc-md-query-links.adoc[]

core/standard/abstract_tests/collections/ATS_rc-locations-variables.adoc

@@ -0,0 +1,11 @@
+[[ats_edr_rc-locations-variables]]
+[abstract_test]
+====
+[%metadata]
+identifier:: /conf/edr/rc-locations-variables
+target:: /req/edr/rc-locations-variables
+test-purpose:: Validate `variables` property for a query data type in the `data_queries` section in the collection is correctly defined.
+test-method::
+step::: Verify that the `variables` property complies with <<ats_edr_rc-common-variables,/req/edr/rc-common-variables>>
+step::: Verify that if the `variables` property has a `multiple_locations` property it is a boolean value of *true* or *false*
+====

core/standard/openapi/oas30/parameters/queries/locationId.yaml

@@ -3,4 +3,6 @@ in: path
 required: true
 description: Comma delimited list of location identifiers (i.e. EGLL or EGLL,YBBN,CYOW or London,Brisbane)
 schema:
-    type: string
+    type: string
+style: simple
+explode: false

core/standard/openapi/oas30/schemas/collections/locationsDataQuery.yaml

@@ -7,3 +7,4 @@ properties:
     enum: 
       - locations
     example: locations
+

core/standard/openapi/oas31/parameters/queries/locationId.yaml

@@ -3,4 +3,6 @@ in: path
 required: true
 description: Comma delimited list of location identifiers (i.e. EGLL or EGLL,YBBN,CYOW or London,Brisbane)
 schema:
-    type: string
+    type: string
+style: simple
+explode: false

core/standard/openapi/oas31/schemas/collections/locationsDataQuery.yaml

@@ -7,4 +7,4 @@ properties:
     enum: 
       - locations
     examples: 
-      - locations
+      - locations

core/standard/requirements/edr/REQ_rc-common-query-type.adoc

@@ -34,6 +34,6 @@ A `link` property of a `<<col-data_queries,data_queries>>` object SHALL include
 . if the attribute `type` has the value `trajectory`, the `variables` property SHALL comply with <<ats_edr_rc-common-variables,/req/edr/rc-common-variables>>
 . if the attribute `type` has the value `corridor`, the `variables` property SHALL comply with <<ats_edr_rc-corridor-variables,/req/edr/rc-corridor-variables>>
 . if the attribute `type` has the value `items`, the `variables` property SHALL complys with  <<ats_edr_rc-items-variables,/req/edr/rc-items-variables>>
-. if the attribute `type` has the value `locations`, the `variables` property SHALL comply with <<ats_edr_rc-common-variables,/req/edr/rc-common-variables>>
+. if the attribute `type` has the value `locations`, the `variables` property SHALL comply with <<ats_edr_rc-locations-variables,/req/edr/rc-locations-variables>>
 
 ====

core/standard/requirements/edr/REQ_rc-locationid-response.adoc

@@ -7,10 +7,16 @@
 identifier:: /req/edr/REQ_rc-locationid-response
 
 *A:*
-If the `locationId` parameter is provided only data for locations matching the requested identifers SHOULD be returned.
+
+If the collection supports <<req_edr_rc-locations-variables,multiple locations>> the `locationId` parameter SHALL be a *comma delimited* string. Each delimited value representing a unique location.
 
 ---
+
 *B:*
+If the `locationId` parameter is provided only data for locations matching the requested identifers SHOULD be returned.
+
+---
+*C:*
 If there is no data available for the requested location identifiers a HTTP 204 response SHOULD be returned 
 
 ====

core/standard/requirements/edr/REQ_rc-locations-variables.adoc

@@ -0,0 +1,21 @@
+[[req_edr_rc-locations-variables]]
+
+[requirement]
+====
+[%metadata]
+identifier:: /req/edr/rc-locations-variables
+
+*A:*
+
+A locations `data_queries` object `variables` property SHALL comply with the requirement `/req/edr/rc-variables-common`.
+
+---
+*B:*
+
+A locations `data_queries` object `variables` property MAY include a `multiple_locations` property which SHALL be a boolean value (true/false).
+
+---
+*C:*
+
+If the `variables` property of a `data_queries` object does not include a `multiple_locations` property, the client SHALL assume that the server does not support requests for multiple locations.
+====

core/standard/requirements/edr/query_type/locations.adoc

@@ -7,10 +7,10 @@ The filter constraints are defined by the following query parameters:
 |====
 |Path Parameter| Type | Required|Description|Examples
 a| **locationId**| String|No| Unique identifier(s) for the required location(s), such as a https://en.wikipedia.org/wiki/Geohash[GeoHash], a World Meteorological Organization (WMO) station identifier or place name.  a| * `EGLL`
-* `Ottawa`
-* `limit.broom.flip`
-* `gbsvn`
-* `London,Paris,Washington`
+* `Ottawa` (single location id)
+* `limit.broom.flip` (what three words)
+* `gbsvn` (geohash)
+* `London,Paris,Washington` (delimited list of location ids)
 |====
 
 [cols="2,1,1,2,3"]