pkiraly/metadata-qa-api

Add official name and meta-schema of schema format

Opened this issue · 1 comments

The schema format described at https://github.com/pkiraly/metadata-qa-api#defining-schema-with-a-configuration-file should get

  • a name (how about "MQA Schema"?)
  • one or more meta-schemas (I could create a JSON Schema).

Each meta-schema should also get a resolveable URI.

@nichtich Thanks for the suggestion! The name is fine.
I do not really get the idea of "one or more meta-schemas". Are you talking validating this meta-schema? So JSON Schema could validate the serialization of a concrete instance of a meta-schema.
Right now this meta schema is defined as a Java class, and there are so called marshalling tools which could transform JSON and YAML strings to Java object of this type. When the program is initialized, this transformation happens and these marshalling tools throw exceptions if the YAML/JSON serialization is invalid. A JSON Schema could be used as an allternative for this validation. I do not know if there is such a thing, but I could imagine that there exists an editor which helps you to create a meta-schema instance if we provide a JSON schema. If such a thing exists JSON Schema is more than welcome. Do you happen to know if there is YAML Schema as well?
Or you might mean instances of meta-schema, here are some examples for Deutsche Digitale Bibliothek: https://github.com/pkiraly/metadata-qa-ddb/tree/main/src/main/resources. This repository also contains some examples. But I guess you are talking about the first option.