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.

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

Conversation

m-mohr
Copy link
Member

@m-mohr m-mohr commented Jun 13, 2024

Closes #531

@m-mohr m-mohr added the processes Process definitions and descriptions label Jun 13, 2024
@m-mohr m-mohr added this to the 1.3.0 milestone Jun 13, 2024
@m-mohr m-mohr requested a review from soxofaan June 13, 2024 09:14
@m-mohr m-mohr mentioned this pull request Jun 13, 2024
@m-mohr m-mohr linked an issue Jun 13, 2024 that may be closed by this pull request
openapi.yaml Show resolved Hide resolved
@soxofaan
Copy link
Member

soxofaan commented Jun 13, 2024

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
Copy link
Member Author

m-mohr commented Jun 13, 2024

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.

@m-mohr m-mohr merged commit 13dc6bb into draft Jun 14, 2024
2 checks passed
@m-mohr m-mohr deleted the process-rel-types branch June 14, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
processes Process definitions and descriptions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

License for UDP?
2 participants