huanld/pygeoapi
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix list formatting in docs

Browse Source
This commit is contained in:
Tom Kralidis
2021-12-08 21:59:26 -05:00
parent eb891010b7
commit 05dfebd7e4
13 changed files with 168 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/data-publishing/ogcapi-coverages.rst
+16 -16
View File
@@ -84,22 +84,22 @@ The `xarray`_ provider plugin reads and extracts `NetCDF`_ and `Zarr`_ data.
Data access examples
--------------------
- list all collections
- http://localhost:5000/collections
- overview of dataset
- http://localhost:5000/collections/foo
- coverage rangetype
- http://localhost:5000/collections/foo/coverage/rangetype
- coverage domainset
- http://localhost:5000/collections/foo/coverage/domainset
- 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 range-subset
- http://localhost:5000/collections/foo/coverage?range-subset=1,3
- coverage access with subsetting
- http://localhost:5000/collections/foo/coverage?subset=lat(10,20)&subset=long(10,20)
* list all collections
* http://localhost:5000/collections
* overview of dataset
* http://localhost:5000/collections/foo
* coverage rangetype
* http://localhost:5000/collections/foo/coverage/rangetype
* coverage domainset
* http://localhost:5000/collections/foo/coverage/domainset
* 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 range-subset
* http://localhost:5000/collections/foo/coverage?range-subset=1,3
* coverage access with subsetting
* http://localhost:5000/collections/foo/coverage?subset=lat(10,20)&subset=long(10,20)
.. _`OGC API - Coverages`: https://github.com/opengeospatial/ogcapi-coverages
.. _`rasterio`: https://rasterio.readthedocs.io
docs/source/data-publishing/ogcapi-edr.rst
+10 -10
View File
@@ -64,16 +64,16 @@ The `xarray-edr`_ provider plugin reads and extracts `NetCDF`_ and `Zarr`_ data
Data access examples
--------------------
- list all collections
- http://localhost:5000/collections
- overview of dataset
- http://localhost:5000/collections/foo
- dataset position query
- http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)
- dataset position query for a specific parameter
- http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)&parameter-name=SST
- dataset position query for a specific parameter and time step
- http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)&parameter-name=SST&datetime=2000-01-16
* list all collections
* http://localhost:5000/collections
* overview of dataset
* http://localhost:5000/collections/foo
* dataset position query
* http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)
* dataset position query for a specific parameter
* http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)&parameter-name=SST
* dataset position query for a specific parameter and time step
* http://localhost:5000/collections/foo/position?coords=POINT(-75%2045)&parameter-name=SST&datetime=2000-01-16
.. _`xarray`: https://xarray.pydata.org
docs/source/data-publishing/ogcapi-features.rst
+26 -26
View File
@@ -76,8 +76,8 @@ Elasticsearch
To publish an Elasticsearch index, the following are required in your index:
- indexes must be documents of valid GeoJSON Features
- index mappings must define the GeoJSON ``geometry`` as a ``geo_shape``
* indexes must be documents of valid GeoJSON Features
* index mappings must define the GeoJSON ``geometry`` as a ``geo_shape``
.. code-block:: yaml
@@ -245,29 +245,29 @@ are included in the docker examples for SensorThings.
Data access examples
--------------------
- list all collections
- http://localhost:5000/collections
- overview of dataset
- http://localhost:5000/collections/foo
- queryables
- http://localhost:5000/collections/foo/queryables
- browse features
- http://localhost:5000/collections/foo/items
- paging
- http://localhost:5000/collections/foo/items?startIndex=10&limit=10
- CSV outputs
- http://localhost:5000/collections/foo/items?f=csv
- query features (spatial)
- http://localhost:5000/collections/foo/items?bbox=-180,-90,180,90
- query features (attribute)
- http://localhost:5000/collections/foo/items?propertyname=foo
- query features (temporal)
- http://localhost:5000/collections/foo/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/foo/items?datetime=2020-04-10T14:11:00Z&sortby=+datetime
- query features (temporal) and sort descending by a property
- http://localhost:5000/collections/foo/items?datetime=2020-04-10T14:11:00Z&sortby=-datetime
- fetch a specific feature
- http://localhost:5000/collections/foo/items/123
* list all collections
* http://localhost:5000/collections
* overview of dataset
* http://localhost:5000/collections/foo
* queryables
* http://localhost:5000/collections/foo/queryables
* browse features
* http://localhost:5000/collections/foo/items
* paging
* http://localhost:5000/collections/foo/items?startIndex=10&limit=10
* CSV outputs
* http://localhost:5000/collections/foo/items?f=csv
* query features (spatial)
* http://localhost:5000/collections/foo/items?bbox=-180,-90,180,90
* query features (attribute)
* http://localhost:5000/collections/foo/items?propertyname=foo
* query features (temporal)
* http://localhost:5000/collections/foo/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/foo/items?datetime=2020-04-10T14:11:00Z&sortby=+datetime
* query features (temporal) and sort descending by a property
* http://localhost:5000/collections/foo/items?datetime=2020-04-10T14:11:00Z&sortby=-datetime
* fetch a specific feature
* http://localhost:5000/collections/foo/items/123
.. _`OGC API - Features`: https://www.ogc.org/standards/ogcapi-features
docs/source/data-publishing/ogcapi-processes.rst
+16 -16
View File
@@ -52,26 +52,26 @@ Putting it all together
To summarize how pygeoapi processes and managers work together::
- process plugins implement the core processing / workflow functionality
- manager plugins control and manage how processes are executed
* process plugins implement the core processing / workflow functionality
* manager plugins control and manage how processes are executed
Processing examples
-------------------
- list all processes
- http://localhost:5000/processes
- describe the ``hello-world`` process
- http://localhost:5000/processes/hello-world
- show all jobs for the ``hello-world`` process
- http://localhost:5000/processes/hello-world/jobs
- execute a job for the ``hello-world`` process
- ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"}}"``
- execute a job for the ``hello-world`` process with a raw response (default)
- ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"}}"``
- execute a job for the ``hello-world`` process with a response document
- ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"},\"response\":\"document\"}"``
- execute a job for the ``hello-world`` process in asynchronous mode
- ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"mode\": \"async\", \"inputs\":{\"name\": \"hi there2\"}}"``
* list all processes
* http://localhost:5000/processes
* describe the ``hello-world`` process
* http://localhost:5000/processes/hello-world
* show all jobs for the ``hello-world`` process
* http://localhost:5000/processes/hello-world/jobs
* execute a job for the ``hello-world`` process
* ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"}}"``
* execute a job for the ``hello-world`` process with a raw response (default)
* ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"}}"``
* execute a job for the ``hello-world`` process with a response document
* ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"inputs\":{\"name\": \"hi there2\"},\"response\":\"document\"}"``
* execute a job for the ``hello-world`` process in asynchronous mode
* ``curl -X POST "http://localhost:5000/processes/hello-world/execution" -H "Content-Type: application/json" -d "{\"mode\": \"async\", \"inputs\":{\"name\": \"hi there2\"}}"``
.. todo:: add more examples once OAProc implementation is complete
docs/source/data-publishing/ogcapi-records.rst
+25 -25
View File
@@ -36,8 +36,8 @@ ElasticsearchCatalogue
To publish an Elasticsearch index, the following are required in your index:
- indexes must be documents of valid `OGC API - Records GeoJSON Features`_
- index mappings must define the GeoJSON ``geometry`` as a ``geo_shape``
* indexes must be documents of valid `OGC API - Records GeoJSON Features`_
* index mappings must define the GeoJSON ``geometry`` as a ``geo_shape``
.. code-block:: yaml
@@ -57,7 +57,7 @@ TinyDBCatalogue
To publish a TinyDB index, the following are required in your index:
- indexes must be documents of valid `OGC API - Records GeoJSON Features`_
* indexes must be documents of valid `OGC API - Records GeoJSON Features`_
.. code-block:: yaml
@@ -72,28 +72,28 @@ To publish a TinyDB index, the following are required in your index:
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?startIndex=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
* 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?startIndex=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
.. _`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
docs/source/data-publishing/ogcapi-tiles.rst
+12 -12
View File
@@ -11,8 +11,8 @@ object storage). To integrate tiles from a local data source, it is assumed
that a directory tree of static tiles has been created on disk. Examples of
tile generation software include (but are not limited to):
- `MapProxy`_
- `tippecanoe`_
* `MapProxy`_
* `tippecanoe`_
Providers
---------
@@ -58,16 +58,16 @@ The MVT provider plugin provides access to `Mapbox Vector Tiles`_.
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>`_
* 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
docs/source/data-publishing/stac.rst
+2 -2
View File
@@ -51,8 +51,8 @@ ESRI Shapefile publishing requires to specify all required component file extens
Data access examples
--------------------
- STAC root page
- http://localhost:5000/stac
* STAC root page
* http://localhost:5000/stac
From here, browse the filesystem accordingly.