[API Part2] Completed advanced filtering section

opengeospatial · Jun 12, 2024 · 996c8e1 · 996c8e1
1 parent 94f09ea
commit 996c8e1
Show file tree

Hide file tree

Showing 14 changed files with 302 additions and 36 deletions.
diff --git a/api/part2/openapi/parameters/controlStreamIdList.yaml b/api/part2/openapi/parameters/controlStreamIdList.yaml
diff --git a/api/part2/openapi/parameters/dataStreamIdList.yaml b/api/part2/openapi/parameters/dataStreamIdList.yaml
diff --git a/api/part2/openapi/parameters/eventTime.yaml b/api/part2/openapi/parameters/eventTime.yaml
@@ -1,11 +1,11 @@
-name: eventTime
+name: datetime
 in: query
 description: |-
   Either a date-time or an interval. Date and time expressions adhere to RFC 3339. 
   Intervals may be bounded or half-bounded (double-dots at start or end).
 
   Only resources with a `time` property that intersects the value of the
-  `eventTime` parameter are selected.
+  `datetime` parameter are selected.
 required: false
 schema:
   $ref: ../../../part1/openapi/parameters/datetimeSchema.yaml

diff --git a/api/part2/openapi/parameters/eventTypeList.yaml b/api/part2/openapi/parameters/eventTypeList.yaml
@@ -0,0 +1,12 @@
+name: eventType
+description: |-
+  List of event types.
+  Only event resources with a type that matches one of the provided types are selected.
+in: query
+required: false
+schema:
+  type: array
+  minItems: 1
+  items:
+    type: string
+explode: false
diff --git a/api/part2/openapi/parameters/senderList.yaml b/api/part2/openapi/parameters/senderList.yaml
@@ -0,0 +1,12 @@
+name: sender
+description: |-
+  List of sender IDs.
+  Only command resources issued by one of the specified senders are selected.
+in: query
+required: false
+schema:
+  type: array
+  minItems: 1
+  items:
+    type: string
+explode: false
diff --git a/api/part2/openapi/parameters/statusCodeList.yaml b/api/part2/openapi/parameters/statusCodeList.yaml
@@ -0,0 +1,13 @@
+name: statusCode
+description: |-
+  List of command status codes.
+  Only command resources whose current status matches one of the provided status codes are selected.
+in: query
+required: false
+schema:
+  type: array
+  minItems: 1
+  items:
+    type: string
+    enum: ["PENDING", "ACCEPTED", "REJECTED", "SCHEDULED", "UPDATED", "CANCELED", "EXECUTING", "FAILED", "COMPLETED"]
+explode: false
diff --git a/api/part2/openapi/paths/commandStatus.yaml b/api/part2/openapi/paths/commandStatus.yaml
@@ -10,7 +10,7 @@ get:
   parameters:
     - $ref: ../../../part1/openapi/parameters/idList.yaml
     - $ref: ../parameters/reportTime.yaml
-    - $ref: ../parameters/executionTime.yaml
+    - $ref: ../parameters/statusCodeList.yaml
     #- $ref: '#/components/parameters/select'
     - $ref: ../../../part1/openapi/parameters/limit.yaml
   responses:

diff --git a/api/part2/openapi/paths/commands.yaml b/api/part2/openapi/paths/commands.yaml
@@ -8,6 +8,8 @@ get:
     - $ref: ../../../part1/openapi/parameters/idList.yaml
     - $ref: ../parameters/issueTime.yaml
     - $ref: ../parameters/executionTime.yaml
+    - $ref: ../parameters/statusCodeList.yaml
+    - $ref: ../parameters/senderList.yaml
     - $ref: ../../../part1/openapi/parameters/controlStreamIdList.yaml
     - $ref: ../../../part1/openapi/parameters/systemIdList.yaml
     - $ref: ../../../part1/openapi/parameters/foiIdList.yaml

diff --git a/api/part2/openapi/paths/controlStreamCommands.yaml b/api/part2/openapi/paths/controlStreamCommands.yaml
@@ -11,6 +11,8 @@ get:
     - $ref: ../../../part1/openapi/parameters/idList.yaml
     - $ref: ../parameters/issueTime.yaml
     - $ref: ../parameters/executionTime.yaml
+    - $ref: ../parameters/statusCodeList.yaml
+    - $ref: ../parameters/senderList.yaml
     - $ref: ../../../part1/openapi/parameters/foiIdList.yaml
     - $ref: ../../../part1/openapi/parameters/controlPropIdList.yaml
     #- $ref: '#/components/parameters/select'

diff --git a/api/part2/openapi/paths/systemEvents.yaml b/api/part2/openapi/paths/systemEvents.yaml
@@ -9,7 +9,9 @@ get:
     - System Events
   parameters:
     - $ref: ../parameters/eventTime.yaml
+    - $ref: ../parameters/eventTypeList.yaml
     - $ref: ../../../part1/openapi/parameters/keyword.yaml
+    - $ref: ../../../part1/openapi/parameters/systemIdList.yaml
     #- $ref: '#/components/parameters/select'
     - $ref: ../../../part1/openapi/parameters/limit.yaml
   responses:

diff --git a/api/part2/openapi/paths/systemEventsAll.yaml b/api/part2/openapi/paths/systemEventsAll.yaml
@@ -6,7 +6,9 @@ get:
     - System Events
   parameters:
     - $ref: ../parameters/eventTime.yaml
+    - $ref: ../parameters/eventTypeList.yaml
     - $ref: ../../../part1/openapi/parameters/keyword.yaml
+    - $ref: ../../../part1/openapi/parameters/systemIdList.yaml
     #- $ref: '#/components/parameters/select'
     - $ref: ../../../part1/openapi/parameters/limit.yaml
   responses:

diff --git a/api/part2/standard/23-002r0.adoc b/api/part2/standard/23-002r0.adoc
@@ -38,7 +38,7 @@
 :systemevent-resources-endpoint: <<clause-systemevent-resources-endpoint,System Event resources endpoint>>
 //
 :jsonschema-base-url: https://raw.githubusercontent.com/opengeospatial/connected-systems/master/api/part2/openapi/schemas
-
+:filter-idlist-schema: link:https://docs.ogc.org/DRAFTS/23-001r0.html#filter-idlist-schema[ID_List]
 
 ////
 Make sure to complete each included document

diff --git a/api/part2/standard/requirements/systemevent/req_resources_endpoint.adoc b/api/part2/standard/requirements/systemevent/req_resources_endpoint.adoc
@@ -5,7 +5,7 @@ identifier:: /req/system-event/resources-endpoint
 
 part:: The server SHALL support the HTTP GET operation at the path associated to the `SystemEvent` resources endpoint.
 
-part:: The operation SHALL support the parameters `limit` and `datetime` defined in https://docs.ogc.org/is/17-069r4/17-069r4.html#_parameter_limit[Clause 7.15.2] of {ogcapi-features-1}. All references to the term “features” or “feature” in {ogcapi-features-1} requirements SHALL be replaced by the terms “resources” or “resource”, respectively.
+part:: The operation SHALL support the parameters `limit` and `datetime` defined in https://docs.ogc.org/is/17-069r4/17-069r4.html#_parameter_limit[Clause 7.15.2] and https://docs.ogc.org/is/17-069r4/17-069r4.html#_parameter_datetime[Clause 7.15.4] of {ogcapi-features-1}. All references to the term “features” or “feature” in {ogcapi-features-1} requirements SHALL be replaced by the terms “resources” or “resource”, respectively.
 
 part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code 200. The response SHALL only include the <<clause-systemevent-resource,SystemEvent resources>> selected by the request.