Skip to content

v2.6.1

Latest

Choose a tag to compare

@JoshuaHarris391 JoshuaHarris391 released this 03 Jul 07:00

Reverted

  • The allOf $ref wrapping introduced in v2.5.0 has been reverted (a971677). It was based on a misdiagnosis: Gen3's resolver merges a property's sibling keys over the referenced definition, so the normal sibling form {description: ..., $ref: ...} works fine. The actual cause of "No Description" in the data-dictionary viewer was description: null placeholders in the enum definitions of _definitions.yaml.

What changed

  • format_datetime emits the sibling form {description: ..., $ref: _definitions.yaml#/datetime} — descriptions are still preserved (unlike ≤2.4.0, which silently dropped them), just without the allOf wrapper.
  • The project.yaml and program.yaml templates are back to their 2.4.0 sibling-$ref form.
  • The fix-refs CLI command is removed — do not use it from 2.5.0/2.6.0.

What is kept

  • The description: null warning from v2.6.0 stays in validate: it scans the whole dictionary before resolution and lists every offending definition by file and path (e.g. _definitions.yaml: enum_yes_no.description). Removing those null keys is the actual fix for missing descriptions in the viewer.
  • validate remains tolerant of allOf/anyOf/oneOf-wrapped refs.

If you already ran fix-refs on a dictionary

No action needed: the wrapped form is valid JSON Schema and validate continues to accept it. You may revert the wrapping in your dictionary if you prefer the conventional sibling style, but it is not required.

Full Changelog: v2.6.0...v2.6.1