From 3f710f91b891f84bf62ce5fbf90cf344340ec328 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Thu, 13 Jun 2024 11:13:02 +0200 Subject: [PATCH 1/2] Document additional relation types for process metadata #531 --- CHANGELOG.md | 1 + openapi.yaml | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fdd0e0eb..7622bc24 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `PATCH /services/{service_id}` and `PATCH /jobs/{job_id}`: Explicitly allow updating back-end specific properties (as in `POST`) - `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`) - Clarified for log levels which default values apply +- Clarified how the relation types `license`, `version-history` and `author` can be used to enrich the process metadata. [#531](https://github.com/Open-EO/openeo-api/issues/531) ## [1.2.0] - 2021-05-25 diff --git a/openapi.yaml b/openapi.yaml index bf98aec3..bc1062ae 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5262,11 +5262,19 @@ components: (link to older version) and `successor-version` (link to newer version) can also be used to show the relation between versions. + 2. `version-history`: A link to a changelog and/or a list of versions of the process + (see also the relation types `latest-version` etc.). + 2. `example`: Links to examples of other processes that use this process. 3. `cite-as`: For all DOIs associated with the process, the respective DOI links SHOULD be added. + 4. `license`: Links to applicable license(s). The link titles should reflect the license names. + + 5. `author`: Links to authors of the process. The `href` can use the `mailto:` protocol to + link to an email address. The link titles should reflect the author names and affiliations. + For additional relation types see also the lists of [common relation types in openEO](#section/API-Principles/Web-Linking). items: From f99d861aeaad0fd9aa30dfe2d40f8076ba67953b Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Thu, 13 Jun 2024 21:20:25 +0200 Subject: [PATCH 2/2] Fix bullet points, add canonical --- openapi.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index bc1062ae..a97d448f 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5265,16 +5265,18 @@ components: 2. `version-history`: A link to a changelog and/or a list of versions of the process (see also the relation types `latest-version` etc.). - 2. `example`: Links to examples of other processes that use this process. + 3. `example`: Links to examples of other processes that use this process. - 3. `cite-as`: For all DOIs associated with the process, the respective DOI + 4. `cite-as`: For all DOIs associated with the process, the respective DOI links SHOULD be added. - 4. `license`: Links to applicable license(s). The link titles should reflect the license names. + 5. `license`: Links to applicable license(s). The link titles should reflect the license names. - 5. `author`: Links to authors of the process. The `href` can use the `mailto:` protocol to + 6. `author`: Links to authors of the process. The `href` can use the `mailto:` protocol to link to an email address. The link titles should reflect the author names and affiliations. + 7. `canonical`: Points to a publicly accessible and more long-lived URL. + For additional relation types see also the lists of [common relation types in openEO](#section/API-Principles/Web-Linking). items: