Skip to content

Commit

Permalink
Align example links with #286
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-mohr
m-mohr committed May 25, 2020
1 parent 2429025 commit a9dba6d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 27 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `GET /udf_runtimes`: Added optional `title` property for UDF runtimes. [#266](https://github.com/Open-EO/openeo-api/issues/266)
- `GET /service_types`: Added optional `title` and `description` properties for service types. [#266](https://github.com/Open-EO/openeo-api/issues/266)
- `GET /file_formats`: Added optional `description` property for file formats. [#266](https://github.com/Open-EO/openeo-api/issues/266)
- `GET /collections/{collection_id}`: Added optional `assets` property for collection-level assets. This may link to process graphs or thumbnails for visualizations. [#211](https://github.com/Open-EO/openeo-api/issues/211)
- `GET /collections/{collection_id}`: Added optional `assets` property for collection-level assets. This may link to visualizations for example. [#211](https://github.com/Open-EO/openeo-api/issues/211)
- `year` subtype to subtype-schemas.json. `year` was also added to subtypes `temporal-interval` and `temporal-intervals`. [#267](https://github.com/Open-EO/openeo-api/issues/267)

### Changes
Expand Down
47 changes: 21 additions & 26 deletions openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1597,12 +1597,20 @@ paths:
- null
links:
- rel: license
href: >-
https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf
href: https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf
type: application/pdf
- rel: about
href: >-
https://earth.esa.int/web/sentinel/user-guides/sentinel-2-msi/product-types/level-1c
href: https://earth.esa.int/web/sentinel/user-guides/sentinel-2-msi/product-types/level-1c
type: text/html
title: ESA Sentinel-2 MSI Level-1C User Guide
- rel: example
href: 'https://example.openeo.org/api/collections/Sentinel-2/examples/true-color.json'
type: application/json
title: Example Process for True-Color Visualization
- rel: example
href: 'https://example.openeo.org/api/collections/Sentinel-2/examples/ndvi.json'
type: application/json
title: Example Process for NDVI Calculation and Visualization
'cube:dimensions':
x:
type: spatial
Expand Down Expand Up @@ -1714,27 +1722,13 @@ paths:
max: 32660
assets:
thumbnail:
href: 'https://openeo.org/api/collections/Sentinel-2/thumbnail.png'
href: 'https://example.openeo.org/api/collections/Sentinel-2/thumbnail.png'
type: image/png
title: Preview
roles:
- thumbnail
true-color:
href: 'https://openeo.org/api/collections/Sentinel-2/examples/true-color.json'
type: application/json
title: Example Process for True-Color Visualization
roles:
- process
- example
ndvi:
href: 'https://openeo.org/api/collections/Sentinel-2/examples/ndvi.json'
type: application/json
title: Example Process for NDVI Calculation and Visualization
roles:
- process
- example
inspire:
href: 'https://openeo.org/api/collections/Sentinel-2/inspire.xml'
href: 'https://example.openeo.org/api/collections/Sentinel-2/inspire.xml'
type: application/xml
title: INSPIRE metadata
description: INSPIRE compliant XML metadata
Expand Down Expand Up @@ -4063,8 +4057,7 @@ components:
Purposes of the asset. Can be any value, but commonly used values are:
* `thumbnail`: A visualization of the data, usually a lower-resolution true color image in JPEG or PNG format.
* `process` and `reproduction`: The process used to compute the data made available here, in JSON format.
* `process` and `example`: Examples for user-defined process(es) using this data, in JSON format.
* `reproducibility`: Information how the data was produced and/or can be reproduced, e.g. the process graph used to compute the data in JSON format.
* `data`: The computed data in the format given by the user in the user-defined process.
* `metadata`: Additional metadata available for the computed data.
example:
Expand Down Expand Up @@ -4311,19 +4304,21 @@ components:
2. `license`: A link to the license(s) should be specified if the `license`
field is set to `proprietary` or `various`.
3. `derived_from`: Allows linking to the data this collection was derived from.
3. `example`: Links to examples of user-defined processes that use this collection.
4. `derived_from`: Allows linking to the data this collection was derived from.
4. `cite-as`: [DOI](https://www.doi.org/) links should be added. DOIs can also be
5. `cite-as`: [DOI](https://www.doi.org/) links should be added. DOIs can also be
listed in the STAC fields `sci:doi` and `sci:publications`, see the [STAC scientific
extension](https://github.com/radiantearth/stac-spec/tree/v0.9.0/extensions/scientific)
for more details.
5. `latest-version`: If a collection has been marked as deprecated, a link should
6. `latest-version`: If a collection has been marked as deprecated, a link should
point to the latest version of the collection. The relation types `predecessor-version`
(link to older version) and `successor-version` (link to newer version) can also be used
to show the relation between versions.
6. `alternate`: An alternative representation of the collection.
7. `alternate`: An alternative representation of the collection.
For example, this could be the collection available through another
catalog service such as OGC CSW, a human-readable HTML version or a
metadata document following another standard such as ISO 19115 or DCAT.
Expand Down

0 comments on commit a9dba6d

Please sign in to comment.