adiwg-mdjson_schemas 2.8.0 → 2.9.0

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdjson-schemas",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "JSON schemas, examples, and templates for ADIwg metadata standards",
   "main": "index.js",
   "directories": {
@@ -10,8 +10,8 @@
   },
   "scripts": {
     "test": "mocha",
-    "prepublishOnly": "scripts/prepublish.js",
-    "pretest": "scripts/prepublish.js"
+    "prepublish": "node scripts/prepublish.js",
+    "release": "npm run prepublish && npm publish"
   },
   "files": [
     "examples",
@@ -43,7 +43,7 @@
     "buildify": "github:powmedia/buildify#20458a121411f759dcc5ec1b441695eb7fc2b3b7",
     "glob": "^7.1.2",
     "mkdirp": "^0.5.1",
-    "mocha": "^5.2.0",
+    "mocha": "^10.2.0",
     "rimraf": "^2.6.1"
   }
 }

data/schema/attribute.json

@@ -106,6 +106,9 @@
       "translation": {
         "ISO 19115-1": ["mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"],
         "FGDC CSDGM": ["no translation"]
+      },
+      "items": {
+        "$ref": "./rangeElementDescription.json#"
       }
     },
     "boundMin": {

data/schema/conformanceResult.json

@@ -2,26 +2,32 @@
   "id": "conformanceResult.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["specification", "pass"],
   "example": "../examples/conformanceResult.json",
-  "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level",
+  "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > conformanceResult"]
   },
   "properties": {
     "dateTime": {
-      "type": "string"
+      "type": "string",
+      "description": "Date when the result was generated."
     },
     "scope": {
-      "$ref": "./scope.json#"
+      "$ref": "./scope.json#",
+      "description": "Scope of the result."
     },
     "specification": {
-      "$ref": "./citation.json#"
+      "$ref": "./citation.json#",
+      "description": "Citation of data product specification or user requirement against which data are being evaluated."
     },
     "explanation": {
-      "type": "string"
+      "type": "string",
+      "description": "Explanation of the meaning of conformance for this result."
     },
     "pass": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "Indication of the conformance result where 0 = fail and 1 = pass. Default: false."
     }
   }
 }

data/schema/coverageResult.json

@@ -2,34 +2,49 @@
   "id": "coverageResult.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
-  "description": "",
+  "required": ["spatialRepresentationType", "spatialRepresentation"],
+  "description": "Result of data quality measure organizing the measured values as a coverage.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > coverageResult"]
   },
+  "anyOf": [
+    {
+      "title": "resourceFormat and resultFile required",
+      "required": ["resourceFormat", "resultFile"]
+    },
+    {
+      "title": "resultContentDescription required",
+      "required": ["resultContentDescription"]
+    }
+  ],
   "properties": {
     "dateTime": {
-      "type": "string"
+      "type": "string",
+      "description": "Date when the result was generated."
     },
     "scope": {
-      "$ref": "./scope.json#"
+      "$ref": "./scope.json#",
+      "description": "Scope of the result."
     },
     "spatialRepresentationType": {
-      "type": "string"
+      "type": "string",
+      "description": "Method used to spatially represent the coverage result."
     },
     "spatialRepresentation": {
-      "$ref": "./spatialRepresentation.json#"
+      "$ref": "./spatialRepresentation.json#",
+      "description": "Provides the digital representation of data quality measures composing the coverage result."
     },
-    "resultContent": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
+    "resultContentDescription": {
+      "$ref": "./coverageDescription.json#",
+      "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."
     },
     "resourceFormat": {
-      "type": "string"
+      "$ref": "./format.json#",
+      "description": "Provides information about the format of the result coverage data."
     },
     "resultFile": {
-      "type": "string"
+      "$ref": "./qualityResultFile.json#",
+      "description": "Provides information about the data file containing the result coverage data."
     }
   }
 }

data/schema/dataQuality.json

@@ -2,29 +2,34 @@
   "id": "dataQuality.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["scope", "report"],
   "example": "../examples/dataQuality.json",
-  "description": "Details about data quality.",
+  "description": "Quality information for the data specified by a data quality scope.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality"]
   },
   "additionalProperties": true,
   "properties": {
     "scope": {
-      "description": "scope of data quality report",
+      "description": "The specific data to which the data quality information applies.",
       "translation": {
         "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > scope"]
       },
       "$ref": "./scope.json#"
     },
     "standaloneQualityReport": {
-      "description": "data quality report in plain written form",
+      "description": "Reference to an external standalone quality report.",
       "translation": {
-        "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
+        "ISO 19115-2": [
+          "MI_Metadata > DQ_DataQuality > standaloneQualityReport"
+        ]
       },
       "$ref": "./standaloneQualityReport.json#"
     },
     "report": {
       "type": "array",
+      "description": "Aspect of quantitative quality information.",
+      "minItems": 1,
       "items": {
         "$ref": "./dataQualityReport.json#"
       }

data/schema/dataQualityReport.json

@@ -2,41 +2,108 @@
   "id": "dataQualityReport.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["type"],
   "example": "../examples/dataQualityReport.json",
-  "description": "Details about data quality.",
+  "description": "Aspect of quantitative quality information.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
   },
+  "anyOf": [
+    {
+      "title": "quantitativeResult is required",
+      "required": ["quantitativeResult"]
+    },
+    {
+      "title": "descriptiveResult is required",
+      "required": ["descriptiveResult"]
+    },
+    {
+      "title": "conformanceResult is required",
+      "required": ["conformanceResult"]
+    },
+    {
+      "title": "coverageResult is required",
+      "required": ["coverageResult"]
+    }
+  ],
   "properties": {
+    "type": {
+      "type": "string",
+      "description": "The type of quality report.",
+      "enum": [
+        "DQ_AbsoluteExternalPositionalAccuracy",
+        "DQ_AccuracyOfATimeMeasurement",
+        "DQ_ConceptualConsistency",
+        "DQ_CompletenessCommission",
+        "DQ_CompletenessOmission",
+        "DQ_Confidence",
+        "DQ_CoverageResult",
+        "DQ_DomainConsistency",
+        "DQ_FormatConsistency",
+        "DQ_GriddedDataPositionalAccuracy",
+        "DQ_Homogeneity",
+        "DQ_NonQuantitativeAttributeCorrectness",
+        "DQ_QuantitativeAttributeAccuracy",
+        "DQ_NonQuantitativeAttributeAccuracy",
+        "DQ_RelativeInternalPositionalAccuracy",
+        "DQ_Representativity",
+        "DQ_TemporalConsistency",
+        "DQ_TemporalValidity",
+        "DQ_ThematicClassisificationCorrectness",
+        "DQ_TopologicalConsistency",
+        "DQ_UsibilityElement",
+        "DQ_Completeness",
+        "DQ_LogicalConsistency",
+        "DQ_PositioinalAccuracy",
+        "DQ_TemporalQuality"
+      ]
+    },
+    "standaloneQualityReportDetails": {
+      "type": "string",
+      "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."
+    },
     "qualityMeasure": {
+      "description": "Reference to measure used.",
       "$ref": "./qualityMeasure.json#"
     },
     "evaluationMethod": {
+      "description": "Evaluation information.",
       "$ref": "./evaluationMethod.json#"
     },
     "quantitativeResult": {
       "type": "array",
+      "description": "The values or information about the value(s) (or set of values) obtained from applying a data quality measure.",
       "items": {
         "$ref": "./quantitativeResult.json#"
       }
     },
     "descriptiveResult": {
       "type": "array",
+      "description": "Data quality descriptive result.",
       "items": {
         "$ref": "./descriptiveResult.json#"
       }
     },
     "conformanceResult": {
       "type": "array",
+      "description": "Information about the outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.",
       "items": {
         "$ref": "./conformanceResult.json#"
       }
     },
     "coverageResult": {
       "type": "array",
+      "description": "Result of a data quality measure organizing the measured values as a coverage.",
       "items": {
         "$ref": "./coverageResult.json#"
       }
+    },
+    "derivedElementReport": {
+      "type": "array",
+      "description": "In case of aggregation or derivation, indicates the original element.",
+      "items": {
+        "$ref": "./dataQualityReport.json#"
+      }
     }
   }
 }

data/schema/descriptiveResult.json

@@ -2,20 +2,24 @@
   "id": "descriptiveResult.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["statement"],
   "example": "../examples/descriptiveResult.json",
-  "description": "",
+  "description": "Data quality descriptive result.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > descriptiveResult"]
   },
   "properties": {
     "dateTime": {
-      "type": "string"
+      "type": "string",
+      "description": "Date when the result was generated."
     },
     "scope": {
-      "$ref": "./scope.json#"
+      "$ref": "./scope.json#",
+      "description": "Scope of the result."
     },
     "statement": {
-      "type": "string"
+      "type": "string",
+      "description": "Textual expression of the descriptive result."
     }
   }
 }

data/schema/evaluationMethod.json

@@ -3,43 +3,64 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "example": "../examples/evaluationMethod.json",
-  "description": "",
+  "description": "Description of the evaluation method and procedure applied.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > evaluationMethod"]
   },
   "properties": {
     "type": {
-      "type": "string"
+      "type": "string",
+      "description": "Type of evaluation method.",
+      "enum": [
+        "DQ_EvaluationMethod",
+        "DQ_DataInspection",
+        "DQ_AggregationDerivation",
+        "DQ_FullInspection",
+        "DQ_IndirectEvaluation",
+        "DQ_SampleBasedInspection"
+      ]
     },
     "dateTime": {
-      "type": "string"
+      "type": "array",
+      "description": "Date or range of dates on which a data quality measure was applied.",
+      "items": {
+        "type": "string"
+      }
     },
     "methodDescription": {
-      "type": "string"
+      "type": "string",
+      "description": "Description of the evaluation method."
     },
     "evaluationProcedure": {
+      "description": "Reference to the procedure information.",
       "$ref": "./citation.json#"
     },
     "referenceDocument": {
       "type": "array",
+      "description": "Information on documents which are referenced in developing and applying a data quality evaluation method.",
       "items": {
         "$ref": "./citation.json#"
       }
     },
     "evaluationMethodType": {
-      "type": "string"
+      "type": "string",
+      "description": "Type of method used to evaluate quality of the data."
     },
     "deductiveSource": {
-      "type": "string"
+      "type": "string",
+      "description": "Information on which data are used as sources in deductive evaluation method."
     },
     "samplingScheme": {
-      "type": "string"
+      "type": "string",
+      "description": "Information of the type of sampling scheme and description of the sampling procedure."
     },
     "lotDescription": {
-      "type": "string"
+      "type": "string",
+      "description": "Information of how lots are defined."
     },
     "samplingRatio": {
-      "type": "string"
+      "type": "string",
+      "description": "Information on how many samples on average are extracted for inspection from each lot of population."
     }
   }
 }

data/schema/qualityMeasure.json

@@ -3,22 +3,36 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "example": "../examples/qualityMeasure.json",
-  "description": "Reference to the measure used",
+  "description": "Reference to the measure used.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality >"]
   },
+  "required": ["description"],
+  "anyOf": [
+    {
+      "title": "identifier optional",
+      "required": ["identifier"]
+    },
+    {
+      "title": "name required if no identifier",
+      "required": ["name"]
+    }
+  ],
   "properties": {
     "identifier": {
+      "description": "Identifier of the measure, value uniquely identifying the measure within a namespace.",
       "$ref": "./identifier.json#"
     },
     "name": {
       "type": "array",
+      "description": "Name of the test applied to the data.",
       "items": {
         "type": "string"
       }
     },
     "description": {
-      "type": "string"
+      "type": "string",
+      "description": "Description of the measure."
     }
   }
 }

data/schema/qualityResultFile.json

@@ -0,0 +1,26 @@
+{
+  "id": "qualityResultFile.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "required": ["fileName", "fileType", "fileDescription", "fileFormat"],
+  "description": "Quality result file.",
+  "translation": {},
+  "properties": {
+    "fileName": {
+      "type": "string",
+      "description": "Name of the result file."
+    },
+    "fileType": {
+      "type": "string",
+      "description": "MIME file type of the result file."
+    },
+    "fileDescription": {
+      "type": "string",
+      "description": "Description of the result file."
+    },
+    "fileFormat": {
+      "$ref": "./format.json#",
+      "description": "Description of the computer language construct that specifies the representation of data objects in a record, file, message, storage device or transmission channel."
+    }
+  }
+}

data/schema/quantitativeResult.json

@@ -2,29 +2,38 @@
   "id": "quantitativeResult.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["value"],
   "example": "../examples/quantitativeResult.json",
-  "description": "",
+  "description": "The values or information about the value(s) (or set of values) obtained from applying a data quality measure.",
   "translation": {
-    "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > Report > quantitativeResult"]
+    "ISO 19115-2": [
+      "MI_Metadata > DQ_DataQuality > Report > quantitativeResult"
+    ]
   },
   "properties": {
     "dateTime": {
-      "type": "string"
+      "type": "string",
+      "description": "Date when the result was generated."
     },
     "scope": {
-      "$ref": "./scope.json#"
+      "$ref": "./scope.json#",
+      "description": "Scope of the result."
     },
     "value": {
       "type": "array",
+      "description": "Quantitative value or values, content determined by the evaluation procedure used, accordingly with the value type and valueStructure defined for the measure.",
+      "minItems": 1,
       "items": {
         "type": "number"
       }
     },
     "valueUnits": {
-      "type": "string"
+      "type": "string",
+      "description": "Value unit for reporting a data quality result."
     },
     "valueRecordType": {
-      "type": "string"
+      "type": "string",
+      "description": "Value type for reporting a data quality result, depends of the implementation."
     }
   }
 }

data/schema/rangeElementDescription.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "rangeElementDescription.json#",
+  "type": "object",
+  "title": "",
+  "description": "provides definitions and values for range elements such as missing data or other flags associated with a Sample Dimension.",
+  "example": "../examples/rangeElementDescription.json",
+  "translation": {
+    "ISO 19115-1": [
+      "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
+    ],
+    "FGDC CSDGM": ["no translation"]
+  },
+  "required": ["name", "definition", "rangeElement"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "designation associated with a set of range elements.",
+      "translation": {
+        "ISO 19115-1": [
+          "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
+        ],
+        "FGDC CSDGM": ["no translation"]
+      }
+    },
+    "definition": {
+      "type": "string",
+      "description": "description of a set of specific range elements.",
+      "translation": {
+        "ISO 19115-1": [
+          "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
+        ],
+        "FGDC CSDGM": ["no translation"]
+      }
+    },
+    "rangeElement": {
+      "type": "array",
+      "description": "specific range elements, i.e. range elements associated with a name and their definition.",
+      "translation": {
+        "ISO 19115-1": [
+          "mrc:MD_CoverageDescription > mrc:attributeGroup > mrc:attribute > mrc:MD_SampleDimension"
+        ],
+        "FGDC CSDGM": ["no translation"]
+      },
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}

data/schema/schema.json

@@ -1,7 +1,7 @@
 {
   "id": "schema.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "schema for ADIwg mdJSON metadata",
   "example": "../examples/mdJson.json",
   "type": "object",

data/schema/standaloneQualityReport.json

@@ -2,24 +2,28 @@
   "id": "standaloneQualityReport.json#",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
+  "required": ["reportReference", "abstract"],
   "example": "../examples/standaloneQualityReport.json",
-  "description": "Details about data quality.",
+  "description": "Reference to an external standalone quality report.",
   "translation": {
     "ISO 19115-2": ["MI_Metadata > DQ_DataQuality > standaloneQualityReport"]
   },
-  "required": ["abstract"],
   "properties": {
     "reportReference": {
+      "description": "Reference to the associated standalone quality report.",
       "translation": {
-        "ISO 19115-2": ["DQ_DataQuality > standaloneQualityReport > reportReference"]
+        "ISO 19115-2": [
+          "DQ_DataQuality > standaloneQualityReport > reportReference"
+        ]
       },
       "$ref": "./citation.json#"
     },
     "abstract": {
+      "type": "string",
+      "description": "Abstract for the associated standalone quality report.",
       "translation": {
         "ISO 19115-2": ["DQ_DataQuality > standaloneQualityReport > abstract"]
-      },
-      "type": "string"
+      }
     }
   }
 }