Skip to content

Commit e3d51b1

Browse files
committed
openapi: Added resolutions query parameter
- Also disabled legacy `scale-factor`, `scale-size` and `scale-axes`.
1 parent 8e5427c commit e3d51b1

5 files changed

Lines changed: 27 additions & 47 deletions

File tree

standard/openapi/ogcapi-coverages-1.bundled.json

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -266,13 +266,7 @@
266266
"$ref": "#/components/parameters/properties"
267267
},
268268
{
269-
"$ref": "#/components/parameters/scale-factor"
270-
},
271-
{
272-
"$ref": "#/components/parameters/scale-axes"
273-
},
274-
{
275-
"$ref": "#/components/parameters/scale-size"
269+
"$ref": "#/components/parameters/resolutions"
276270
},
277271
{
278272
"$ref": "#/components/parameters/width"
@@ -424,13 +418,7 @@
424418
"$ref": "#/components/parameters/properties"
425419
},
426420
{
427-
"$ref": "#/components/parameters/scale-factor"
428-
},
429-
{
430-
"$ref": "#/components/parameters/scale-axes"
431-
},
432-
{
433-
"$ref": "#/components/parameters/scale-size"
421+
"$ref": "#/components/parameters/resolutions"
434422
},
435423
{
436424
"$ref": "#/components/parameters/width"
@@ -3068,28 +3056,10 @@
30683056
"type": "string"
30693057
}
30703058
},
3071-
"scale-factor": {
3072-
"name": "scale-factor",
3073-
"in": "query",
3074-
"description": "For each axis, the returned coverage will contain the number of original\nsampled values, divided by the scale-factor.",
3075-
"required": false,
3076-
"schema": {
3077-
"type": "number"
3078-
}
3079-
},
3080-
"scale-axes": {
3081-
"name": "scale-axes",
3082-
"in": "query",
3083-
"description": "Returns a coverage re-scaled so as to contain `{number}` times less sample\nvalues along the corresponding axisName axis, and all original values along\nthe dimensions of unspecified axes\n```\nScalingSpec: \"scale-axes\"=axisName({number})[,axisName({number})]*\naxisName: {NCName}\n\nWhere:\n {number} is an integer or floating-point number, and {axisName} is the\n same as one of the axisLabels defined in the DomainSet\n```",
3084-
"required": false,
3085-
"schema": {
3086-
"type": "string"
3087-
}
3088-
},
3089-
"scale-size": {
3090-
"name": "scale-size",
3059+
"resolutions": {
3060+
"name": "resolutions",
30913061
"in": "query",
3092-
"description": "When `scale-size` is used, the returned coverage will contain exactly the\nspecified number of sample values along each axis which is specified, and\nthe original number of sample values for unspecified axes.\n```\nScalingSpec: \"scale-size\"=axisName({number})[,axisName({number})]*\naxisName: {text}\n\nWhere:\n {number} is an integer or floating-point number and {axisName}\n is the same as one of the axisLabels defined in the DomainSet\n```",
3062+
"description": "Request a specific resolution for one or more dimension in terms of the minimum distance between two samples.\nFor a regular grid coverage output, the resolution corresponds to the grid resolution.\nThe parameter value is a comma separated list of dimensions followed by values in parentheses.\nFor example, `resolutions=Lat(0.5),Lon(0.5),time(P1D)` specifies a 0.5 degrees spatial resolution and a daily temporal resolution.\nFor server supporting Spatial subsetting, the `Lat` and `Lon` dimensions are supported for a geographic output CRS,\nand the `E` and `N` dimensions are supported for a projected output CRS, with the resolution specified in positive CRS units.\nFor a 3D CRS, the resolution for an additional `h` dimension can be specified, corresponding to the height above the ellipsoid\nfor a geographic CRS, or to a vertical dimension usually called _z_ in a 3D Cartesian CRS.\nFor server supporting Temporal subsetting, the `time` dimension is supported referring to the primary temporal dimensions,\nwith units specified in ISO 8601 UTC / Gregorian date and time.\nFor server supporting General subsetting, a resolution for additional dimensions, as named in the collection description's extent,\ncan also be specifiede in the units specified for those dimensions.",
30933063
"required": false,
30943064
"schema": {
30953065
"type": "string"

standard/openapi/ogcapi-coverages-1.yaml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,8 @@ components:
151151
# Coverages - Core
152152
sceneId:
153153
$ref: 'parameters/coverages-core/sceneId.yaml'
154-
scale-factor:
155-
$ref: 'parameters/coverages-core/scale-factor.yaml'
156-
scale-axes:
157-
$ref: 'parameters/coverages-core/scale-axes.yaml'
158-
scale-size:
159-
$ref: 'parameters/coverages-core/scale-size.yaml'
154+
resolutions:
155+
$ref: 'parameters/coverages-core/resolutions.yaml'
160156
properties:
161157
$ref: 'parameters/coverages-core/properties.yaml'
162158
width:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: resolutions
2+
in: query
3+
description: |-
4+
Request a specific resolution for one or more dimension in terms of the minimum distance between two samples.
5+
For a regular grid coverage output, the resolution corresponds to the grid resolution.
6+
The parameter value is a comma separated list of dimensions followed by values in parentheses.
7+
For example, `resolutions=Lat(0.5),Lon(0.5),time(P1D)` specifies a 0.5 degrees spatial resolution and a daily temporal resolution.
8+
For server supporting Spatial subsetting, the `Lat` and `Lon` dimensions are supported for a geographic output CRS,
9+
and the `E` and `N` dimensions are supported for a projected output CRS, with the resolution specified in positive CRS units.
10+
For a 3D CRS, the resolution for an additional `h` dimension can be specified, corresponding to the height above the ellipsoid
11+
for a geographic CRS, or to a vertical dimension usually called _z_ in a 3D Cartesian CRS.
12+
For server supporting Temporal subsetting, the `time` dimension is supported referring to the primary temporal dimensions,
13+
with units specified in ISO 8601 UTC / Gregorian date and time.
14+
For server supporting General subsetting, a resolution for additional dimensions, as named in the collection description's extent,
15+
can also be specifiede in the units specified for those dimensions.
16+
required: false
17+
schema:
18+
type: string

standard/openapi/paths/coverages-core/pCoverage.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ get:
1313
- $ref: '../../parameters/common-geodata/bbox.yaml'
1414
- $ref: '../../parameters/common-geodata/datetime.yaml'
1515
- $ref: '../../parameters/coverages-core/properties.yaml'
16-
- $ref: '../../parameters/coverages-core/scale-factor.yaml'
17-
- $ref: '../../parameters/coverages-core/scale-axes.yaml'
18-
- $ref: '../../parameters/coverages-core/scale-size.yaml'
16+
- $ref: '../../parameters/coverages-core/resolutions.yaml'
1917
- $ref: '../../parameters/coverages-core/width.yaml'
2018
- $ref: '../../parameters/coverages-core/height.yaml'
2119
- $ref: '../../parameters/coverages-core/subset-crs.yaml'

standard/openapi/paths/coverages-core/pSceneCoverage.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ get:
1414
- $ref: '../../parameters/common-geodata/bbox.yaml'
1515
- $ref: '../../parameters/common-geodata/datetime.yaml'
1616
- $ref: '../../parameters/coverages-core/properties.yaml'
17-
- $ref: '../../parameters/coverages-core/scale-factor.yaml'
18-
- $ref: '../../parameters/coverages-core/scale-axes.yaml'
19-
- $ref: '../../parameters/coverages-core/scale-size.yaml'
17+
- $ref: '../../parameters/coverages-core/resolutions.yaml'
2018
- $ref: '../../parameters/coverages-core/width.yaml'
2119
- $ref: '../../parameters/coverages-core/height.yaml'
2220
- $ref: '../../parameters/coverages-core/subset-crs.yaml'

0 commit comments

Comments
 (0)