Skip to content

Commit f309a1f

Browse files
committed
update docs
1 parent c42a3d7 commit f309a1f

File tree

1 file changed

+55
-3
lines changed

1 file changed

+55
-3
lines changed

docs/src/endpoints.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,11 +226,65 @@ curl http://127.0.0.1:8081/collections/public.countries | jq
226226
Ref: https://docs.ogc.org/is/17-069r4/17-069r4.html#_collection_
227227

228228

229+
## Feature Collection's Queryables
230+
231+
Path: `/collections/{collectionId}/queryables`
232+
233+
PathParams:
234+
235+
- **collectionId** (str): Feature Collection Id
236+
237+
QueryParams:
238+
239+
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
240+
241+
HeaderParams:
242+
243+
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
244+
245+
Example:
246+
247+
```json
248+
curl http://127.0.0.1:8081/collections/public.landsat_wrs/queryables | jq
249+
{
250+
"title": "public.landsat_wrs",
251+
"properties": {
252+
"geom": {
253+
"$ref": "https://geojson.org/schema/Geometry.json"
254+
},
255+
"ogc_fid": {
256+
"name": "ogc_fid",
257+
"type": "number"
258+
},
259+
"id": {
260+
"name": "id",
261+
"type": "string"
262+
},
263+
"pr": {
264+
"name": "pr",
265+
"type": "string"
266+
},
267+
"path": {
268+
"name": "path",
269+
"type": "number"
270+
},
271+
"row": {
272+
"name": "row",
273+
"type": "number"
274+
}
275+
},
276+
"type": "object",
277+
"$schema": "https://json-schema.org/draft/2019-09/schema",
278+
"$id": "http://127.0.0.1:8081/collections/public.landsat_wrs/queryables"
279+
}
280+
```
281+
282+
Ref: http://docs.ogc.org/DRAFTS/19-079r1.html#filter-queryables
283+
229284
## Features
230285

231286
Path: `/collections/{collectionId}/items`
232287

233-
234288
PathParams:
235289

236290
- **collectionId** (str): Feature Collection Id
@@ -261,7 +315,6 @@ HeaderParams:
261315

262316
\* **Not in OGC API Features Specification**
263317

264-
265318
!!! Important
266319
Additional query-parameters (form `PROP=VALUE`) will be considered as a **property filter**.
267320

@@ -292,7 +345,6 @@ Ref: https://docs.ogc.org/is/17-069r4/17-069r4.html#_items_ and https://docs.ogc
292345

293346
Path: `/collections/{collectionId}/items/{itemId}`
294347

295-
296348
PathParams:
297349

298350
- **collectionId** (str): Feature Collection Id

0 commit comments

Comments
 (0)