Skip to content

Commit 8ab2a2d

Browse files
committed
Clarify POST in free-text search
1 parent d275820 commit 8ab2a2d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,16 @@ These are aligned with the corresponding parameters in STAC API - Features and O
6464

6565
- Conformance class: `https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text`
6666

67-
A free-text search parameter `q` based on OGC API - Records can be added.
67+
A basic free-text search parameter `q` based on OGC API - Records can be added.
6868
See <https://docs.ogc.org/DRAFTS/20-004.html#_parameter_q> for details.
69+
6970
The specific set of text fields 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`.
7071

71-
The search works case-insensitive. Any of the search terms must be present in the set of text fields. The operator is OR and all search terms must be delimited by a comma. Spaces have no special meaning. So if you want to search for "Earth Observation" or "EO", your query parameter should be as follows: `q=EO,Earth Observation`.
72+
The search works case-insensitive and spaces have no special meaning.
73+
Any of the search terms must be present in the set of text fields (OR operaror).
74+
75+
- In HTTP `GET` requests, all search terms must be separated by a comma. For example, if you want to search for "Earth Observation" or "EO", your query parameter should be as follows: `q=EO,Earth Observation`.
76+
- In HTTP `POST` requests, an array of search terms must be provided, for example: `{"q": ["EO", "Earth Observation"]}`.
7277

7378
#### Filter (CQL)
7479

0 commit comments

Comments
 (0)