search

microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
26 stars 8 forks source link

produce a nmdc-schema YAML artifact with deprecated elements included #2080

Open sierra-moxon opened 1 week ago

sierra-moxon commented 1 week ago

Per conversations with our GSC/MIxS colleagues, we think providing a nmdc-schema YAML artifact with the deprecated.yaml file included will be helpful for those processing nmdc-schema programmatically.

Currently, in the Berkeley schema, we've implemented a deprecated.yaml file for hosting deprecated elements that are excluded from various linkml serializations of the model (excluded from JSONSchema, python, etc.) to prevent folks from using deprecated elements. It is currently included in the linkml documentation for the schema to preserve URIs and generally give users a place to track deprecated elements over time. Using the same mechanism to include it in the doc, we can produce an nmdc-schema-full.yaml file with the deprecated elements included to help support schema users that need to upgrade, finding the metadata they need programmatically without having to know about, find, and parse/load the deprecated.yaml file itself.

It would be great to hear feedback on the naming of this artifact, vote for your favorite (or suggest a better name) :)

👍 nmdc_schema_full.yaml # full is a complex descriptor with many definitions. 🎉 nmdc_schema_plus_deprecations.yaml # verbose, but descriptive 🚀 nmdc_schema.yaml # larger change; the scope of nmdc-schema will change. 👎 - none of these, consider something else.

If 🚀 is the choice, then we need to consider if we want to provide a "deprecated element free" version of the nmdc-schema.yaml serialization.

sierra-moxon commented 5 days ago

from metadata call 6/24/24 - one downvote for 🚀 b.c it changes the scope of the schema and we need to be able to see the living schema independently from the entire schema (incl. deprecation)