Merge pull request #18 from ThreeSixtyGiving/fix-adjust-schema

Schema adjustments
ThreeSixtyGiving · Sep 29, 2023 · ef24555 · ef24555
2 parents 487138f + ebbe576
commit ef24555
Showing 1 changed file with 59 additions and 59 deletions.
diff --git a/schema/360-giving-schema.json b/schema/360-giving-schema.json
@@ -1,38 +1,10 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "definitions": {
-    "DEIResponse": {
-      "type": "object",
-      "title": "DEI Response",
-      "description": "A response to a DEI Application area, containing information such as the taxonomy codes selected and any lived experience or geography responses.",
-      "properties": {
-        "taxonomyCodes": {
-          "title": "Taxonomy Codes",
-          "description": "The Taxonomy Codes selected from the DEI Taxonomies. The value for these codes should be drawn from the Taxonomy Codes codelist.",
-          "type": "array",
-          "items": {
-            "type": "string",
-            "codelist": "taxonomyCodes.csv",
-            "openCodelist": false
-          },
-          "uniqueItems": true
-        },
-        "livedExperience": {
-          "type": "string",
-          "title": "Lived Experience",
-          "description": "Description provided that are not drawn from a vocabulary but instead derived from lived experience"
-        },
-        "geography": {
-          "type": "string",
-          "title": "Geography",
-          "description": "Description provided that are not drawn from a vocabulary but instead drawn from Geography"
-        }
-      }
-    },
-    "DEIApplicationArea": {
+    "DeiApplicationArea": {
       "type": "object",
       "title": "DEI Application Area",
-      "description": "A DEI Application area used to collect information about whether a particular question was asked, responded to, and additional information. It also contains the response information under the Response fields.",
+      "description": "A DEI application area used to collect information about whether a particular question was asked, responded to, and additional information. It also contains the response information under the Response fields.",
       "required": [
         "askedStatus"
       ],
@@ -68,40 +40,68 @@
           "description": "A free text field to include any additional details or rationales that may be important to this context."
         },
         "response": {
-          "$ref": "#/definitions/DEIResponse"
+          "type": "object",
+          "title": "DEI Response",
+          "description": "A response to a DEI Application area, containing information such as the taxonomy codes selected and any lived experience or geography responses.",
+          "properties": {
+            "taxonomyCodes": {
+              "title": "Taxonomy Codes",
+              "description": "The Taxonomy Codes selected from the DEI Taxonomies. The value for these codes should be drawn from the Taxonomy Codes codelist.",
+              "type": "array",
+              "items": {
+                "type": "string",
+                "codelist": "taxonomyCodes.csv",
+                "openCodelist": false
+              },
+              "uniqueItems": true
+            },
+            "livedExperience": {
+              "type": "string",
+              "title": "Lived Experience",
+              "description": "A free text description of other types of lived experience that is not drawn from the Taxonomy."
+            },
+            "geography": {
+              "type": "string",
+              "title": "Geography",
+              "description": "A free text description that is not drawn from a vocabulary but instead relates to a particular geographical area."
+            }
+          }
         }
       }
     },
-    "DEIDetails": {
-      "type": "object",
-      "title": "DEI Details",
-      "description": "The DEI Details for this grant. Contains information about separate application areas and the responses to them.",
-      "required": [
-        "leadership",
-        "mission",
-        "project"
-      ],
-      "properties": {
-        "purposes": {
-          "type": "string",
-          "title": "Purposes",
-          "description": "The purposes of collecting this data."
-        },
-        "leadership": {
-          "$ref": "#/definitions/DEIApplicationArea"
-        },
-        "mission": {
-          "$ref": "#/definitions/DEIApplicationArea"
-        },
-        "project": {
-          "$ref": "#/definitions/DEIApplicationArea"
+    "properties": {
+      "deiDetails": {
+        "type": "object",
+        "title": "DEI Details",
+        "description": "The DEI Details for this grant. Contains information about separate application areas and the responses to them.",
+        "required": [
+          "leadership",
+          "mission",
+          "project"
+        ],
+        "properties": {
+          "deiVersion": {
+            "type": "string",
+            "title": "DEI Data Standard Version",
+            "description": "The version of the DEI Data Standard that this data uses e.g. 1.1",
+            "pattern": "^[1-9]+\\.[1-9]\\d*$"
+          },
+          "purposes": {
+            "type": "string",
+            "title": "Purposes",
+            "description": "The purposes of collecting this data."
+          },
+          "leadership": {
+            "$ref": "#/definitions/DeiApplicationArea"
+          },
+          "mission": {
+            "$ref": "#/definitions/DeiApplicationArea"
+          },
+          "project": {
+            "$ref": "#/definitions/DeiApplicationArea"
+          }
         }
       }
     }
-  },
-  "properties": {
-    "deiDetails": {
-      "$ref": "#/definitions/DEIDetails"
-    }
   }
 }