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

Add a sentence clarifying id-persistence to all identifiers. #301

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

jelmerderonde
Copy link
Contributor

This PR adds a sentence to all the *Id descriptions clarifying that identifiers should be persistent uuid's, always pointing to the same resource.

This information was already present in the documentation: https://openonderwijsapi.nl/#/technical/identifiers.

This PR fixes #123

@jelmerderonde jelmerderonde requested a review from hamrt October 11, 2023 11:40
Copy link
Contributor

@hamrt hamrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Jelmer,

I would suggest to broaden this, and also add information about uuid to the following files:
v5/enumerations/codeType.yaml
v5/schemas/EducationSpecificationId.yaml

@jelmerderonde jelmerderonde requested a review from hamrt October 30, 2023 12:19
@jelmerderonde
Copy link
Contributor Author

@hamrt I've made the changes you requested. Not all codes in the codeType enumeration are necessarily persistent (since they are not all part of the OOAPI spec, we have nothing to say about their persistence), so I have only added the sentence to some of the items.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To review
Development

Successfully merging this pull request may close these issues.

Add information about the persistence of identifiers to the spec
2 participants