Skip to content

Commit

Permalink
Added descriptions to cube:dimensions schema (#158), updated processes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-mohr
m-mohr committed Mar 1, 2019
1 parent 81ede00 commit 4397832
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The openEO (core) API is currently released in version **0.4.0**.
| [0.0.2](https://github.com/Open-EO/openeo-api/tree/0.0.2) ([Spec](https://open-eo.github.io/openeo-api/v/0.0.2/index.html)) | legacy | Proof of concept, implemented. |
| [0.3.0](https://github.com/Open-EO/openeo-api/tree/0.3.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.0/index.html)) | legacy | Major rework. |
| [0.3.1](https://github.com/Open-EO/openeo-api/tree/0.3.1) ([Spec](https://open-eo.github.io/openeo-api/v/0.3.1/index.html)) | legacy, supported | Fixing minor issues, see the [changelog](CHANGELOG.md#031---2018-11-06). |
| [**0.4.0**](https://github.com/Open-EO/openeo-api/tree/0.4.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.4.0/index.html)) | **current** | Improved discovery, added processes catalogue, STAC 0.6, new process graph structure and [more](CHANGELOG.md#031---2019-02-28). |
| [**0.4.0**](https://github.com/Open-EO/openeo-api/tree/0.4.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.4.0/index.html)) | **current** | Improved discovery, added processes catalogue, new process graph structure and [more](CHANGELOG.md#031---2019-02-28). |
| [0.5.0](https://github.com/Open-EO/openeo-api/tree/0.5.0) ([Spec](https://open-eo.github.io/openeo-api/v/0.5.0/index.html)) | planned | Improvements based on implementer feedback, introduce extension concept. |

See also the [changelog](CHANGELOG.md) and the [milestones](https://github.com/Open-EO/openeo-api/milestones) for a rough roadmap based on GitHub issues.
Expand Down
33 changes: 27 additions & 6 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -821,17 +821,19 @@
"anyOf": [
{
"title": "Additional Dimension Object",
"description": "An additional dimension that is not `spatial`.",
"type": "object",
"required": [
"type"
],
"anyOf": [
{
"required": [
"type",
"extent"
]
},
{
"required": [
"type",
"values"
]
}
Expand All @@ -843,6 +845,7 @@
},
"properties": {
"type": {
"description": "Custom type of the dimension, never `spatial`.",
"allOf": [
{
"type": "string"
Expand Down Expand Up @@ -870,12 +873,14 @@
"$ref": "#/components/schemas/collection_dimension_unit"
},
"reference_system": {
"description": "The reference system for the data.",
"type": "string"
}
}
},
{
"title": "Horizontal Spatial Dimension Object",
"description": "A spatial dimension in one of the horizontal (x or y) directions.",
"type": "object",
"required": [
"type",
Expand All @@ -887,13 +892,15 @@
"$ref": "#/components/schemas/collection_dimension_type_spatial"
},
"axis": {
"description": "Axis of the spatial dimension (`x`, `y`).",
"type": "string",
"enum": [
"x",
"y"
]
},
"extent": {
"description": "Extent (lower and upper bounds) of the dimension as two-dimensional array. Open intervals with `null` are not allowed.",
"type": "array",
"minItems": 2,
"maxItems": 2,
Expand All @@ -902,6 +909,7 @@
}
},
"values": {
"description": "Optionally, a set of all potential values.",
"type": "array",
"minItems": 1,
"items": {
Expand All @@ -918,19 +926,20 @@
},
{
"title": "Vertical Spatial Dimension Object",
"description": "A spatial dimension in vertical (z) direction.",
"type": "object",
"required": [
"type",
"axis"
],
"anyOf": [
{
"required": [
"type",
"axis",
"extent"
]
},
{
"required": [
"type",
"axis",
"values"
]
}
Expand All @@ -940,6 +949,7 @@
"$ref": "#/components/schemas/collection_dimension_type_spatial"
},
"axis": {
"description": "Axis of the spatial dimension, always `z`.",
"type": "string",
"enum": [
"z"
Expand All @@ -964,6 +974,7 @@
},
{
"title": "Temporal Dimension Object",
"description": "A temporal dimension based on the ISO 8601 standard. The temporal reference system for the data is expected to be ISO 8601 compliant (Gregorian calendar / UTC). Data not compliant with ISO 8601 can be represented as an *Additional Dimension Object* with `type` set to `temporal`.",
"type": "object",
"required": [
"type",
Expand All @@ -976,19 +987,22 @@
},
"properties": {
"type": {
"description": "Type of the dimension, always `temporal`.",
"type": "string",
"enum": [
"temporal"
]
},
"values": {
"description": "If the dimension consists of set of specific values they can be listed here. The dates and/or times must be strings compliant to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).",
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"extent": {
"description": "Extent (lower and upper bounds) of the dimension as two-dimensional array. The dates and/or times must be strings compliant to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). `null` is allowed for open date ranges.",
"type": "array",
"minItems": 2,
"maxItems": 2,
Expand All @@ -998,6 +1012,7 @@
}
},
"step": {
"description": "The space between the temporal instances as [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations), e.g. `P1D`. Use `null` for irregularly spaced steps.",
"type": "string",
"nullable": true
}
Expand Down Expand Up @@ -3901,12 +3916,14 @@
"example": "Sentinel-2A"
},
"collection_dimension_type_spatial": {
"description": "Type of the dimension, always `spatial`.",
"type": "string",
"enum": [
"spatial"
]
},
"collection_dimension_extent_open": {
"description": "If the dimension consists of [ordinal](https://en.wikipedia.org/wiki/Level_of_measurement#Ordinal_scale) values, the extent (lower and upper bounds) of the values as two-dimensional array. Use `null` for open intervals.",
"type": "array",
"minItems": 2,
"maxItems": 2,
Expand All @@ -3916,6 +3933,7 @@
}
},
"collection_dimension_values": {
"description": "A set of all potential values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values.\n\n**Important:** The order of the values MUST be exactly how the dimension values are also ordered in the data (cube). If the values specify band names, the values MUST be in the same order as they are in the corresponding band fields (i.e. `eo:bands` or `sar:bands`).",
"type": "array",
"minItems": 1,
"items": {
Expand All @@ -3930,13 +3948,16 @@
}
},
"collection_dimension_step": {
"description": "If the dimension consists of [interval](https://en.wikipedia.org/wiki/Level_of_measurement#Interval_scale) values, the space between the values. Use `null` for irregularly spaced steps.",
"type": "number",
"nullable": true
},
"collection_dimension_unit": {
"description": "The unit of measurement for the data, preferably the symbols from [SI](https://physics.nist.gov/cuu/Units/units.html) or [UDUNITS](https://ncics.org/portfolio/other-resources/udunits2/).",
"type": "string"
},
"collection_dimension_reference_system_spatial": {
"description": "The spatial reference system for the data, specified as [EPSG code](http://www.epsg-registry.org/) or [PROJ definition](https://proj4.org/operations/projections/index.html). Defaults to EPSG code 4326.",
"oneOf": [
{
"type": "string"
Expand Down
2 changes: 1 addition & 1 deletion processes
Submodule processes updated 3 files
+1 −1 eq.json
+2 −1 load_collection.json
+1 −1 neq.json

0 comments on commit 4397832

Please sign in to comment.