search

Open-EO / openeo-api

The openEO API specification
http://api.openeo.org
Apache License 2.0
91 stars 11 forks source link

Document additional relation types for process metadata #531 #536

Closed m-mohr closed 4 weeks ago

m-mohr commented 4 weeks ago

Closes #531

soxofaan commented 4 weeks ago

I think this PR is fine to merge as-is already

however by looking at it I'm a bit confused by this existing bit:

latest-version: If a process has been marked as deprecated, a link SHOULD point to the preferred version of the process. 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.

How is this supposed to work? There is no version concept (yet) for UDPs, nor do they have a public URLs to link to .

UDPs are only by defined by process id, so does this documentation suggest to put the version in the the process id, e.g. my_evi_v2, my_evi_v3? (Note that dots are not allowed in process id, so this might get ugly)

m-mohr commented 4 weeks ago

The versioning was meant more for informative purposes, e.g. for tracability, and not necessarily lives within the API. The ID should usually be the same and old versions should not be usable anymore. At least right now. We could also integrate something on the API level, but that is future work, I think.