forked from opengeospatial/ogcapi-coverages
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
openapi: Added paths for Coverage scenes
- Loading branch information
1 parent
8e10c6e
commit 08f6a3c
Showing
15 changed files
with
659 additions
and
2 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
name: sceneId | ||
in: path | ||
description: Local identifier of a scene | ||
required: true | ||
schema: | ||
type: string | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Scene | ||
get: | ||
tags: | ||
- Scenes | ||
summary: Retrieve metadata a particular scene | ||
description: |- | ||
Retrieve metadata for a particular scene | ||
operationId: getScene | ||
parameters: | ||
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml' | ||
- $ref: '../../parameters/unspecified/f-metadata.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/coverages-core/rScene.yaml' | ||
default: | ||
$ref: '../../responses/common-core/rException.yaml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Scene Coverage | ||
get: | ||
tags: | ||
- Scenes | ||
summary: Retrieve the coverage for scene {sceneId} of by {collectionId} | ||
description: |- | ||
Coverage for scene {sceneId} of collection identified by {collectionId}. | ||
Use content negotiation to request required format. | ||
operationId: getCoverage | ||
parameters: | ||
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml' | ||
- $ref: '../../parameters/coverages-core/sceneId.yaml' | ||
- $ref: '../../parameters/common-geodata/subset.yaml' | ||
- $ref: '../../parameters/common-geodata/bbox.yaml' | ||
- $ref: '../../parameters/common-geodata/datetime.yaml' | ||
- $ref: '../../parameters/coverages-core/properties.yaml' | ||
- $ref: '../../parameters/coverages-core/scale-factor.yaml' | ||
- $ref: '../../parameters/coverages-core/scale-axes.yaml' | ||
- $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/unspecified/f-coverage.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/coverages-core/rCoverage.yaml' | ||
default: | ||
$ref: '../../responses/common-core/rException.yaml' |
28 changes: 28 additions & 0 deletions
28
standard/openapi/paths/coverages-core/pSceneCoverageTile.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
get: | ||
tags: | ||
- Coverage Tiles | ||
summary: Retrieve coverage scene tiles | ||
operationId: .collection.scene.coverage.getTile | ||
parameters: | ||
- $ref: '../../parameters/tiles-core/tileMatrix.yaml' | ||
- $ref: '../../parameters/tiles-core/tileRow.yaml' | ||
- $ref: '../../parameters/tiles-core/tileCol.yaml' | ||
- $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/unspecified/tileMatrixSetId.yaml' | ||
- $ref: '../../parameters/unspecified/f-coverageTile.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/tiles-core/rCoverageTile.yaml' | ||
'204': | ||
$ref: '../../responses/tiles-core/rEmptyTile.yaml' | ||
'404': | ||
$ref: '../../responses/common-core/rNotFound.yaml' | ||
'406': | ||
$ref: '../../responses/common-core/rNotAcceptable.yaml' | ||
'500': | ||
$ref: '../../responses/common-core/rServerError.yaml' |
19 changes: 19 additions & 0 deletions
19
standard/openapi/paths/coverages-core/pSceneCoverageTileSet.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
get: | ||
tags: | ||
- Coverage Tiles | ||
summary: Retrieve the coverage scene tileset metadata for the specified collection, scene and tiling scheme (tile matrix set) | ||
operationId: .collection.sceneId.coverage.getTileSet | ||
parameters: | ||
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml' | ||
- $ref: '../../parameters/coverages-core/sceneId.yaml' | ||
- $ref: '../../parameters/unspecified/tileMatrixSetId.yaml' | ||
- $ref: '../../parameters/unspecified/f-metadata.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/tiles-core/rTileSet.yaml' | ||
'404': | ||
$ref: '../../responses/common-core/rNotFound.yaml' | ||
'406': | ||
$ref: '../../responses/common-core/rNotAcceptable.yaml' | ||
'500': | ||
$ref: '../../responses/common-core/rServerError.yaml' |
18 changes: 18 additions & 0 deletions
18
standard/openapi/paths/coverages-core/pSceneCoverageTileSetsList.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
get: | ||
tags: | ||
- Coverage Tiles | ||
summary: Retrieve the list of available coverage tilesets for the specified coverage scene. | ||
operationId: .collection.scene.coverage.getTileSetsList | ||
parameters: | ||
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml' | ||
- $ref: '../../parameters/coverages-core/sceneId.yaml' | ||
- $ref: '../../parameters/unspecified/f-metadata.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/tiles-core/rTileSetsList.yaml' | ||
'404': | ||
$ref: '../../responses/common-core/rNotFound.yaml' | ||
'406': | ||
$ref: '../../responses/common-core/rNotAcceptable.yaml' | ||
'500': | ||
$ref: '../../responses/common-core/rServerError.yaml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Scenes List | ||
get: | ||
tags: | ||
- Scenes | ||
summary: Retrieve the list of scenes comprising this collection | ||
description: |- | ||
The list of scenes comprising this collection. | ||
operationId: getCollectionScenes | ||
parameters: | ||
- $ref: '../../parameters/common-geodata/collectionId-coverage.yaml' | ||
- $ref: '../../parameters/unspecified/f-metadata.yaml' | ||
responses: | ||
'200': | ||
$ref: '../../responses/coverages-core/rScenesList.yaml' | ||
default: | ||
$ref: '../../responses/common-core/rException.yaml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
description: |- | ||
Information about a particular collection of (mostly geospatial) data available from this API. The collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is contained in the response, with the corresponding relation type, as well as key information about the collection. This information includes: | ||
* a local identifier for the collection that is unique for the dataset; | ||
* a list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude); | ||
* an optional title and description for the collection; | ||
* 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
description: |- | ||
The individual scenes comprising the coverage | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../schemas/coverages-core/scenesList.yaml' | ||
text/html: | ||
schema: | ||
type: string |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
type: object | ||
required: | ||
- id | ||
- crs | ||
- storageCrs | ||
- links | ||
properties: | ||
id: | ||
type: | ||
oneOf: | ||
- string | ||
- integer | ||
extent: | ||
$ref: '../common-geodata/extent-uad.yaml' | ||
crs: | ||
type: array | ||
items: | ||
type: string | ||
format: uri | ||
minItems: 1 | ||
storageCrs: | ||
type: string | ||
format: uri | ||
links: | ||
type: array | ||
items: | ||
$ref: '../common-core/link.yaml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
type: object | ||
required: | ||
- id | ||
properties: | ||
id: | ||
type: | ||
oneOf: | ||
- string | ||
- integer | ||
links: | ||
type: array | ||
items: | ||
$ref: '../common-core/link.yaml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
type: object | ||
required: | ||
- links | ||
- scenes | ||
properties: | ||
scenes: | ||
type: array | ||
items: | ||
$ref: 'sceneItem.yaml' | ||
links: | ||
type: array | ||
items: | ||
$ref: '../common-core/link.yaml' | ||
timeStamp: | ||
type: string | ||
format: date-time | ||
numberMatched: | ||
type: integer | ||
minimum: 0 | ||
example: 1 | ||
numberReturned: | ||
type: integer | ||
minimum: 0 | ||
example: 1 |