Skip to content

Commit 6a401f3

Browse files
committed
docs: add section on query filter
1 parent 5b84424 commit 6a401f3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/usage.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,22 @@ by finding links with a ``"rel"`` type of ``"next"`` and parsing them to constru
168168
implementation of this ``"next"`` link parsing assumes that the link follows the spec for an extended STAC link as
169169
described in the `STAC API - Item Search: Paging <https://github.com/radiantearth/stac-api-spec/tree/master/item-search#paging>`__
170170
section. See the :mod:`Paging <pystac_client.paging>` docs for details on how to customize this behavior.
171+
172+
Query Filter
173+
------------
174+
175+
If the server supports the [query filter](https://github.com/radiantearth/stac-api-spec/tree/master/fragments/query)
176+
arbitrary Item properties can be included in the search parameters. The query parameter to :class:`ItemSearch` accepts
177+
a JSON structure as in the STAC API spec, but also accepts an abbreviated syntax. Instead of JSON, a list of strings can
178+
be provided, in which case pystac-client will convert them to the equivalent JSON structure.
179+
180+
The syntax is simply:
181+
182+
```
183+
<property><operator><value>
184+
e.g.,
185+
186+
eo:cloud_cover<10
187+
view:off_nadir<50
188+
platform=landsat-8
189+
```

0 commit comments

Comments
 (0)