Skip to content

Commit 9fe5f01

Browse files
vincentsaragovincentsarago
committed
update docs
1 parent 70f80b5 commit 9fe5f01

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

‎docs/src/endpoints.md‎

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Path: `/`
66

77
QueryParams:
88

9-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
9+
- **f** (str, one of [`json`, `html`]): Select response MediaType.
1010

1111
HeaderParams:
1212

13-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
13+
- **accept** (str, one of [`application/json`, `text/html`]): Select response MediaType.
1414

1515
Example:
1616

@@ -25,17 +25,11 @@ curl http://127.0.0.1:8081 | jq
2525
"type": "application/json",
2626
"title": "Landing Page"
2727
},
28-
{
29-
"href": "http://127.0.0.1:8081/?f=html",
30-
"rel": "alternate",
31-
"type": "text/html",
32-
"title": "HTML Landing Page"
33-
},
3428
{
3529
"href": "http://127.0.0.1:8081/api",
3630
"rel": "service-desc",
3731
"type": "application/vnd.oai.openapi+json;version=3.0",
38-
"title": "the API definition"
32+
"title": "the API definition (JSON)"
3933
},
4034
{
4135
"href": "http://127.0.0.1:8081/api.html",
@@ -91,11 +85,11 @@ Path: `/conformance`
9185

9286
QueryParams:
9387

94-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
88+
- **f** (str, one of [`json`, `html`]): Select response MediaType.
9589

9690
HeaderParams:
9791

98-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
92+
- **accept** (str, one of [`application/json`, `text/html`])): Select response MediaType.
9993

10094
Example:
10195

@@ -128,11 +122,11 @@ Path: `/collections`
128122

129123
QueryParams:
130124

131-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
125+
- **f** (str, one of [`json`, `html`]): Select response MediaType.
132126

133127
HeaderParams:
134128

135-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
129+
- **accept** (str, one of [`application/json`, `text/html`])): Select response MediaType.
136130

137131
Example:
138132

@@ -177,11 +171,6 @@ curl http://127.0.0.1:8081/collections | jq
177171
"href": "http://127.0.0.1:8081/collections",
178172
"rel": "self",
179173
"type": "application/json"
180-
},
181-
{
182-
"href": "http://127.0.0.1:8081/collections?f=html",
183-
"rel": "alternate",
184-
"type": "text/html"
185174
}
186175
]
187176
}
@@ -199,11 +188,11 @@ PathParams:
199188

200189
QueryParams:
201190

202-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
191+
- **f** (str, one of [`json`, `html`]): Select response MediaType.
203192

204193
HeaderParams:
205194

206-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
195+
- **accept** (str, one of [`application/json`, `text/html`])): Select response MediaType.
207196

208197
Example:
209198

@@ -218,19 +207,28 @@ curl http://127.0.0.1:8081/collections/public.countries | jq
218207
"type": "application/json"
219208
},
220209
{
221-
"href": "http://127.0.0.1:8081/collections/public.countries?f=html",
210+
"href": "http://127.0.0.1:8081/collections/public.countries/items",
211+
"rel": "items",
212+
"type": "application/geo+json",
213+
"title": "Items"
214+
},
215+
{
216+
"href": "http://127.0.0.1:8081/collections/public.countries/items?f=csv",
222217
"rel": "alternate",
223-
"type": "text/html"
218+
"type": "text/csv",
219+
"title": "Items (CSV)"
224220
},
225221
{
226-
"href": "http://127.0.0.1:8081/collections/public.countries/items",
227-
"rel": "items",
228-
"type": "application/geo+json"
222+
"href": "http://127.0.0.1:8081/collections/public.countries/items?f=geojsonseq",
223+
"rel": "alternate",
224+
"type": "application/geo+json-seq",
225+
"title": "Items (GeoJSONSeq)"
229226
},
230227
{
231228
"href": "http://127.0.0.1:8081/collections/public.countries/queryables",
232229
"rel": "queryables",
233-
"type": "application/schema+json"
230+
"type": "application/schema+json",
231+
"title": "Queryables"
234232
}
235233
],
236234
"itemType": "feature",
@@ -253,11 +251,11 @@ PathParams:
253251

254252
QueryParams:
255253

256-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
254+
- **f** (str, one of [`json`, `html`]): Select response MediaType.
257255

258256
HeaderParams:
259257

260-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
258+
- **accept** (str, one of [`application/json`, `text/html`])): Select response MediaType.
261259

262260
Example:
263261

@@ -324,11 +322,14 @@ QueryParams:
324322
- **filter-lang** (str, one of [`cql2-text`, `cql2-json`]): `Filter` language. Defaults to `cql2-text`.
325323
- **geom-column** * (str): Select geometry column to apply filter on and to create geometry from.
326324
- **datetime-column** * (str): Select datetime column to apply filter on.
327-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
325+
- **bbox-only** * (bool): Only return the bounding box of the feature.
326+
- **simplify** * (float): Simplify the output geometry to given threshold in decimal degrees.
327+
328+
- **f** (str, one of [`geojson`, `html`, `json`, `csv`, `geojsonseq`, `ndjson`]): Select response MediaType.
328329

329330
HeaderParams:
330331

331-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
332+
- **accept** (str, one of [`application/geo+json`, `text/html`, `application/json`, `text/csv`, `application/geo+json-seq`, `application/ndjson`])): Select response MediaType.
332333

333334
\* **Not in OGC API Features Specification**
334335

@@ -343,7 +344,10 @@ Example:
343344
- `http://127.0.0.1:8081/collections/public.countries/items?bbox=-94.702148,34.488448,-85.429688,41.112469` *limit result to a specific bbox*.
344345
- `http://127.0.0.1:8081/collections/public.countries/items?ids=1,2,3` *limit result to ids `1`, `2` and `3`*
345346
- `http://127.0.0.1:8081/collections/public.countries/items?properties=name` *only return `name` property*
346-
- `http://127.0.0.1:8081/collections/public.countries/items?name=Zimbabwe` *only return features where property `name==Zimbabwe`*
347+
348+
349+
- Property Filter
350+
- `http://127.0.0.1:8081/collections/public.countries/items?name=Zimbabwe` *only return features where property `name==Zimbabwe`*
347351

348352
- Datetime
349353
- `http://127.0.0.1:8081/collections/public.countries/items?datetime=2004-10-19T10:23:54Z` *return features with datetime column with value `==2004-10-19T10:23:54Z`*.
@@ -369,11 +373,11 @@ PathParams:
369373

370374
QueryParams:
371375

372-
- **f** (str, one of [`geojson`, `json`, `html`]): Select response MediaType.
376+
- **f** (str, one of [`geojson`, `html`, `json`]): Select response MediaType.
373377

374378
HeaderParams:
375379

376-
- **accept** (str, one of [`application/geo+json`, `application/json`, `text/html`])): Select response MediaType.
380+
- **accept** (str, one of [`application/geo+json`, `text/html`, `application/json`])): Select response MediaType.
377381

378382
Example:
379383

0 commit comments

Comments
 (0)