feat(cb2-13468): add complete car model

dvsa · Aug 28, 2024 · 9697648 · 9697648
1 parent 98c2c39
commit 9697648
Showing 1 changed file with 182 additions and 2 deletions.
diff --git a/docs/spec.yml b/docs/spec.yml
@@ -46,7 +46,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/search/index.json"
+                type: object
+                $ref: "#/components/schemas/techRecordGetCarComplete"
         '401':
           description: Not authenticated
         '403':
@@ -77,7 +78,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/psv/complete/index.json"
+                $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/car/complete/index.json"
         '400':
           description: Bad request
         '401':
@@ -565,6 +566,185 @@ components:
           scopes:
             read: Grants read access
             write: Grants write access
+  schemas:
+    techRecordGetCarComplete:
+      type: object
+      additionalProperties: false
+      required:
+        - systemNumber
+        - vin
+        - createdTimestamp
+        - techRecord_vehicleSubclass
+        - techRecord_vehicleType
+        - techRecord_createdAt
+        - techRecord_createdById
+        - techRecord_createdByName
+        - techRecord_reasonForCreation
+        - techRecord_statusCode
+        - techRecord_noOfAxles
+        - primaryVrm
+      properties:
+        techRecord_applicantDetails_name:
+          nullable: true
+          type: string
+          maxLength: 150
+        techRecord_applicantDetails_address1:
+          nullable: true
+          type: string
+          maxLength: 60
+        techRecord_applicantDetails_address2:
+          nullable: true
+          type: string
+          maxLength: 60
+        techRecord_applicantDetails_postTown:
+          nullable: true
+          type: string
+          maxLength: 60
+        techRecord_applicantDetails_address3:
+          nullable: true
+          type: string
+          maxLength: 60
+        techRecord_applicantDetails_postCode:
+          nullable: true
+          type: string
+          maxLength: 12
+        techRecord_applicantDetails_telephoneNumber:
+          nullable: true
+          type: string
+          maxLength: 25
+        techRecord_applicantDetails_emailAddress:
+          nullable: true
+          type: string
+          maxLength: 255
+        createdTimestamp:
+          type: string
+        partialVin:
+          nullable: true
+          type: string
+        primaryVrm:
+          type: string
+        systemNumber:
+          type: string
+        techRecord_createdAt:
+          type: string
+        techRecord_createdById:
+          type: string
+        techRecord_createdByName:
+          type: string
+        techRecord_euVehicleCategory: # make a ref to the enum
+          nullable: true
+          $ref: "#/components/schemas/euVehicleCategory"
+        techRecord_lastUpdatedAt:
+          nullable: true
+          type: string
+        techRecord_lastUpdatedById:
+          nullable: true
+          type: string
+        techRecord_lastUpdatedByName:
+          nullable: true
+          type: string
+        techRecord_manufactureYear:
+          type: integer
+          nullable: true
+        techRecord_recordCompleteness:
+          type: string
+          enum: 
+            - complete
+        techRecord_noOfAxles:
+          type: integer
+        techRecord_notes:
+          nullable: true
+          type: string
+        techRecord_reasonForCreation:
+          type: string
+        techRecord_regnDate:
+          nullable: true
+          type: string
+        techRecord_statusCode:
+          nullable: true
+          $ref: "#/components/schemas/statusCode"
+        techRecord_vehicleConfiguration:
+          nullable: true
+          $ref: "#/components/schemas/vehicleConfiguration"
+        techRecord_vehicleType:
+          type: string
+          enum: 
+            - car
+        vin:
+          type: string
+        techRecord_vehicleSubclass:
+          title: Vehicle Subclass
+          type: array
+          items:
+            $ref: "#/components/schemas/vehicleSubclass"
+        techRecord_hiddenInVta:
+          nullable: true
+          type: boolean
+        techRecord_updateType:
+          nullable: true
+          type: string          
+        secondaryVrms:
+          nullable: true
+          type: array
+          items:
+            type: string
+    euVehicleCategory:
+      type: string
+      enum:
+        - m1
+        - m2
+        - m3
+        - n1
+        - n2
+        - n3
+        - o1
+        - o2
+        - o3
+        - o4
+        - l1e-a
+        - l1e
+        - l2e
+        - l3e
+        - l4e
+        - l5e
+        - l6e
+        - l7e
+    statusCode:
+      type: string
+      enum:
+        - provisional
+        - current
+        - archived
+    vehicleSubclass:
+      title: Vehicle Subclass
+      type: string
+      enum:
+        - 'n'
+        - p
+        - a
+        - s
+        - c
+        - l
+        - t
+        - e
+        - m
+        - r
+        - w
+    vehicleConfiguration:
+      type: string
+      enum:
+        - rigid
+        - articulated
+        - centre axle drawbar
+        - semi-car transporter
+        - semi-trailer
+        - long semi-trailer
+        - low loader
+        - other
+        - drawbar
+        - four-in-line
+        - dolly
+        - full drawba
 
 security:
   - OAuth2: