Skip to content

Commit b2fbcd5

Browse files
committed
Add overview table for queryables
1 parent e2b04b2 commit b2fbcd5

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,18 @@ not compliant with this extension.
286286
## Queryables
287287

288288
The Queryables mechanism allows a client to discover what terms are available for use when
289-
writing filter expressions. These terms are defined both over the entire catalog
290-
(at `/queryables`) and per collection (at `/collections/{collectionId}/queryables`).
289+
writing filter expressions. These terms are defined for Items over the entire catalog
290+
(at `/queryables`), per collection (at `/collections/{collectionId}/queryables`), and for Collections at a separate but unnamed endpoint.
291+
292+
| Queryables Endpoint | Endpoint linking to the Queryables Endpoint | Applicable `filter` endpoints |
293+
| ----------------------------------------------------------- | ------------------------------------------- | --------------------------------------- |
294+
| `GET /queryables` | `GET /` | `GET /search` and `POST /search` |
295+
| `GET /collections/{collectionId}/queryables` | `GET /collections/{collectionId}` | `GET /collections/{collectionId}/items` |
296+
| `GET /...` (*Endpoint name to be chosen by implementation*) | `GET /collections` | `GET /collections` |
297+
298+
The Queryables endpoint is provided via a link in a specific endpoint.
299+
The Queryables endpoints SHALL be referenced with a link with the link relation type `http://www.opengis.net/def/rel/ogc/1.0/sortables`.
300+
291301
The decision as to which queryables to define for the entire catalog is at the discretion
292302
of the implementer, and can be anywhere between none and the union of all
293303
queryables across all collections.

0 commit comments

Comments
 (0)