Merge pull request #61 from norc-heal/fix/additionalProperties

Fix: additional properties to false for all levels
HEAL · Jun 21, 2024 · 0262e08 · 0262e08
2 parents 147b977 + c9689a4
commit 0262e08
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 7 deletions.
diff --git a/VERSIONS.json b/VERSIONS.json
@@ -1,4 +1,4 @@
 {
     "slmd":"1.0.0",
-    "vlmd":"0.3.1"
+    "vlmd":"0.3.2"
 }
diff --git a/variable-level-metadata-schema/build.py b/variable-level-metadata-schema/build.py
@@ -139,6 +139,13 @@ def flatten_properties(properties, parentkey="", sep=".",itemsep="\[\d+\]"):
     return properties_flattened
 
 def flatten_schema(schema):
+    """ 
+    Flatten a schema of type object with properties. 
+    
+    If a regular expression indicating a list index exists, puts this
+    under `patternProperties`
+    
+    """ 
     schema_flattened = dict(schema)
     if "properties" in schema:
         properties = schema_flattened.pop("properties")

diff --git a/variable-level-metadata-schema/docs/csvtemplate-fields.md b/variable-level-metadata-schema/docs/csvtemplate-fields.md
@@ -1,6 +1,6 @@
 # HEAL Variable Level Metadata Fields 
 
-_version 0.3.1_
+_version 0.3.2_
 
 <!-- Below annotation is specific for folks filling out the csv template
 and so is put here rather than in the actual schema annotations.

diff --git a/variable-level-metadata-schema/docs/jsontemplate-data-dictionary.md b/variable-level-metadata-schema/docs/jsontemplate-data-dictionary.md
@@ -1,6 +1,6 @@
 # Variable Level Metadata (Data Dictionaries) 
 
-_version 0.3.1_
+_version 0.3.2_
 
 This schema defines the variable level metadata for one data dictionary for a given study.Note a given study can have multiple data dictionaries.
 

diff --git a/variable-level-metadata-schema/examples/valid/template_submission.json b/variable-level-metadata-schema/examples/valid/template_submission.json
@@ -30,7 +30,7 @@
                     "8"
                 ]
             },
-            "encodings": {
+            "enumLabels": {
                 "1": "White",
                 "2": "Black or African American",
                 "3": "American Indian or Alaska Native",

diff --git a/variable-level-metadata-schema/schemas/csvtemplate/fields.json b/variable-level-metadata-schema/schemas/csvtemplate/fields.json
@@ -1,12 +1,13 @@
 {
-    "version": "0.3.1",
+    "version": "0.3.2",
     "title": "HEAL Variable Level Metadata Fields",
     "description": "\n\n!!! note \"Highly encouraged\"\n\n  - Only `name` and `description` properties are required. \n  - For categorical variables, `constraints.enum` and `enumLabels` (where applicable) properties are highly encouraged. \n  - For studies using HEAL or other common data elements (CDEs), `standardsMappings` information is highly encouraged.\n  - `type` and `format` properties may be particularly useful for some variable types (e.g. date-like variables)\n",
     "type": "object",
     "required": [
         "name",
         "description"
     ],
+    "additionalProperties": false,
     "properties": {
         "schemaVersion": {
             "type": "string",

diff --git a/variable-level-metadata-schema/schemas/data-dictionary.json b/variable-level-metadata-schema/schemas/data-dictionary.json
@@ -1,5 +1,5 @@
 {
-    "version": "0.3.1",
+    "version": "0.3.2",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "vlmd",
     "title": "Variable Level Metadata (Data Dictionaries)",
@@ -9,6 +9,7 @@
         "title",
         "fields"
     ],
+    "additionalProperties": false,
     "properties": {
         "title": {
             "type": "string"
@@ -92,6 +93,7 @@
                     "name",
                     "description"
                 ],
+                "additionalProperties": false,
                 "properties": {
                     "schemaVersion": {
                         "type": "string",

diff --git a/variable-level-metadata-schema/schemas/dictionary/data-dictionary.yaml b/variable-level-metadata-schema/schemas/dictionary/data-dictionary.yaml
@@ -7,6 +7,7 @@ type: object
 required:
 - title
 - fields
+additionalProperties: false
 properties:
   title:
     type: string
@@ -47,3 +48,4 @@ propertyNames:
     - missingValues
     - primaryKey
     - foreignKeys
+
diff --git a/variable-level-metadata-schema/schemas/dictionary/fields.yaml b/variable-level-metadata-schema/schemas/dictionary/fields.yaml
@@ -12,6 +12,7 @@ type: object
 required:
   - name
   - description
+additionalProperties: false
 properties:
   schemaVersion:
     $ref: "#/_definitions/schemaVersion"

diff --git a/variable-level-metadata-schema/tests/test_examples.py b/variable-level-metadata-schema/tests/test_examples.py
@@ -60,7 +60,7 @@ def test_valid_json_data_dictionaries():
     jsonreports = []
     for filepath in jsons:
         report = to_summary(filepath)
-        assert report["valid"],f"# this example is invalid but is intended to be valid:\n\n {str(filepath)}\n\n{report_summary}"
+        assert report["valid"],f"# this example is invalid but is intended to be valid:\n\n {json.dumps(report['errors'],indent=2)}"
 
 
 def test_invalid_csv_data_dictionaries():