Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-024 Filter capabilities

Requirement

Title

Filter encoding

Identifier

SWIM-SERV-310

Requirement

If information service payload filtering is available, a service description shall include or refer to information about the filter encoding.

Rationale

This requirement ensures that the precise meaning of the filter expressions is understood.

Verification

Completeness: If filter expressions are applied, verify that the filter encoding is included.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Examples include indication of how to interpret and/or combine filters, including cases such as usage of wildcards, allowing and interpreting empty filters, combinations of filters in terms of logical expressions (e.g. implicit AND, implicit OR, explicit operator), etc.

Note: It is possible to refer to standards in this case such as the OGC Filter Encoding Standard [RD 14].

Level of Implementation

Mandatory (Conditional)

Guidance

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to information about the filter encoding if filter expressions are applied.

Examples

The following example shows the content as a table.

filter encodingThe service allows filtering based on a start and end time given as HTTP Query parameters start_date and end_date. The values are formatted in ISO8601. Example: &start_date=2022-06-22&end_date=2022-06-25.


The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-310 using Service Metadata Schema
"informationDescription": {
 "filtering": {
  "capability": [{
   "name": "time period",
   "description": "The service allows filtering based on a start and end time given as HTTP Query parameters start_date and end_date. The values are formatted in ISO8601. Example: &start_date=2022-06-22&end_date=2022-06-25. "
  }]
 }		
}

Complete examples are available at Example service description.


  • No labels