Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document additional relation types for process metadata #531 #536

Merged
merged 2 commits into from
Jun 14, 2024
Merged

Document additional relation types for process metadata #531 #536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f710f9
Document additional relation types for process metadata #531
m-mohr Jun 13, 2024
f99d861
Fix bullet points, add canonical
m-mohr Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
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
View file
Open in desktop
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
m-mohr marked this conversation as resolved.
Show resolved Hide resolved
(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
Loading