Skip to content

Align JSON Schema with amended Metadata Spec#89

Open
sthagen wants to merge 16 commits intomainfrom
align-json-schema-with-amended-metadata-spec
Open

Align JSON Schema with amended Metadata Spec#89
sthagen wants to merge 16 commits intomainfrom
align-json-schema-with-amended-metadata-spec

Conversation

@sthagen
Copy link
Contributor

@sthagen sthagen commented Jan 20, 2026

  • seeded the feature branch
  • added the latest schema from the contribution area as baseline
  • ensud all validations are enforced as intended
  • aligned the JSON schema with the new information model

- [x] seeded the feature branch
- [ ] aligned the JSON schema with the new information model
Signed-off-by: Stefan Hagen <stefan@hagen.link>
LisaBobbitt
LisaBobbitt previously approved these changes Jan 20, 2026
- All vocabularies that can be used are defined in this configuration 
  schema because the JSON schema 2020-12 dialect has the rule
   of non-inheritability of vocabularies.
   Cf. https://json-schema.org/draft/2020-12/json-schema-core#name-non-inheritability-of-vocab
  - 'Note that the processing restrictions on $vocabulary mean 
     that meta-schemas that reference other meta-schemas using 
     $ref or similar keywords do not automatically inherit the 
     vocabulary declarations of those other meta-schemas.
     All such declarations must be repeated in the root of each 
     schema document intended for use as a meta-schema.' (ibid)
@sthagen
Copy link
Contributor Author

sthagen commented Jan 27, 2026

^^^ @claurau it seems that the change #88 (comment) in the settings did not work as intended. Amending to a pull request should not dismiss prior reviews. Can you maybe kindly fix that? Thanks.

@claurau
Copy link

claurau commented Jan 28, 2026

^^^ @claurau it seems that the change #88 (comment) in the settings did not work as intended. Amending to a pull request should not dismiss prior reviews. Can you maybe kindly fix that? Thanks.

Sorry, it should work now.

@sthagen
Copy link
Contributor Author

sthagen commented Jan 28, 2026

Thank you, @claurau.

@ncjamieyu
Copy link

@sthagen Found a number of schema syntax errors in data-provenance.json file:

(1) incorrect reference for "address" in line 639. In addition, the schema also incorrectly uses "type": "#/$defs/..." in several places. For custom definitions, replace "type with "$ref".

(2) "examples" keyword must be an array. To fix this, wrap the "example" object in square brackets to make it an array like this: "examples": [{...}]

(3) inconsistent version type. The "schema-version" is set as "1.0", however, the schema itself enforces version type check ("#/$defs/version-type") in multiple attributes related to version. It's better to be consistent to avoid confusion. I recommend setting the "schema-version" as "1.0.0" (Major.Minor.Patch) instead. This is more of a preference, not a must.

These are fairly simple to fix yourself. Or, let me know if you want me to submit a new commit with the fixed version. I'm fine either way. Thanks!

- fixed remaining leftovers from type references of incoming DTA schema (use of dollar-ref)
- fixed the one examples entry that was not wrapped in an array (still the underlying type
  is work in progress cf. the comment in the schema at teh place of type definition)
- the version type is compatible with the schema-version constant (enum).
  OASIS json schema versions can barely keep up with major and minor schema, so the
  feedback (3) was considered but not followed. The version-type is open for any
  version values we may need for external artifacts (those that json instances compliant
  to our schema describe).

Signed-off-by: Stefan Hagen <stefan@hagen.link>
- added dollar-schema top level member that was required but missing
- simplified the enums to constants
- updated the spec draft to contain a first draft of the JSON schema,
  the next meeting date as snapshot / date info, update boilerplate
  of the annexes and appendices to the latest version, added
  the secretary on frontmatter and in leadership section of appendix 1,
  added the artifacts and namespaces to the frontmatter as per latest
  outline, removed the old notices appendix, cleansed a bit the table
  of contents
- Cleansed some keys in the tables (the newly added keys) to conform
  to the shape of the others, formatted some tables to have aligned columns
- work in process

Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
… more outlines in the json section

- tables should have captions to best support user facing delivery items
- two date like members missed the format constraint in json schema
- added outlines for all top level members
- fixed inconsistent naming in JADN tables
- added conventional fixed font markup for the type names in the JADN section table captions

Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
…ady there

Signed-off-by: Stefan Hagen <stefan@hagen.link>
Signed-off-by: Stefan Hagen <stefan@hagen.link>
…UID type table

Signed-off-by: Stefan Hagen <stefan@hagen.link>
@LisaBobbitt
Copy link
Contributor

Ready to go out for review

@LisaBobbitt LisaBobbitt reopened this Feb 24, 2026
Signed-off-by: Stefan Hagen <stefan@hagen.link>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants