major(cb2-9874): Introduce the AdditionalInformation object to IVA de…

…fect JSON schema (#148)
dvsa · Nov 28, 2023 · 9b4dfa2 · 9b4dfa2
1 parent 9ff6792
commit 9b4dfa2
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 37 deletions.
diff --git a/json-definitions/iva/defects/get/index.json b/json-definitions/iva/defects/get/index.json
@@ -16,16 +16,6 @@
     "sectionDescription": {
       "type": ["string"]
     },
-    "vehicleTypes": {
-      "type": "array",
-      "items": {
-        "anyOf": [
-          {
-            "$ref": "../../../v3/tech-record/enums/vehicleType.ignore.json"
-          }
-        ]
-      }
-    },
     "euVehicleCategories": {
       "type": "array",
       "items": {
@@ -45,8 +35,7 @@
           "rsNumber",
           "requiredStandard",
           "refCalculation",
-          "additionalInfo",
-          "inspectionTypes"
+          "additionalInfo"
         ],
         "properties": {
           "rsNumber": {
@@ -73,6 +62,16 @@
           }
         }
       }
+    },
+    "additionalInformation": {
+      "type": "object",
+      "additionalProperties" : false,
+      "required" : ["notes"],
+      "properties": {
+        "notes" : {
+          "type" : ["string"]
+        }
+      }
     }
   }
 }
diff --git a/json-schemas/iva/defects/get/index.json b/json-schemas/iva/defects/get/index.json
@@ -20,25 +20,6 @@
 				"string"
 			]
 		},
-		"vehicleTypes": {
-			"type": "array",
-			"items": {
-				"anyOf": [
-					{
-						"title": "Vehicle Type",
-						"type": "string",
-						"enum": [
-							"psv",
-							"trl",
-							"hgv",
-							"car",
-							"lgv",
-							"motorcycle"
-						]
-					}
-				]
-			}
-		},
 		"euVehicleCategories": {
 			"type": "array",
 			"items": {
@@ -99,8 +80,7 @@
 					"rsNumber",
 					"requiredStandard",
 					"refCalculation",
-					"additionalInfo",
-					"inspectionTypes"
+					"additionalInfo"
 				],
 				"properties": {
 					"rsNumber": {
@@ -140,6 +120,20 @@
 					}
 				}
 			}
+		},
+		"additionalInformation": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": [
+				"notes"
+			],
+			"properties": {
+				"notes": {
+					"type": [
+						"string"
+					]
+				}
+			}
 		}
 	}
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dvsa/cvs-type-definitions",
-  "version": "3.7.0",
+  "version": "4.0.0",
   "description": "type definitions for cvs vta and vtm applications",
   "main": "index.js",
   "repository": {

diff --git a/types/iva/defects/get/index.d.ts b/types/iva/defects/get/index.d.ts
@@ -5,21 +5,22 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type VehicleType = "psv" | "trl" | "hgv" | "car" | "lgv" | "motorcycle";
 export type InspectionType = "basic" | "normal";
 
 export interface DefectGETIVA {
   sectionNumber: string;
   sectionDescription: string;
-  vehicleTypes: VehicleType[];
   euVehicleCategories: EUVehicleCategory[];
   requiredStandards: {
     rsNumber: number;
     requiredStandard: string;
     refCalculation: string;
     additionalInfo: boolean;
-    inspectionTypes: InspectionType[];
+    inspectionTypes?: InspectionType[];
   }[];
+  additionalInformation?: {
+    notes: string;
+  };
 }
 
 export enum EUVehicleCategory {