Skip to content

Commit

Permalink
Fix bullet points in docs (#1709)
Browse files Browse the repository at this point in the history
  • Loading branch information
C-Loftus authored Jul 4, 2024
1 parent cd066a0 commit bcc5b79
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/data-publishing/ogcapi-coverages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
22 changes: 22 additions & 0 deletions docs/source/data-publishing/ogcapi-records.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions docs/source/data-publishing/ogcapi-tiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt>`_



.. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles
Expand Down
1 change: 1 addition & 0 deletions docs/source/data-publishing/stac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Data access examples
--------------------

* STAC root page

* http://localhost:5000/stac

From here, browse the filesystem accordingly.
Expand Down
4 changes: 4 additions & 0 deletions docs/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bcc5b79

Please sign in to comment.