Skip to content

Commit

Permalink
openapi: Synchronization with Common
Browse files Browse the repository at this point in the history
- Also updated example conformance declaration, coverage links
  • Loading branch information
jerstlouis committed Jun 26, 2024
1 parent 6eabd9e commit 2a23e67
Show file tree
Hide file tree
Showing 26 changed files with 264 additions and 322 deletions.
249 changes: 106 additions & 143 deletions standard/openapi/ogcapi-coverages-1.bundled.json

Large diffs are not rendered by default.

28 changes: 10 additions & 18 deletions standard/openapi/ogcapi-coverages-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ components:
# Common - Geospatial Data
collections:
$ref: 'schemas/common-geodata/collections.yaml'
collectionInfo:
$ref: 'schemas/common-geodata/collectionInfo.yaml'
collectionDesc:
$ref: 'schemas/common-geodata/collectionDesc.yaml'
extent:
$ref: 'schemas/common-geodata/extent.yaml'
extent-uad:
Expand All @@ -106,12 +106,6 @@ components:
schema:
$ref: 'schemas/tms/propertiesSchema.yaml'

# Coverages - Core (this adds `orderedAxes`, which could possibly be defined in Common as well?)
coverages:
$ref: 'schemas/coverages-core/coverages.yaml'
coverageInfo:
$ref: 'schemas/coverages-core/coverageInfo.yaml'

# CIS
coverageSchema:
$ref: 'schemas/cis/coverage-schema.yaml'
Expand Down Expand Up @@ -151,19 +145,9 @@ components:
$ref: 'parameters/common-geodata/collectionId-coverage.yaml'
datetime:
$ref: 'parameters/common-geodata/datetime.yaml'
subset:
$ref: 'parameters/common-geodata/subset.yaml'
bbox:
$ref: 'parameters/common-geodata/bbox.yaml'

# Common - CRS
crs:
$ref: 'parameters/common-crs/crs.yaml'
subset-crs:
$ref: 'parameters/common-crs/subset-crs.yaml'
bbox-crs:
$ref: 'parameters/common-crs/bbox-crs.yaml'

# Coverages - Core
sceneId:
$ref: 'parameters/coverages-core/sceneId.yaml'
Expand All @@ -179,6 +163,14 @@ components:
$ref: 'parameters/coverages-core/width.yaml'
height:
$ref: 'parameters/coverages-core/height.yaml'
subset:
$ref: 'parameters/coverages-core/subset.yaml'
crs:
$ref: 'parameters/coverages-core/crs.yaml'
subset-crs:
$ref: 'parameters/coverages-core/subset-crs.yaml'
bbox-crs:
$ref: 'parameters/coverages-core/bbox-crs.yaml'

# Coverages - Core (unspecified)
f-coverage:
Expand Down
25 changes: 14 additions & 11 deletions standard/openapi/parameters/common-geodata/bbox.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: bbox
in: query
description: >-
Only features that have a geometry that intersects the bounding box are selected.
Only resources that have a geometry that intersects the bounding box are selected.
The bounding box is provided as four or six numbers, depending on whether the
coordinate reference system includes a vertical axis (height or depth):
coordinate reference system includes a vertical axis (elevation or depth):
* Lower left corner, coordinate axis 1
* Lower left corner, coordinate axis 2
Expand All @@ -12,20 +12,24 @@ description: >-
* Upper right corner, coordinate axis 2
* Maximum value, coordinate axis 3 (optional)
The coordinate reference system of the values is WGS 84 longitude/latitude
(http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate
reference system is specified in the parameter `bbox-crs`.
If the value consists of four numbers, the coordinate reference system is
WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)
unless a different coordinate reference system is specified in the parameter `bbox-crs`.
For WGS 84 longitude/latitude the values are in most cases the sequence of
If the value consists of six numbers, the coordinate reference system is WGS 84
longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h)
unless a different coordinate reference system is specified in a parameter `bbox-crs`.
For WGS84 longitude/latitude the values are in most cases the sequence of
minimum longitude, minimum latitude, maximum longitude and maximum latitude.
However, in cases where the box spans the antimeridian the first value
(west-most box edge) is larger than the third value (east-most box edge).
If the vertical axis is included, the third and the sixth number are
the bottom and the top of the 3-dimensional bounding box.
If the vertical axis is included, the third and the sixth number are the
bottom and the top of the 3-dimensional bounding box.
If a feature has multiple spatial geometry properties, it is the decision of the
server whether only a single spatial geometry property is used to determine
If a resource has multiple spatial geometry properties, it is the decision of the server
whether only a single spatial geometry property is used to determine
the extent or all relevant geometries.
required: false
schema:
Expand All @@ -37,6 +41,5 @@ schema:
maxItems: 6
items:
type: number
format: double
style: form
explode: false
10 changes: 6 additions & 4 deletions standard/openapi/parameters/common-geodata/datetime.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
name: datetime
in: query
description: |-
Either a date-time or an interval, half-bounded or bounded. Date and time expressions
adhere to RFC 3339. Half-bounded intervals are expressed using double-dots.
description: >-
Either a date-time or an interval. Date and time expressions
adhere to RFC 3339, section 5.6. Intervals may be bounded or half-bounded (double-dots at start or end).
Server implementations may or may not support times expressed using time offsets from UTC, but need to support
UTC time with the notation ending with a Z.
Examples:
* A date-time: "2018-02-12T23:20:50Z"
* A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
* Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
Only features that have a temporal property that intersects the value of
Only resources that have a temporal property that intersects the value of
`datetime` are selected.
If a feature has multiple temporal properties, it is the decision of the
Expand Down
8 changes: 4 additions & 4 deletions standard/openapi/paths/coverages-core/pCoverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ get:
operationId: getCoverage
parameters:
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml'
- $ref: '../../parameters/common-geodata/subset.yaml'
- $ref: '../../parameters/coverages-core/subset.yaml'
- $ref: '../../parameters/common-geodata/bbox.yaml'
- $ref: '../../parameters/common-geodata/datetime.yaml'
- $ref: '../../parameters/coverages-core/properties.yaml'
Expand All @@ -18,9 +18,9 @@ get:
- $ref: '../../parameters/coverages-core/scale-size.yaml'
- $ref: '../../parameters/coverages-core/width.yaml'
- $ref: '../../parameters/coverages-core/height.yaml'
- $ref: '../../parameters/common-crs/subset-crs.yaml'
- $ref: '../../parameters/common-crs/bbox-crs.yaml'
- $ref: '../../parameters/common-crs/crs.yaml'
- $ref: '../../parameters/coverages-core/subset-crs.yaml'
- $ref: '../../parameters/coverages-core/bbox-crs.yaml'
- $ref: '../../parameters/coverages-core/crs.yaml'
- $ref: '../../parameters/unspecified/f-coverage.yaml'
responses:
'200':
Expand Down
8 changes: 4 additions & 4 deletions standard/openapi/paths/coverages-core/pSceneCoverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ get:
parameters:
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml'
- $ref: '../../parameters/coverages-core/sceneId.yaml'
- $ref: '../../parameters/common-geodata/subset.yaml'
- $ref: '../../parameters/coverages-core/subset.yaml'
- $ref: '../../parameters/common-geodata/bbox.yaml'
- $ref: '../../parameters/common-geodata/datetime.yaml'
- $ref: '../../parameters/coverages-core/properties.yaml'
Expand All @@ -19,9 +19,9 @@ get:
- $ref: '../../parameters/coverages-core/scale-size.yaml'
- $ref: '../../parameters/coverages-core/width.yaml'
- $ref: '../../parameters/coverages-core/height.yaml'
- $ref: '../../parameters/common-crs/subset-crs.yaml'
- $ref: '../../parameters/common-crs/bbox-crs.yaml'
- $ref: '../../parameters/common-crs/crs.yaml'
- $ref: '../../parameters/coverages-core/subset-crs.yaml'
- $ref: '../../parameters/coverages-core/bbox-crs.yaml'
- $ref: '../../parameters/coverages-core/crs.yaml'
- $ref: '../../parameters/unspecified/f-coverage.yaml'
responses:
'200':
Expand Down
6 changes: 3 additions & 3 deletions standard/openapi/paths/coverages-core/pSceneCoverageTile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ get:
- $ref: '../../parameters/common-geodata/datetime.yaml'
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml'
- $ref: '../../parameters/coverages-core/sceneId.yaml'
- $ref: '../../parameters/common-geodata/subset.yaml'
- $ref: '../../parameters/common-crs/crs.yaml'
- $ref: '../../parameters/common-crs/subset-crs.yaml'
- $ref: '../../parameters/coverages-core/subset.yaml'
- $ref: '../../parameters/coverages-core/crs.yaml'
- $ref: '../../parameters/coverages-core/subset-crs.yaml'
- $ref: '../../parameters/unspecified/tileMatrixSetId.yaml'
- $ref: '../../parameters/unspecified/f-coverageTile.yaml'
responses:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ get:
- $ref: '../../../../parameters/tiles-core/tileCol.yaml'
- $ref: '../../../../parameters/common-geodata/datetime.yaml'
- $ref: '../../../../parameters/common-geodata/collectionId-coverage.yaml'
- $ref: '../../../../parameters/common-geodata/subset.yaml'
- $ref: '../../../../parameters/common-crs/crs.yaml'
- $ref: '../../../../parameters/common-crs/subset-crs.yaml'
- $ref: '../../../../parameters/coverages-core/subset.yaml'
- $ref: '../../../../parameters/coverages-core/crs.yaml'
- $ref: '../../../../parameters/coverages-core/subset-crs.yaml'
- $ref: '../../../../parameters/unspecified/tileMatrixSetId.yaml'
- $ref: '../../../../parameters/unspecified/f-coverageTile.yaml'
responses:
Expand Down
12 changes: 10 additions & 2 deletions standard/openapi/responses/common-core/rConformance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,20 @@ content:
example:
conformsTo:
- http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core
- http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/landing-page
- http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/json
- http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/html
- http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/oas30
- http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/geodata-coverage
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/core
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/subsetting
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/scaling
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/fieldselection
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/crs
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/tiles
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/netcdf
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/geotiff
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/coveragejson
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/cisjson
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/html
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/coverage-subset
- http://www.opengis.net/spec/ogcapi-coverages-1/1.0/conf/oas30
2 changes: 1 addition & 1 deletion standard/openapi/responses/common-core/rException.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: An error occured.
description: An error occurred.
content:
application/json:
schema:
Expand Down
60 changes: 30 additions & 30 deletions standard/openapi/responses/common-core/rLandingPage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@ description: |-
The landing page provides links to the API definition (link relation `service-desc`, in this case path `/api`),
to the Conformance declaration (path `/conformance`, link relation `conformance`), and to the Collections of geospatial data (path `/collections`, link relation `data`).
content:
application/json:
schema:
$ref: '../../schemas/common-core/landingPage.yaml'
example:
title: Elevation in Bonn
description: Access to elevation data in the city of Bonn via a Web API that conforms to the OGC API - Coverages specification.
links:
- href: http://data.example.org/
rel: self
type: application/json
title: this document
- href: http://data.example.org/api
rel: service-desc
type: application/vnd.oai.openapi+json;version=3.0
title: the API definition
- href: http://data.example.org/api.html
rel: service-doc
type: text/html
title: the API documentation
- href: http://data.example.org/conformance
rel: http://www.opengis.net/def/rel/ogc/1.0/conformance
type: application/json
title: OGC API conformance classes implemented by this service
- href: http://data.example.org/collections
rel: http://www.opengis.net/def/rel/ogc/1.0/data
type: application/json
title: Information about the collections (e.g. the coverages)
text/html:
schema:
type: string
application/json:
schema:
$ref: '../../schemas/common-core/landingPage.yaml'
example:
title: Elevation in Bonn
description: Access to elevation data in the city of Bonn via a Web API that conforms to the OGC API - Coverages specification.
links:
- href: http://data.example.org/
rel: self
type: application/json
title: this document
- href: http://data.example.org/api
rel: service-desc
type: application/vnd.oai.openapi+json;version=3.0
title: the API definition
- href: http://data.example.org/api.html
rel: service-doc
type: text/html
title: the API documentation
- href: http://data.example.org/conformance
rel: http://www.opengis.net/def/rel/ogc/1.0/conformance
type: application/json
title: OGC API conformance classes implemented by this service
- href: http://data.example.org/collections
rel: http://www.opengis.net/def/rel/ogc/1.0/data
type: application/json
title: Information about the collections (i.e.,. the coverages)
text/html:
schema:
type: string
84 changes: 42 additions & 42 deletions standard/openapi/responses/common-geodata/rCollection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,45 +6,45 @@ description: |-
* an optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data;
* for collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature').
content:
application/json:
schema:
$ref: '../../schemas/coverages-core/coverageInfo.yaml'
example:
id: elevation
title: Elevation
description: Elevation in the city of Bonn.
extent:
spatial:
bbox:
- - 7.01
- 50.63
- 7.22
- 50.78
links:
- href: http://data.example.org/collections/elevation/coverage/domainset
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage-domainset
type: application/json
title: Elevation
- href: http://data.example.org/collections/elevation/coverage/rangetype
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage-rangetype
type: application/json
title: Elevation
- href: http://data.example.org/collections/elevation/coverage
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage
type: application/json
title: Elevation
- href: http://data.example.org/collections/buildings/coverage.html
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage
type: text/html
title: Elevation
- href: https://creativecommons.org/publicdomain/zero/1.0/
rel: license
type: text/html
title: CC0-1.0
- href: https://creativecommons.org/publicdomain/zero/1.0/rdf
rel: license
type: application/rdf+xml
title: CC0-1.0
text/html:
schema:
type: string
application/json:
schema:
$ref: '../../schemas/common-geodata/collectionDesc.yaml'
example:
id: elevation
title: Elevation
description: Elevation in the city of Bonn.
extent:
spatial:
bbox:
- - 7.01
- 50.63
- 7.22
- 50.78
links:
- href: http://data.example.org/collections/elevation/schema
rel: http://www.opengis.net/def/rel/ogc/1.0/schema
type: application/schema+json
title: Schema (fields)
- href: http://data.example.org/collections/elevation/coverage.tiff
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage
type: image/tiff; application=geotiff
title: Elevation data (as GeoTIFF)
- href: http://data.example.org/collections/elevation/coverage.covjson
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage
type: application/prs.coverage+json
title: Elevation data (as CoverageJSON)
- href: http://data.example.org/collections/elevation/coverage.cisjson
rel: http://www.opengis.net/def/rel/ogc/1.0/coverage
type: application/json
title: Elevation data (as CIS JSON)
- href: https://creativecommons.org/publicdomain/zero/1.0/
rel: license
type: text/html
title: CC0-1.0
- href: https://creativecommons.org/publicdomain/zero/1.0/rdf
rel: license
type: application/rdf+xml
title: CC0-1.0
text/html:
schema:
type: string
Loading

0 comments on commit 2a23e67

Please sign in to comment.