Skip to content

Commit 9b9ed04

Browse files
authored
Merge pull request #3 from stac-api-extensions/pv/add-query-vs-filter-language
add query vs. filter language
2 parents b468fb3 + 52a303b commit 9b9ed04

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,22 @@
99
- [Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/ogcapi-features)
1010
- [Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/item-search)
1111

12-
The `query` parameter adds additional filters for searching on the properties of Item objects. The JSON syntax for
12+
The Query Extension adds a `query` parameter that allows additional filtering based on the properties of Item objects. The JSON syntax for
1313
these filters is known as "STACQL" (pronounced `stack-cue-el`).
1414

15-
The syntax for the `query` filter is:
15+
It is recommended to implement the [Filter Extension](https://github.com/stac-api-extensions/filter)
16+
instead of the Query Extension. Filter Extension is more well-defined, more expressive, and
17+
uses the standardized CQL2 query language instead of the proprietary language defined here.
18+
There is no plan to deprecate this extension, but it is also unlikely to see any further
19+
refinement or changes.
1620

17-
```js
21+
The extension can be applied to either the **STAC API - Item Search** endpoint `/search`
22+
(advertised with the conformance class <https://api.stacspec.org/v1.0.0-rc.1/item-search#query>) or to the
23+
**STAC API - Features** endpoint `/collections/{collection_id}/items` (advertised with the conformance class <https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#query>)
24+
25+
The syntax for the `query` parameter is:
26+
27+
```json
1828
{
1929
"query": {
2030
"<property_name>": {

0 commit comments

Comments
 (0)