Skip to content

Commit

Permalink
Document additional relation types for process metadata #531 (#536)
Browse files Browse the repository at this point in the history
* Document additional relation types for process metadata #531

* Fix bullet points, add canonical
  • Loading branch information
m-mohr committed Jun 14, 2024
1 parent b70b43c commit 13dc6bb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 12 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5262,11 +5262,21 @@ components:
(link to older version) and `successor-version` (link to newer version) can also be used
to show the relation between versions.
2. `example`: Links to examples of other processes that use this process.
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.).
3. `cite-as`: For all DOIs associated with the process, the respective DOI
3. `example`: Links to examples of other processes that use this process.
4. `cite-as`: For all DOIs associated with the process, the respective DOI
links SHOULD be added.
5. `license`: Links to applicable license(s). The link titles should reflect the license names.
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:
Expand Down

0 comments on commit 13dc6bb

Please sign in to comment.