Metadata schema versioning

[dennisvang]

How does metadata schema versioning work?

While (naively) playing around with the creation of resource definitions and metadata schemas in FDP v1.17.2, I noticed the following points:

1. When creating a resource definition, we must select one or more metadata schemas. However, we cannot select a specific version of the schema. I assume it always defaults to the latest version. Perhaps there is an obvious reason for this, but an explanation would be very helpful.

   

2. What happens if we select multiple metadata schemas in a resource definition? Are they merged somehow?

3. If we select a metadata schema and click "save" without actually making any changes, the schema status changes to "draft".

   

4. If we select a metadata schema and click "save and release", we get a "Release version" form with "description" field. I would expect this description to pertain to the changes introduced in the new version, but, instead, after clicking "release," it turns out the description of the schema itself is updated.

   

5. The "Release version" form shows a checkbox for "Public version." Many questions here:

   • What's the difference between a "public" version and a "non-public" (private) version?

   • When should we use this checkbox?

   • How can I know, using the FDP-client, as admin, if a version is "public?"
     AFAIK it does not show in the schemas overview, nor does it show on the schema edit page.

   • Related to the previous observation: How can I use the FDP-client to make a version private?

   • If I try to release a schema with "public version" enabled, I get an error saying

     Cannot publish as not all parents (via extends) are published

     I assume this implies all parents also need to have "public version" enabled?

6. Where can we see the version history for a metadata schema, using the FDP-client?

7. If not through the FDP-client, do we get more information or control over metadata versions using the FDP API?

8. In the FDP API docs example response for the metadata-schemas endpoint, there is a targetClasses field. What does this do?

   [
     {
       "uuid": "string",
       "name": "string",
       "latest": {
         "uuid": "string",
         "version": "string",
         "versionUuid": "string",
         "previousVersionUuid": "string",
         "name": "string",
         "published": true,
         "abstractSchema": true,
         "latest": true,
         "type": "INTERNAL",
         "origin": "string",
         "importedFrom": "string",
         "definition": "string",
         "description": "string",
         "targetClasses": [
           "string"
         ],
         "extendsSchemaUuids": [
           "string"
         ],
         "suggestedResourceName": "string",
         "suggestedUrlPrefix": "string"
       },
        "draft": {
         "uuid": "string",
         "name": "string",
         "description": "string",
         "abstractSchema": true,
         "definition": "string",
         "extendsSchemaUuids": [
           "string"
         ],
         "suggestedResourceName": "string",
         "suggestedUrlPrefix": "string",
         "lastVersion": "string"
       },
       "versions": [
         "string"
       ],
       "extendSchemaUuids": [
         "string"
       ],
       "childSchemaUuids": [
         "string"
       ]
     }
   ]

[dennisvang]

6. Where can we see the version history for a metadata schema, using the FDP-client?

Looks like we can view the available schema versions when importing them into another fdp...

[PatrickDekkerHealthRI]

A note about "public" schema. You can use the import schema (via url) option to import schema's from other FDP if the schema is public. (at least that was the idea, as far as know that functionality is broken...)