diff --git a/docs/source/data-publishing/ogcapi-coverages.rst b/docs/source/data-publishing/ogcapi-coverages.rst index 2c69d87..6e06b2e 100644 --- a/docs/source/data-publishing/ogcapi-coverages.rst +++ b/docs/source/data-publishing/ogcapi-coverages.rst @@ -100,23 +100,41 @@ Data access examples -------------------- * list all collections + * http://localhost:5000/collections + * overview of dataset + * http://localhost:5000/collections/foo + * schema of dataset + * http://localhost:5000/collections/foo/schema + * coverage access via CoverageJSON (default) + * http://localhost:5000/collections/foo/coverage?f=json + * coverage access via native format (as defined in ``provider.format.name``) + * http://localhost:5000/collections/foo/coverage?f=GRIB + * coverage access with comma-separated properties + * http://localhost:5000/collections/foo/coverage?properties=1,3 + * coverage access with subsetting + * http://localhost:5000/collections/foo/coverage?subset=lat(10:20)&subset=long(10:20) + * coverage with bbox + * http://localhost:5000/collections/foo/coverage?bbox=10,10,20,20 + * coverage with bbox and bbox CRS + * http://localhost:5000/collections/foo/coverage?bbox=-8794239.772668611,5311971.846945471,-8348961.809495518,5621521.486192066&bbox=crs=3857 + .. note:: ``.../coverage`` queries which return an alternative representation to CoverageJSON (which prompt a download) diff --git a/docs/source/data-publishing/ogcapi-records.rst b/docs/source/data-publishing/ogcapi-records.rst index 73fbf23..5f550da 100644 --- a/docs/source/data-publishing/ogcapi-records.rst +++ b/docs/source/data-publishing/ogcapi-records.rst @@ -100,27 +100,49 @@ Metadata search examples ------------------------ * overview of record collection + * http://localhost:5000/collections/metadata-records + * queryables + * http://localhost:5000/collections/foo/queryables + * browse records + * http://localhost:5000/collections/foo/items + * paging + * http://localhost:5000/collections/foo/items?offset=10&limit=10 + * CSV outputs + * http://localhost:5000/collections/foo/items?f=csv + * query records (spatial) + * http://localhost:5000/collections/foo/items?bbox=-180,-90,180,90 + * query records (attribute) + * http://localhost:5000/collections/foo/items?propertyname=foo + * query records (temporal) + * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z + * query features (temporal) and sort ascending by a property (if no +/- indicated, + is assumed) + * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=datetime + * query features (temporal) and sort descending by a property + * http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=-datetime + * 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 diff --git a/docs/source/data-publishing/ogcapi-tiles.rst b/docs/source/data-publishing/ogcapi-tiles.rst index c4d5b2f..a06e173 100644 --- a/docs/source/data-publishing/ogcapi-tiles.rst +++ b/docs/source/data-publishing/ogcapi-tiles.rst @@ -162,15 +162,25 @@ Data access examples -------------------- * list all collections + * http://localhost:5000/collections + * overview of dataset + * http://localhost:5000/collections/foo + * overview of dataset tiles + * http://localhost:5000/collections/foo/tiles + * tile matrix metadata + * http://localhost:5000/collections/lakes/tiles/WorldCRS84Quad/metadata + * tiles URI template + * `http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt `_ + .. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles diff --git a/docs/source/data-publishing/stac.rst b/docs/source/data-publishing/stac.rst index 45cd2c2..84f0c74 100644 --- a/docs/source/data-publishing/stac.rst +++ b/docs/source/data-publishing/stac.rst @@ -66,6 +66,7 @@ Data access examples -------------------- * STAC root page + * http://localhost:5000/stac From here, browse the filesystem accordingly. diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 048090d..a98b218 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -10,15 +10,19 @@ Features * out of the box modern OGC API server * certified OGC Compliant and Reference Implementation + * OGC API - Features * OGC API - Environmental Data Retrieval * OGC API - Tiles + * additionally implements + * OGC API - Coverages * OGC API - Maps * OGC API - Processes * OGC API - Records * SpatioTemporal Asset Library + * out of the box data provider plugins for rasterio, GDAL/OGR, Elasticsearch, PostgreSQL/PostGIS * easy to use OpenAPI / Swagger documentation for developers * supports JSON, GeoJSON, HTML and CSV output