nest materials within proposal or property details

theopensystemslab · Mar 12, 2024 · 16ca11c · 16ca11c
1 parent 68770e3
commit 16ca11c
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 18 deletions.
diff --git a/schema/schema.json b/schema/schema.json
@@ -1575,6 +1575,9 @@
           ],
           "type": "object"
         },
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        },
         "new": {
           "additionalProperties": false,
           "properties": {
@@ -3414,6 +3417,9 @@
           ],
           "type": "object"
         },
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        },
         "new": {
           "additionalProperties": false,
           "properties": {
@@ -4091,17 +4097,24 @@
           ],
           "type": "object"
         },
+        "details": {
+          "$id": "#PropertyDetails",
+          "additionalProperties": false,
+          "description": "Details about the property as it currently exists",
+          "properties": {
+            "materials": {
+              "$ref": "#/definitions/Materials"
+            }
+          },
+          "type": "object"
+        },
         "localAuthorityDistrict": {
           "description": "Current and historic UK Local Authority Districts that contain this address sourced from planning.data.gov.uk/dataset/local-authority-district",
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        "materials": {
-          "$ref": "#/definitions/Materials",
-          "description": "Details about the existing materials"
-        },
         "planning": {
           "additionalProperties": false,
           "description": "Planning constraints and policies that intersect with this site and may impact or restrict development",
@@ -21014,10 +21027,6 @@
         "details": {
           "$ref": "#/definitions/ProposalDetails"
         },
-        "materials": {
-          "$ref": "#/definitions/Materials",
-          "description": "Details about the proposed materials"
-        },
         "projectType": {
           "items": {
             "$ref": "#/definitions/ProjectType"
@@ -21868,17 +21877,24 @@
           ],
           "type": "object"
         },
+        "details": {
+          "$id": "#PropertyDetails",
+          "additionalProperties": false,
+          "description": "Details about the property as it currently exists",
+          "properties": {
+            "materials": {
+              "$ref": "#/definitions/Materials"
+            }
+          },
+          "type": "object"
+        },
         "localAuthorityDistrict": {
           "description": "Current and historic UK Local Authority Districts that contain this address sourced from planning.data.gov.uk/dataset/local-authority-district",
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        "materials": {
-          "$ref": "#/definitions/Materials",
-          "description": "Details about the existing materials"
-        },
         "planning": {
           "additionalProperties": false,
           "description": "Planning constraints and policies that intersect with this site and may impact or restrict development",

diff --git a/types/schema/data/Property.ts b/types/schema/data/Property.ts
@@ -61,9 +61,12 @@ export interface UKProperty {
     };
   };
   /**
-   * @description Details about the existing materials
+   * @id #PropertyDetails
+   * @description Details about the property as it currently exists
    */
-  materials?: Materials;
+  details?: {
+    materials?: Materials;
+  };
 }
 
 /**

diff --git a/types/schema/data/Proposal.ts b/types/schema/data/Proposal.ts
@@ -20,10 +20,6 @@ export interface Proposal {
   };
   date?: ProposalDates;
   details?: ProposalDetails;
-  /**
-   * @description Details about the proposed materials
-   */
-  materials?: Materials;
 }
 
 /**
@@ -53,6 +49,7 @@ export interface BaseDetails {
       dwellings?: number;
     };
   };
+  materials?: Materials;
 }
 
 /**