From 4397832ea75457f16a0327d80b3cd4ed6936d281 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Fri, 1 Mar 2019 17:55:16 +0100 Subject: [PATCH] Added descriptions to cube:dimensions schema (#158), updated processes. --- README.md | 2 +- openapi.json | 33 +++++++++++++++++++++++++++------ processes | 2 +- 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 694523aa..303b0052 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/openapi.json b/openapi.json index b37f7148..f7467f4e 100644 --- a/openapi.json +++ b/openapi.json @@ -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" ] } @@ -843,6 +845,7 @@ }, "properties": { "type": { + "description": "Custom type of the dimension, never `spatial`.", "allOf": [ { "type": "string" @@ -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", @@ -887,6 +892,7 @@ "$ref": "#/components/schemas/collection_dimension_type_spatial" }, "axis": { + "description": "Axis of the spatial dimension (`x`, `y`).", "type": "string", "enum": [ "x", @@ -894,6 +900,7 @@ ] }, "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, @@ -902,6 +909,7 @@ } }, "values": { + "description": "Optionally, a set of all potential values.", "type": "array", "minItems": 1, "items": { @@ -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" ] } @@ -940,6 +949,7 @@ "$ref": "#/components/schemas/collection_dimension_type_spatial" }, "axis": { + "description": "Axis of the spatial dimension, always `z`.", "type": "string", "enum": [ "z" @@ -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", @@ -976,12 +987,14 @@ }, "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": { @@ -989,6 +1002,7 @@ } }, "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, @@ -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 } @@ -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, @@ -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": { @@ -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" diff --git a/processes b/processes index c5831570..268ed7e7 160000 --- a/processes +++ b/processes @@ -1 +1 @@ -Subproject commit c5831570fb691c4d54012502557d424eaf8ac49f +Subproject commit 268ed7e7a2fa0fbeda5ee534879df3e1e2f462a0