Format of "kind" for custom schemas
Observations
- For the current state of the RAFS DDMS, some custom schemas are used that are not canonical to the OSDU Forum, because no OSDU-forum published schemas yet exist to fill this role. These custom schemas are documented here. (Background information and presentations can be found here.)
- The OSDU Data Platform allows the registration of alternate schema authorities; this is not a problem.
- To use custom schemas, however, they should not be identified as OSDU Forum canonical well known schemas (sometimes known as "WKS"). This identification of "schema authority" is found in the "kind". Relevant documentation and explanation of "kind" and alternate schema authorities can be found here:
Actions/Issues
- The PVT schema here unfortunately has a few errors:
- It still follows the "osdu.wks..." pattern:
"x-osdu-schema-source": "osdu:wks:work-product-component--PVT:1.0.0"
. At least one part of this code should be updated. (but see below for the question about which pattern to follow) - It incorrectly states
"createdBy": "OSDU Data Definition Group"
. That should be corrected.
- It still follows the "osdu.wks..." pattern:
2. Depending on how we understand the components of the "kind" string, there may be errors on other schemas, such as ConstantCompositionExpansion (but others need to be checked for the same). This may need alignment on how "kind" is to be constructed based on the links mentioned above. We need to decide which pattern for "kind" to follow, and whether it is appropriate to indicate "wks" at all in the "kind".
Options
- Currently most RAFS DDMS custom schemas have the pattern:
{{rafsddms-schema-authority}}:wks:work-product-component--CompositionalAnalysisTest:1.0.0
- Based on one interpretation of the ADR and Schema Usage Guide, kind should be:
osdu:{{rafsddms-schema-authority}}:work-product-component--CompositionalAnalysisTest:1.0.0
- Based on another interpretation of the documentation (especially the Slack link), kind should be:
{{rafsddms-schema-authority}}:{{rafsddms-schema-authority}}:work-product-component--CompositionalAnalysisTest:1.0.0
Possible Resolutions
- Simplest: Make the corrections in 1.1 and 1.2 above. Make 1.1 match the pattern of the other custom schemas.
2. More complex: If this question is deemed significant then discuss, based on "kind" documentation, whether all the "kinds" of the custom schemas should be updated to follow a different pattern. And clarify what that pattern should be.
Chosen Resolution
Based on discussion in the comments, resolution 1 has been chosen. I have changed alternatives to strikethrough format to avoid confusion.
To be clear:
For Issue 1.1: {{rafsddms-schema-authority}}:wks:work-product-component--PVT:1.0.0
For Issue 1.2: "createdBy": "RAFS DDMS Development Team"