Skip to content

Commit bf79a94

Browse files
committed
Add q parameter #6, fix links #8, queryable clarifications #3, alignment #4
1 parent 474a5f6 commit bf79a94

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [STAC API - Core](https://github.com/radiantearth/stac-api-spec/blob/main/core)
1313
- [STAC API - Collections](https://github.com/radiantearth/stac-api-spec/tree/main/ogcapi-features)
1414
- [OGC API - Common - Part 2: Geospatial Data](https://portal.ogc.org/files/99149)
15-
- [OGC API - Records - Part 2: Collections](https://github.com/opengeospatial/ogcapi-records/tree/master/extensions/collections)
15+
- [OGC API - Records - Part 1: Local Resource Catalogue](https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalogue)
1616
- **Owner**: @m-mohr
1717

1818
A search endpoint provides the ability to query
@@ -25,11 +25,11 @@ The Collection Search endpoint by default doesn't provide any query parameters t
2525
additional behavior will be defined in [Extensions](#extensions). These extensions can be composed
2626
by an implementer to cover only the set of functionality the implementer requires.
2727

28-
This extension is based on *[OGC API - Common - Part 2: Geospatial Data](https://portal.ogc.org/files/99149#rc-simple-query-section)* and *[OGC API - Records - Part 2: Collections](https://github.com/opengeospatial/ogcapi-records/tree/master/extensions/collections)*
28+
This extension is based on *[OGC API - Common - Part 2: Geospatial Data](https://portal.ogc.org/files/99149#rc-simple-query-section)*
29+
and aligned to *[OGC API - Records - Part 1: Local Resource Catalogue](https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalogue)*
2930
and selectively implements a subset of their "requirements classes".
3031

31-
All functionality is only defined for `GET /collections` in *OGC API - Records - Part 2: Collections*.
32-
32+
All functionality in *OGC API - Records - Part 1: Local Resource Catalogue* is only defined for the `GET` method (i.e. `GET /collections`).
3333
*Note:* STAC may add behavior for `POST /collections` in the future, but due to a potential conflict
3434
with the Transaction Extension, specific rules for content negotiation might be required.
3535

@@ -44,29 +44,41 @@ for details.
4444
### Basics
4545

4646
A basic set of query parameters MUST be implemented.
47-
These are aligned with the corresponding parameters in STAC API - Features:
48-
- `bbox`
49-
- `datetime`
50-
- `limit`
47+
These are aligned with the corresponding parameters in STAC API - Features and OGC API - Records:
48+
- [`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`)
49+
- [`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`)
50+
- [`limit`](https://docs.ogc.org/DRAFTS/20-004.html#_parameter_limit)
5151

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

5454
### Extensions
5555

56+
#### Free text search
57+
58+
A free-text search parameter `q` based on OGC API - Records can be added.
59+
See <https://docs.ogc.org/DRAFTS/20-004.html#_parameter_q> for details.
60+
It is case-insensitive and matches the string given strictly.
61+
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`.
62+
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+
5666
#### Query (STACQL)
5767

5868
The query extension for STACQL support can be implemented, too. It works as it does for Items.
5969
See <https://github.com/stac-api-extensions/query> for details.
6070

61-
- Requirement class in *OGC API - Records - Part 2: Collections*: n/a
71+
- Requirement class in *OGC API - Records*: n/a
6272
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#query`
6373

6474
#### Filter (CQL)
6575

66-
The filter extension for CQL support can be implemented, too. It works as it does for Items.
76+
The filter extension for CQL support can be implemented, too.
6777
See <https://github.com/stac-api-extensions/filter> for details.
78+
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`).
79+
The path/endpoint for Collection Search queryables can be freely chosen, but SHOULD NOT conflict with `GET /queryables`.
6880

69-
- Requirement class in *OGC API - Records - Part 2: Collections*: CQL Filter
81+
- Requirement class in *OGC API - Records*: CQL Filter
7082
- Conformance classes:
7183
- `https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter`
7284
- `http://www.opengis.net/spec/ogcapi-records-1/1.0/req/cql-filter`
@@ -76,7 +88,7 @@ See <https://github.com/stac-api-extensions/filter> for details.
7688
The sort extension can be implemented, too. It works as it does for Items.
7789
See <https://github.com/stac-api-extensions/sort> for details.
7890

79-
- Requirement class in *OGC API - Records - Part 2: Collections*: Sorting
91+
- Requirement class in *OGC API - Records*: Sorting
8092
- Conformance classes:
8193
- `https://api.stacspec.org/v1.0.0-rc.1/collection-search#sort`
8294
- `http://www.opengis.net/spec/ogcapi-records-1/1.0/req/sorting`
@@ -86,13 +98,5 @@ See <https://github.com/stac-api-extensions/sort> for details.
8698
The fields extension can be implemented, too. It works as it does for Items.
8799
See <https://github.com/stac-api-extensions/fields> for details.
88100

89-
- Requirement class in *OGC API - Records - Part 2: Collections*: n/a
101+
- Requirement class in *OGC API - Records*: n/a
90102
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields`
91-
92-
#### Context
93-
94-
The context extension can be implemented, too. It works as it does for Items.
95-
See <https://github.com/stac-api-extensions/context> for details.
96-
97-
- Requirement class in *OGC API - Records - Part 2: Collections*: n/a
98-
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#context`

0 commit comments

Comments
 (0)