From fffa5fcb97751c9ebc88dbaa3259e5a4c5024e3f Mon Sep 17 00:00:00 2001 From: Jakob Voss Date: Wed, 11 Dec 2024 17:32:09 +0100 Subject: [PATCH] Introduce name "MQA Schema" (#100) --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9ebd9b0c..bc1eaa30 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ digital collections. * [Quality dimensions](#quality-dimensions) * [Running as command-line application](#running-as-command-line-application) * [Using the library](#using-the-library) - * [Defining schema with a configuration file](#defining-schema-with-a-configuration-file) + * [Defining schema with a MQA Schema file](#defining-schema-with-a-mqa-schema-file) + [Rules](#rules) - [Cardinality](#cardinality) * [`minCount `](#mincount-number) @@ -97,8 +97,8 @@ usage: * `-n,--inputFormat ` (optional, String) The format of input file. Right now it supports two JSON variants: * `ndjson`: line delimited JSON in which every line is a new record (the default value) * `json-array`: JSON file that contains an array of objects -* `-s,--schema ` Schema file describing the metadata structure to run assessment against. -* `-v,--schemaFormat ` Format of schema file: json, yaml. Default: based on file extension, else json. +* `-s,--schema ` MQA Schema file describing the metadata structure to run assessment against. +* `-v,--schemaFormat ` Format of MQA Schema file: json, yaml. Default: based on file extension, else json. * `-m,--measurements ` Configuration file for measurements. * `-w,--measurementsFormat ` Format of measurements config file: json, yaml. Default: based on file extension, else json. * `-o,--output ` Output file. @@ -382,9 +382,9 @@ while (iterator.hasNext()) { String metrics = output.toString(); ``` -## Defining schema with a configuration file +## Defining schema with a MQA Schema file -It is possible to define the schema with a YAML or JSON configuration file. +Schemas can be defined using the **MQA Schema** language. A MQA Schema can be given as YAML file or as JSON file. ``` Schema schema = ConfigurationReader @@ -392,7 +392,7 @@ Schema schema = ConfigurationReader .asSchema(); ``` -A YAML example: +A MQA Schema in YAML syntax: ```yaml format: json @@ -433,7 +433,7 @@ groups: - MANDATORY ``` -The same in JSON: +The same in JSON syntax: ```json {