Add a sentence clarifying id-persistence to all identifiers.

open-education-api / specification

OpenAPI (fka Swagger) specification for the Open Education API.

Other

32 stars 26 forks source link

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

Open jelmerderonde opened 1 year ago

jelmerderonde commented 1 year ago

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 commented 12 months ago

@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.