adiwg-mdjson_schemas 2.8.1 → 2.9.1

Sign up to get free protection for your applications and to get access to all the features.
data/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mdjson-schemas",
3
- "version": "2.8.1",
3
+ "version": "2.9.1",
4
4
  "description": "JSON schemas, examples, and templates for ADIwg metadata standards",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -10,8 +10,8 @@
10
10
  },
11
11
  "scripts": {
12
12
  "test": "mocha",
13
- "prepublishOnly": "scripts/prepublish.js",
14
- "pretest": "scripts/prepublish.js"
13
+ "prepublish": "node scripts/prepublish.js",
14
+ "release": "npm run prepublish && npm publish"
15
15
  },
16
16
  "files": [
17
17
  "examples",
@@ -106,6 +106,9 @@
106
106
  "translation": {
107
107
  "ISO 19115-1": ["mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"],
108
108
  "FGDC CSDGM": ["no translation"]
109
+ },
110
+ "items": {
111
+ "$ref": "./rangeElementDescription.json#"
109
112
  }
110
113
  },
111
114
  "boundMin": {
@@ -2,26 +2,32 @@
2
2
  "id": "conformanceResult.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["specification", "pass"],
5
6
  "example": "../examples/conformanceResult.json",
6
- "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level",
7
+ "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.",
7
8
  "translation": {
8
9
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > conformanceResult"]
9
10
  },
10
11
  "properties": {
11
12
  "dateTime": {
12
- "type": "string"
13
+ "type": "string",
14
+ "description": "Date when the result was generated."
13
15
  },
14
16
  "scope": {
15
- "$ref": "./scope.json#"
17
+ "$ref": "./scope.json#",
18
+ "description": "Scope of the result."
16
19
  },
17
20
  "specification": {
18
- "$ref": "./citation.json#"
21
+ "$ref": "./citation.json#",
22
+ "description": "Citation of data product specification or user requirement against which data are being evaluated."
19
23
  },
20
24
  "explanation": {
21
- "type": "string"
25
+ "type": "string",
26
+ "description": "Explanation of the meaning of conformance for this result."
22
27
  },
23
28
  "pass": {
24
- "type": "boolean"
29
+ "type": "boolean",
30
+ "description": "Indication of the conformance result where 0 = fail and 1 = pass. Default: false."
25
31
  }
26
32
  }
27
33
  }
@@ -2,34 +2,49 @@
2
2
  "id": "coverageResult.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
- "description": "",
5
+ "required": ["spatialRepresentationType", "spatialRepresentation"],
6
+ "description": "Result of data quality measure organizing the measured values as a coverage.",
6
7
  "translation": {
7
8
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > coverageResult"]
8
9
  },
10
+ "anyOf": [
11
+ {
12
+ "title": "resourceFormat and resultFile required",
13
+ "required": ["resourceFormat", "resultFile"]
14
+ },
15
+ {
16
+ "title": "resultContentDescription required",
17
+ "required": ["resultContentDescription"]
18
+ }
19
+ ],
9
20
  "properties": {
10
21
  "dateTime": {
11
- "type": "string"
22
+ "type": "string",
23
+ "description": "Date when the result was generated."
12
24
  },
13
25
  "scope": {
14
- "$ref": "./scope.json#"
26
+ "$ref": "./scope.json#",
27
+ "description": "Scope of the result."
15
28
  },
16
29
  "spatialRepresentationType": {
17
- "type": "string"
30
+ "type": "string",
31
+ "description": "Method used to spatially represent the coverage result."
18
32
  },
19
33
  "spatialRepresentation": {
20
- "$ref": "./spatialRepresentation.json#"
34
+ "$ref": "./spatialRepresentation.json#",
35
+ "description": "Provides the digital representation of data quality measures composing the coverage result."
21
36
  },
22
- "resultContent": {
23
- "type": "array",
24
- "items": {
25
- "type": "string"
26
- }
37
+ "resultContentDescription": {
38
+ "$ref": "./coverageDescription.json#",
39
+ "description": "Provides the description of the content of the result coverage when the quality coverage is included with the resource being described. i.e. semantic definition of the data quality measures."
27
40
  },
28
41
  "resourceFormat": {
29
- "type": "string"
42
+ "$ref": "./format.json#",
43
+ "description": "Provides information about the format of the result coverage data."
30
44
  },
31
45
  "resultFile": {
32
- "type": "string"
46
+ "$ref": "./qualityResultFile.json#",
47
+ "description": "Provides information about the data file containing the result coverage data."
33
48
  }
34
49
  }
35
50
  }
@@ -2,29 +2,34 @@
2
2
  "id": "dataQuality.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["scope", "report"],
5
6
  "example": "../examples/dataQuality.json",
6
- "description": "Details about data quality.",
7
+ "description": "Quality information for the data specified by a data quality scope.",
7
8
  "translation": {
8
9
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality"]
9
10
  },
10
11
  "additionalProperties": true,
11
12
  "properties": {
12
13
  "scope": {
13
- "description": "scope of data quality report",
14
+ "description": "The specific data to which the data quality information applies.",
14
15
  "translation": {
15
16
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > scope"]
16
17
  },
17
18
  "$ref": "./scope.json#"
18
19
  },
19
20
  "standaloneQualityReport": {
20
- "description": "data quality report in plain written form",
21
+ "description": "Reference to an external standalone quality report.",
21
22
  "translation": {
22
- "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
23
+ "ISO 19115-2": [
24
+ "MI_Metadata > DQ_DataQuality > standaloneQualityReport"
25
+ ]
23
26
  },
24
27
  "$ref": "./standaloneQualityReport.json#"
25
28
  },
26
29
  "report": {
27
30
  "type": "array",
31
+ "description": "Aspect of quantitative quality information.",
32
+ "minItems": 1,
28
33
  "items": {
29
34
  "$ref": "./dataQualityReport.json#"
30
35
  }
@@ -2,43 +2,114 @@
2
2
  "id": "dataQualityReport.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["type"],
5
6
  "example": "../examples/dataQualityReport.json",
6
- "description": "Details about data quality.",
7
+ "description": "Aspect of quantitative quality information.",
7
8
  "translation": {
8
9
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
9
10
  },
11
+ "anyOf": [
12
+ {
13
+ "title": "quantitativeResult is required",
14
+ "required": ["quantitativeResult"]
15
+ },
16
+ {
17
+ "title": "descriptiveResult is required",
18
+ "required": ["descriptiveResult"]
19
+ },
20
+ {
21
+ "title": "conformanceResult is required",
22
+ "required": ["conformanceResult"]
23
+ },
24
+ {
25
+ "title": "coverageResult is required",
26
+ "required": ["coverageResult"]
27
+ }
28
+ ],
10
29
  "properties": {
30
+ "type": {
31
+ "type": "string",
32
+ "description": "The type of quality report.",
33
+ "translation": {
34
+ "ISO 19115-2": [
35
+ "MI_Metadata > DQ_DataQuality > Report > [DQ_Element type]"
36
+ ],
37
+ "FDGD CSDGM": ["no translation"],
38
+ "DCAT": ["no translation"]
39
+ },
40
+ "enum": [
41
+ "AbsoluteExternalPositionalAccuracy",
42
+ "AccuracyOfATimeMeasurement",
43
+ "ConceptualConsistency",
44
+ "CompletenessCommission",
45
+ "CompletenessOmission",
46
+ "Confidence",
47
+ "CoverageResult",
48
+ "DomainConsistency",
49
+ "FormatConsistency",
50
+ "GriddedDataPositionalAccuracy",
51
+ "Homogeneity",
52
+ "NonQuantitativeAttributeCorrectness",
53
+ "QuantitativeAttributeAccuracy",
54
+ "NonQuantitativeAttributeAccuracy",
55
+ "RelativeInternalPositionalAccuracy",
56
+ "Representativity",
57
+ "TemporalConsistency",
58
+ "TemporalValidity",
59
+ "ThematicClassisificationCorrectness",
60
+ "TopologicalConsistency",
61
+ "UsibilityElement",
62
+ "Completeness",
63
+ "LogicalConsistency",
64
+ "PositioinalAccuracy",
65
+ "TemporalQuality"
66
+ ]
67
+ },
68
+ "standaloneQualityReportDetails": {
69
+ "type": "string",
70
+ "description": "Clause in the standaloneQualityReport where this data quality element or any related data quality element (original results in case of derivation or aggregation) is described."
71
+ },
11
72
  "qualityMeasure": {
73
+ "description": "Reference to measure used.",
12
74
  "$ref": "./qualityMeasure.json#"
13
75
  },
14
- "conformanceResult": {
76
+ "evaluationMethod": {
77
+ "description": "Evaluation information.",
78
+ "$ref": "./evaluationMethod.json#"
79
+ },
80
+ "quantitativeResult": {
15
81
  "type": "array",
82
+ "description": "The values or information about the value(s) (or set of values) obtained from applying a data quality measure.",
16
83
  "items": {
17
- "$ref": "./conformanceResult.json#"
84
+ "$ref": "./quantitativeResult.json#"
18
85
  }
19
86
  },
20
- "coverageResult": {
87
+ "descriptiveResult": {
21
88
  "type": "array",
89
+ "description": "Data quality descriptive result.",
22
90
  "items": {
23
- "$ref": "./coverageResult.json#"
91
+ "$ref": "./descriptiveResult.json#"
24
92
  }
25
93
  },
26
- "descriptiveResult": {
94
+ "conformanceResult": {
27
95
  "type": "array",
96
+ "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.",
28
97
  "items": {
29
- "$ref": "./descriptiveResult.json#"
98
+ "$ref": "./conformanceResult.json#"
30
99
  }
31
100
  },
32
- "evaluationMethod": {
101
+ "coverageResult": {
33
102
  "type": "array",
103
+ "description": "Result of a data quality measure organizing the measured values as a coverage.",
34
104
  "items": {
35
- "$ref": "./evaluationMethod.json#"
105
+ "$ref": "./coverageResult.json#"
36
106
  }
37
107
  },
38
- "quantitativeResult": {
108
+ "derivedElementReport": {
39
109
  "type": "array",
110
+ "description": "In case of aggregation or derivation, indicates the original element.",
40
111
  "items": {
41
- "$ref": "./quantitativeResult.json#"
112
+ "$ref": "./dataQualityReport.json#"
42
113
  }
43
114
  }
44
115
  }
@@ -2,20 +2,24 @@
2
2
  "id": "descriptiveResult.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["statement"],
5
6
  "example": "../examples/descriptiveResult.json",
6
- "description": "",
7
+ "description": "Data quality descriptive result.",
7
8
  "translation": {
8
9
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > descriptiveResult"]
9
10
  },
10
11
  "properties": {
11
12
  "dateTime": {
12
- "type": "string"
13
+ "type": "string",
14
+ "description": "Date when the result was generated."
13
15
  },
14
16
  "scope": {
15
- "$ref": "./scope.json#"
17
+ "$ref": "./scope.json#",
18
+ "description": "Scope of the result."
16
19
  },
17
20
  "statement": {
18
- "type": "string"
21
+ "type": "string",
22
+ "description": "Textual expression of the descriptive result."
19
23
  }
20
24
  }
21
25
  }
@@ -3,43 +3,64 @@
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
5
  "example": "../examples/evaluationMethod.json",
6
- "description": "",
6
+ "description": "Description of the evaluation method and procedure applied.",
7
7
  "translation": {
8
8
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > evaluationMethod"]
9
9
  },
10
10
  "properties": {
11
11
  "type": {
12
- "type": "string"
12
+ "type": "string",
13
+ "description": "Type of evaluation method.",
14
+ "enum": [
15
+ "DQ_EvaluationMethod",
16
+ "DQ_DataInspection",
17
+ "DQ_AggregationDerivation",
18
+ "DQ_FullInspection",
19
+ "DQ_IndirectEvaluation",
20
+ "DQ_SampleBasedInspection"
21
+ ]
13
22
  },
14
23
  "dateTime": {
15
- "type": "string"
24
+ "type": "array",
25
+ "description": "Date or range of dates on which a data quality measure was applied.",
26
+ "items": {
27
+ "type": "string"
28
+ }
16
29
  },
17
30
  "methodDescription": {
18
- "type": "string"
31
+ "type": "string",
32
+ "description": "Description of the evaluation method."
19
33
  },
20
34
  "evaluationProcedure": {
35
+ "description": "Reference to the procedure information.",
21
36
  "$ref": "./citation.json#"
22
37
  },
23
38
  "referenceDocument": {
24
39
  "type": "array",
40
+ "description": "Information on documents which are referenced in developing and applying a data quality evaluation method.",
25
41
  "items": {
26
42
  "$ref": "./citation.json#"
27
43
  }
28
44
  },
29
45
  "evaluationMethodType": {
30
- "type": "string"
46
+ "type": "string",
47
+ "description": "Type of method used to evaluate quality of the data."
31
48
  },
32
49
  "deductiveSource": {
33
- "type": "string"
50
+ "type": "string",
51
+ "description": "Information on which data are used as sources in deductive evaluation method."
34
52
  },
35
53
  "samplingScheme": {
36
- "type": "string"
54
+ "type": "string",
55
+ "description": "Information of the type of sampling scheme and description of the sampling procedure."
37
56
  },
38
57
  "lotDescription": {
39
- "type": "string"
58
+ "type": "string",
59
+ "description": "Information of how lots are defined."
40
60
  },
41
61
  "samplingRatio": {
42
- "type": "string"
62
+ "type": "string",
63
+ "description": "Information on how many samples on average are extracted for inspection from each lot of population."
43
64
  }
44
65
  }
45
66
  }
@@ -3,22 +3,36 @@
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
5
  "example": "../examples/qualityMeasure.json",
6
- "description": "Reference to the measure used",
6
+ "description": "Reference to the measure used.",
7
7
  "translation": {
8
8
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality >"]
9
9
  },
10
+ "required": ["description"],
11
+ "anyOf": [
12
+ {
13
+ "title": "identifier optional",
14
+ "required": ["identifier"]
15
+ },
16
+ {
17
+ "title": "name required if no identifier",
18
+ "required": ["name"]
19
+ }
20
+ ],
10
21
  "properties": {
11
22
  "identifier": {
23
+ "description": "Identifier of the measure, value uniquely identifying the measure within a namespace.",
12
24
  "$ref": "./identifier.json#"
13
25
  },
14
26
  "name": {
15
27
  "type": "array",
28
+ "description": "Name of the test applied to the data.",
16
29
  "items": {
17
30
  "type": "string"
18
31
  }
19
32
  },
20
33
  "description": {
21
- "type": "string"
34
+ "type": "string",
35
+ "description": "Description of the measure."
22
36
  }
23
37
  }
24
38
  }
@@ -0,0 +1,26 @@
1
+ {
2
+ "id": "qualityResultFile.json#",
3
+ "$schema": "http://json-schema.org/draft-04/schema#",
4
+ "type": "object",
5
+ "required": ["fileName", "fileType", "fileDescription", "fileFormat"],
6
+ "description": "Quality result file.",
7
+ "translation": {},
8
+ "properties": {
9
+ "fileName": {
10
+ "type": "string",
11
+ "description": "Name of the result file."
12
+ },
13
+ "fileType": {
14
+ "type": "string",
15
+ "description": "MIME file type of the result file."
16
+ },
17
+ "fileDescription": {
18
+ "type": "string",
19
+ "description": "Description of the result file."
20
+ },
21
+ "fileFormat": {
22
+ "$ref": "./format.json#",
23
+ "description": "Description of the computer language construct that specifies the representation of data objects in a record, file, message, storage device or transmission channel."
24
+ }
25
+ }
26
+ }
@@ -2,29 +2,38 @@
2
2
  "id": "quantitativeResult.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["value"],
5
6
  "example": "../examples/quantitativeResult.json",
6
- "description": "",
7
+ "description": "The values or information about the value(s) (or set of values) obtained from applying a data quality measure.",
7
8
  "translation": {
8
- "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > quantitativeResult"]
9
+ "ISO 19115-2": [
10
+ "MI_Metadata > DQ_DataQuality > Report > quantitativeResult"
11
+ ]
9
12
  },
10
13
  "properties": {
11
14
  "dateTime": {
12
- "type": "string"
15
+ "type": "string",
16
+ "description": "Date when the result was generated."
13
17
  },
14
18
  "scope": {
15
- "$ref": "./scope.json#"
19
+ "$ref": "./scope.json#",
20
+ "description": "Scope of the result."
16
21
  },
17
22
  "value": {
18
23
  "type": "array",
24
+ "description": "Quantitative value or values, content determined by the evaluation procedure used, accordingly with the value type and valueStructure defined for the measure.",
25
+ "minItems": 1,
19
26
  "items": {
20
27
  "type": "number"
21
28
  }
22
29
  },
23
30
  "valueUnits": {
24
- "type": "string"
31
+ "type": "string",
32
+ "description": "Value unit for reporting a data quality result."
25
33
  },
26
34
  "valueRecordType": {
27
- "type": "string"
35
+ "type": "string",
36
+ "description": "Value type for reporting a data quality result, depends of the implementation."
28
37
  }
29
38
  }
30
39
  }
@@ -0,0 +1,51 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "rangeElementDescription.json#",
4
+ "type": "object",
5
+ "title": "",
6
+ "description": "provides definitions and values for range elements such as missing data or other flags associated with a Sample Dimension.",
7
+ "example": "../examples/rangeElementDescription.json",
8
+ "translation": {
9
+ "ISO 19115-1": [
10
+ "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
11
+ ],
12
+ "FGDC CSDGM": ["no translation"]
13
+ },
14
+ "required": ["name", "definition", "rangeElement"],
15
+ "properties": {
16
+ "name": {
17
+ "type": "string",
18
+ "description": "designation associated with a set of range elements.",
19
+ "translation": {
20
+ "ISO 19115-1": [
21
+ "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
22
+ ],
23
+ "FGDC CSDGM": ["no translation"]
24
+ }
25
+ },
26
+ "definition": {
27
+ "type": "string",
28
+ "description": "description of a set of specific range elements.",
29
+ "translation": {
30
+ "ISO 19115-1": [
31
+ "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
32
+ ],
33
+ "FGDC CSDGM": ["no translation"]
34
+ }
35
+ },
36
+ "rangeElement": {
37
+ "type": "array",
38
+ "description": "specific range elements, i.e. range elements associated with a name and their definition.",
39
+ "translation": {
40
+ "ISO 19115-1": [
41
+ "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
42
+ ],
43
+ "FGDC CSDGM": ["no translation"]
44
+ },
45
+ "minItems": 1,
46
+ "items": {
47
+ "type": "string"
48
+ }
49
+ }
50
+ }
51
+ }
data/schema/schema.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "id": "schema.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "version": "2.8.1",
4
+ "version": "2.9.1",
5
5
  "description": "schema for ADIwg mdJSON metadata",
6
6
  "example": "../examples/mdJson.json",
7
7
  "type": "object",
@@ -2,23 +2,28 @@
2
2
  "id": "standaloneQualityReport.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
4
  "type": "object",
5
+ "required": ["reportReference", "abstract"],
5
6
  "example": "../examples/standaloneQualityReport.json",
6
- "description": "Details about data quality.",
7
+ "description": "Reference to an external standalone quality report.",
7
8
  "translation": {
8
9
  "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
9
10
  },
10
11
  "properties": {
11
12
  "reportReference": {
13
+ "description": "Reference to the associated standalone quality report.",
12
14
  "translation": {
13
- "ISO 19115-2": ["DQ_DataQuality > standaloneQualityReport > reportReference"]
15
+ "ISO 19115-2": [
16
+ "DQ_DataQuality > standaloneQualityReport > reportReference"
17
+ ]
14
18
  },
15
19
  "$ref": "./citation.json#"
16
20
  },
17
21
  "abstract": {
22
+ "type": "string",
23
+ "description": "Abstract for the associated standalone quality report.",
18
24
  "translation": {
19
25
  "ISO 19115-2": ["DQ_DataQuality > standaloneQualityReport > abstract"]
20
- },
21
- "type": "string"
26
+ }
22
27
  }
23
28
  }
24
29
  }