Skip to content

Commit d8e2889

Browse files
committed
Update conformance class URIs #9
1 parent bf79a94 commit d8e2889

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@
33
- **Title:** Collection Search
44
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) (todo)
55
- **Conformance Classes:**
6-
- <https://api.stacspec.org/v1.0.0-rc.1/core>
7-
- <https://api.stacspec.org/v1.0.0-rc.1/collection-search>
8-
- <http://www.opengis.net/spec/ogcapi-common-2/1.0/req/simple-query>
6+
- <https://api.stacspec.org/v1.0.0-rc.1/core> (required)
7+
- <https://api.stacspec.org/v1.0.0-rc.1/collection-search> (required)
8+
- <http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query> (required)
9+
- Extensions (all optional):
10+
- Free-text search: <https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text>
11+
- Query/STACQL: <https://api.stacspec.org/v1.0.0-rc.1/collection-search#query>
12+
- Filter/CQL2: <https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter>
13+
- Sort: <https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort>
14+
- Fields: <https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields>
915
- **Scope:** STAC API - Core
1016
- **[Extension Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/main/README.md#maturity-classification):** Proposal
1117
- **Dependencies:**
@@ -43,60 +49,54 @@ for details.
4349

4450
### Basics
4551

52+
- Conformance class: `http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query`
53+
- Requirement class in *OGC API - Common - Part 2: Geospatial Data*: [Simple Query](https://portal.ogc.org/files/99149#rc-simple-query-section)
54+
4655
A basic set of query parameters MUST be implemented.
4756
These are aligned with the corresponding parameters in STAC API - Features and OGC API - Records:
4857
- [`bbox`](https://docs.ogc.org/DRAFTS/20-004.html#_parameter_bbox) (intersection of the given `bbox` with any of the spatial extent provided in a STAC Collection at `extent.spatial.bbox`)
4958
- [`datetime`](https://docs.ogc.org/DRAFTS/20-004.html#_parameter_datetime) (intersection of the given `datetime` with any of the temporal extent provided in a STAC Collection at `extent.temporal.interval`)
5059
- [`limit`](https://docs.ogc.org/DRAFTS/20-004.html#_parameter_limit)
5160

52-
Requirement class in *OGC API - Common - Part 2: Geospatial Data*: [Simple Query](https://portal.ogc.org/files/99149#rc-simple-query-section)
53-
5461
### Extensions
5562

5663
#### Free text search
5764

65+
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text`
66+
5867
A free-text search parameter `q` based on OGC API - Records can be added.
5968
See <https://docs.ogc.org/DRAFTS/20-004.html#_parameter_q> for details.
6069
It is case-insensitive and matches the string given strictly.
6170
The specific set of text keys/fields/properties of a Collection to which the parameter is applied is left to the discretion of the implementation, but a recommendation is to at least consider `title`, `description` and `keywords`.
6271

63-
- Requirement class in *OGC API - Records*: n/a
64-
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text`
65-
66-
#### Query (STACQL)
67-
68-
The query extension for STACQL support can be implemented, too. It works as it does for Items.
69-
See <https://github.com/stac-api-extensions/query> for details.
70-
71-
- Requirement class in *OGC API - Records*: n/a
72-
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#query`
73-
7472
#### Filter (CQL)
7573

74+
- Conformance classes: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter`
75+
- Requirement class in *OGC API - Records*: [Local Resource Catalogue, CQL Filter](https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalogue_cql2-filter)
76+
7677
The filter extension for CQL support can be implemented, too.
7778
See <https://github.com/stac-api-extensions/filter> for details.
7879
It works as it does for Items, except that the queryables link for Collection Search is located in the response of `GET /collections` (property `links`).
7980
The path/endpoint for Collection Search queryables can be freely chosen, but SHOULD NOT conflict with `GET /queryables`.
8081

81-
- Requirement class in *OGC API - Records*: CQL Filter
82-
- Conformance classes:
83-
- `https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter`
84-
- `http://www.opengis.net/spec/ogcapi-records-1/1.0/req/cql-filter`
82+
#### Query (STACQL)
83+
84+
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#query`
85+
86+
The query extension for STACQL support can be implemented, too. It works as it does for Items.
87+
See <https://github.com/stac-api-extensions/query> for details.
8588

8689
#### Sorting
8790

91+
- Conformance classes: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort`
92+
- Requirement class in *OGC API - Records*: [Local Resource Catalogue, Sorting](https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalogue_sorting)
93+
8894
The sort extension can be implemented, too. It works as it does for Items.
8995
See <https://github.com/stac-api-extensions/sort> for details.
9096

91-
- Requirement class in *OGC API - Records*: Sorting
92-
- Conformance classes:
93-
- `https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort`
94-
- `http://www.opengis.net/spec/ogcapi-records-1/1.0/req/sorting`
95-
9697
#### Fields
9798

99+
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields`
100+
98101
The fields extension can be implemented, too. It works as it does for Items.
99102
See <https://github.com/stac-api-extensions/fields> for details.
100-
101-
- Requirement class in *OGC API - Records*: n/a
102-
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields`

0 commit comments

Comments
 (0)