Skip to content

Commit bcc5b79

Browse files
authored
Fix bullet points in docs (#1709)
1 parent cd066a0 commit bcc5b79

5 files changed

Lines changed: 55 additions & 0 deletions

File tree

docs/source/data-publishing/ogcapi-coverages.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,23 +100,41 @@ Data access examples
100100
--------------------
101101

102102
* list all collections
103+
103104
* http://localhost:5000/collections
105+
104106
* overview of dataset
107+
105108
* http://localhost:5000/collections/foo
109+
106110
* schema of dataset
111+
107112
* http://localhost:5000/collections/foo/schema
113+
108114
* coverage access via CoverageJSON (default)
115+
109116
* http://localhost:5000/collections/foo/coverage?f=json
117+
110118
* coverage access via native format (as defined in ``provider.format.name``)
119+
111120
* http://localhost:5000/collections/foo/coverage?f=GRIB
121+
112122
* coverage access with comma-separated properties
123+
113124
* http://localhost:5000/collections/foo/coverage?properties=1,3
125+
114126
* coverage access with subsetting
127+
115128
* http://localhost:5000/collections/foo/coverage?subset=lat(10:20)&subset=long(10:20)
129+
116130
* coverage with bbox
131+
117132
* http://localhost:5000/collections/foo/coverage?bbox=10,10,20,20
133+
118134
* coverage with bbox and bbox CRS
135+
119136
* http://localhost:5000/collections/foo/coverage?bbox=-8794239.772668611,5311971.846945471,-8348961.809495518,5621521.486192066&bbox=crs=3857
137+
120138

121139
.. note::
122140
``.../coverage`` queries which return an alternative representation to CoverageJSON (which prompt a download)

docs/source/data-publishing/ogcapi-records.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,27 +100,49 @@ Metadata search examples
100100
------------------------
101101

102102
* overview of record collection
103+
103104
* http://localhost:5000/collections/metadata-records
105+
104106
* queryables
107+
105108
* http://localhost:5000/collections/foo/queryables
109+
106110
* browse records
111+
107112
* http://localhost:5000/collections/foo/items
113+
108114
* paging
115+
109116
* http://localhost:5000/collections/foo/items?offset=10&limit=10
117+
110118
* CSV outputs
119+
111120
* http://localhost:5000/collections/foo/items?f=csv
121+
112122
* query records (spatial)
123+
113124
* http://localhost:5000/collections/foo/items?bbox=-180,-90,180,90
125+
114126
* query records (attribute)
127+
115128
* http://localhost:5000/collections/foo/items?propertyname=foo
129+
116130
* query records (temporal)
131+
117132
* http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z
133+
118134
* query features (temporal) and sort ascending by a property (if no +/- indicated, + is assumed)
135+
119136
* http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=datetime
137+
120138
* query features (temporal) and sort descending by a property
139+
121140
* http://localhost:5000/collections/my-metadata/items?datetime=2020-04-10T14:11:00Z&sortby=-datetime
141+
122142
* fetch a specific record
143+
123144
* http://localhost:5000/collections/my-metadata/items/123
145+
124146

125147
.. note::
126148
provider `id_field` values support slashes (i.e. ``my/cool/identifier``). The client request would then

docs/source/data-publishing/ogcapi-tiles.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,15 +162,25 @@ Data access examples
162162
--------------------
163163

164164
* list all collections
165+
165166
* http://localhost:5000/collections
167+
166168
* overview of dataset
169+
167170
* http://localhost:5000/collections/foo
171+
168172
* overview of dataset tiles
173+
169174
* http://localhost:5000/collections/foo/tiles
175+
170176
* tile matrix metadata
177+
171178
* http://localhost:5000/collections/lakes/tiles/WorldCRS84Quad/metadata
179+
172180
* tiles URI template
181+
173182
* `http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt <http://localhost:5000/collections/lakes/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}?f=mvt>`_
183+
174184

175185

176186
.. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles

docs/source/data-publishing/stac.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Data access examples
6666
--------------------
6767

6868
* STAC root page
69+
6970
* http://localhost:5000/stac
7071

7172
From here, browse the filesystem accordingly.

docs/source/introduction.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,19 @@ Features
1010

1111
* out of the box modern OGC API server
1212
* certified OGC Compliant and Reference Implementation
13+
1314
* OGC API - Features
1415
* OGC API - Environmental Data Retrieval
1516
* OGC API - Tiles
17+
1618
* additionally implements
19+
1720
* OGC API - Coverages
1821
* OGC API - Maps
1922
* OGC API - Processes
2023
* OGC API - Records
2124
* SpatioTemporal Asset Library
25+
2226
* out of the box data provider plugins for rasterio, GDAL/OGR, Elasticsearch, PostgreSQL/PostGIS
2327
* easy to use OpenAPI / Swagger documentation for developers
2428
* supports JSON, GeoJSON, HTML and CSV output

0 commit comments

Comments
 (0)