From f26582e4cec8a1baa3a17ccfa259abc79fd648a7 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Mon, 23 Jan 2023 09:28:05 -0500 Subject: [PATCH] add examples in docs --- docs/source/data-publishing/ogcapi-features.rst | 4 ++++ docs/source/data-publishing/ogcapi-records.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/source/data-publishing/ogcapi-features.rst b/docs/source/data-publishing/ogcapi-features.rst index 832f12b..4dba61a 100644 --- a/docs/source/data-publishing/ogcapi-features.rst +++ b/docs/source/data-publishing/ogcapi-features.rst @@ -378,4 +378,8 @@ Data access examples ``.../items`` queries which return an alternative representation to GeoJSON (which prompt a download) will have the response filename matching the collection name and appropriate file extension (e.g. ``my-dataset.csv``) +.. note:: + provider `id_field` values support slashes (i.e. ``my/cool/identifier``). The client request would then + be responsible for encoding the identifier accordingly (i.e. ``http://localhost:5000/collections/foo/items/my%2Fcool%2Fidentifier``) + .. _`OGC API - Features`: https://www.ogc.org/standards/ogcapi-features diff --git a/docs/source/data-publishing/ogcapi-records.rst b/docs/source/data-publishing/ogcapi-records.rst index 9f059f9..caf134c 100644 --- a/docs/source/data-publishing/ogcapi-records.rst +++ b/docs/source/data-publishing/ogcapi-records.rst @@ -96,5 +96,9 @@ Metadata search examples * fetch a specific record * http://localhost:5000/collections/my-metadata/items/123 +.. note:: + provider `id_field` values support slashes (i.e. ``my/cool/identifier``). The client request would then + be responsible for encoding the identifier accordingly (i.e. ``http://localhost:5000/collections/my-metadata/items/my%2Fcool%2Fidentifier``) + .. _`OGC API - Records`: https://www.ogc.org/standards/ogcapi-records .. _`OGC API - Records GeoJSON Features`: https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/schemas/recordGeoJSON.yaml