usnistgov / metaschema

Documentation for and implementations of the metaschema modeling language
https://pages.nist.gov/metaschema/
Other
36 stars 19 forks source link

Deprecate legacy datatypes #558

Open aj-stein-nist opened 8 months ago

aj-stein-nist commented 8 months ago

User Story:

As a Metschema developer, in order to reduce implementation surface and complexity, I would like to explicitly deprecate the older, legacy data type names from camelCase to complete migration to kebab-case, remove the legacy, and document its deprecation before upcoming major release (1.0.0).

Goals:

Dependencies:

N/A

Acceptance Criteria

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

aj-stein-nist commented 8 months ago

Can I get a spotcheck of the intent here, @david-waltermire?

  1. Regarding the metaschema-module-metaschema, they are already gone and there are no deprecation warnings. With M1-M3 milestones, we are still technically not "1.0.0 ready" yet, so do you want to add deprecation constraints t @level="WARNING" or just leave it out and consider it done?
  2. Regaring datatypes defined in XML Schema, we have both but no deprecation strategy. Just remove them?
  3. The JSON inventory is complicated because it really doesn't mention any names for datatypes and looks just to be a self-contained JSON Schema. Thoughts?