generated from dvsa/dvsa-lambda-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.yml
651 lines (645 loc) · 24.3 KB
/
spec.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
openapi: 3.1.0
info:
description: >-
API spec for technical records v3 service
version: 1.0.0
title: "Technical Record v3"
contact:
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
paths:
'/v3/technical-records/search/{searchIdentifier}':
get:
summary: 'Search for technical records'
tags:
- Search Technical Records
parameters:
- in: path
name: searchIdentifier
schema:
type: string
minLength: 3
maxLength: 21
required: true
description: >-
The identifier to use in the search.
- in: query
name: searchCriteria
schema:
type: string
default: all
enum:
- all
- vin
- primaryVrm
- partialVin
- trailerId
- systemNumber
description: >-
The parameter is used to specify which search criteria
should be used.
responses:
'200':
description: Search result returned
content:
application/json:
schema:
$ref: '#/components/schemas/techRecordGETComplete'
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'/v3/technical-records/{systemNumber}/{createdTimestamp}':
get:
summary: 'Get a complete technical record'
tags:
- Get a Technical Record
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
responses:
'200':
description: Returns the updated technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'500':
description: Internal Server Error
patch:
summary: 'Patch a Technical Record'
tags:
- Patch a Technical Record
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
requestBody:
required: true
description: The technical record to be updated
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordPUTComplete"
- $ref: "#/components/schemas/techRecordPUTSkeleton"
- $ref: "#/components/schemas/techRecordPUTTestable"
responses:
'200':
description: Returns the complete technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'422':
description: Unprocessable request
'500':
description: Validation Error
'/v3/technical-records':
post:
summary: 'Creates a new tech-record'
tags:
- Create Technical Record
requestBody:
required: true
description: The technical record to be created
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordPUTComplete"
- $ref: "#/components/schemas/techRecordPUTSkeleton"
- $ref: "#/components/schemas/techRecordPUTTestable"
responses:
'200':
description: Returns the created technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'422':
description: Unprocessable request
'500':
description: Validation Error
'/v3/technical-records/archive/{systemNumber}/{createdTimestamp}':
patch:
summary: 'Archive an existing current or provisional technical record'
tags:
- Archive Technical Record
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
responses:
'200':
description: Returns the updated technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'422':
description: Unprocessable request
'500':
description: Validation Error
'/v3/technical-records/unarchive/{systemNumber}/{createdTimestamp}':
post:
summary: 'Unarchive an archived technical record which has no other non-archived technical records which share the same VRM'
tags:
- Unarchive Technical Record
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
requestBody:
description: The desired status code of the new technical record and the reason for the unarchival
content:
application/json:
schema:
type: object
required: [status, reasonForUnarchiving]
properties:
status:
type: string
reasonForUnarchiving:
type: string
responses:
'200':
description: Returns the unarchived technical record with the supplied status
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'422':
description: Unprocessable request
'500':
description: Validation Error
'/v3/technical-records/adrCertificate/{systemNumber}/{createdTimestamp}':
post:
summary: 'Generate a new ADR certificate for specific technical record'
tags:
- Generate a ADR Certificate
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- certificateType
properties:
certificateType:
type: string
responses:
'200':
description: Returns the new certificate id with the supplied status
content:
application/json:
schema:
type: object
required: [message, id]
properties:
message:
type: string
id:
type: string
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'422':
description: Unprocessable request
'500':
description: Validation Error
'/v3/technical-records/updateVrm/{systemNumber}/{createdTimestamp}':
patch:
summary: 'Update VRM on a technical record'
tags:
- Update VRM
parameters:
- in: path
name: systemNumber
schema:
type: string
minLength: 3
maxLength: 21
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{0,20}Z
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
operationId: updateVrm
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- newVrm
properties:
newVrm:
type: string
isCherishedTransfer:
type: boolean
thirdMark:
type: string
responses:
'200':
description: Returns the updated technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'/v3/technical-records/updateVin/{systemNumber}/{createdTimestamp}':
patch:
summary: 'Update VIN on a technical record'
tags:
- Update VIN
parameters:
- in: path
name: systemNumber
schema:
type: string
minLength: 3
maxLength: 21
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{0,20}Z
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
operationId: updateVin
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- newVin
properties:
newVin:
type: string
responses:
'200':
description: Returns the complete updated technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'/v3/technical-records/plate/{systemNumber}/{createdTimestamp}':
post:
summary: 'Generates a plate for a TRL or HGV technical record'
tags:
- Generate Plate
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of the Datetime at which the technical record was created. Sort key of the DynamoDB table.
operationId: plate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- vtmUsername
- reasonForCreation
- recipientEmailAddress
properties:
vtmUsername:
type: string
recipientEmailAddress:
type: string
reasonForCreation:
type: string
enum:
- 'Free replacement'
- 'Replacement'
- 'Destroyed'
- 'Provisional'
- 'Original'
- 'Manual'
responses:
'200':
description: Success
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'/v3/technical-records/letter/{systemNumber}/{createdTimestamp}':
post:
summary: 'Generates a letter for a technical record'
tags:
- Generate Letter
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
operationId: letter
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- vtmUsername
- recipientEmailAddress
- letterType
- paragraphId
properties:
vtmUsername:
type: string
recipientEmailAddress:
type: string
letterType:
type: string
enum:
- 'trailer acceptance'
- 'trailer rejection'
paragraphId:
type: number
enum:
- 3
- 4
- 5
- 6
- 7
responses:
'200':
description: Success
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
'/v3/technical-records/promote/{systemNumber}/{createdTimestamp}':
post:
summary: 'Promotes the specified provisional technical record to current'
tags:
- Promote a Technical Record
parameters:
- in: path
name: systemNumber
schema:
type: string
required: true
description: This represents the systemNumber of the vehicle. Partition key of the DynamoDB table.
- in: path
name: createdTimestamp
schema:
type: string
required: true
description: String representation of a DateTime at which the technical record was created. Sort key of the DynamoDB table.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- reasonForPromoting
properties:
reasonForPromoting:
type: string
responses:
'200':
description: Returns the promoted technical record
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/techRecordGETComplete"
- $ref: "#/components/schemas/techRecordGETSkeleton"
- $ref: "#/components/schemas/techRecordGETTestable"
'400':
description: Bad request
'401':
description: Not authenticated
'403':
description: Unauthorised Access
'404':
description: No records found matching identifier and criteria
components:
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: 'https://example.com/oauth/authorize'
tokenUrl: 'https://example.com/oauth/token'
scopes:
read: Grants read access
write: Grants write access
schemas:
techRecordGETComplete:
description: schemas for retrievied complete technical records
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/car/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/lgv/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/motorcycle/complete/index.json"
- $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/hgv/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/trl/complete/index.json"
techRecordGETSkeleton:
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/car/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/lgv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/motorcycle/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/psv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/hgv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/trl/skeleton/index.json"
techRecordGETTestable:
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/psv/testable/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/hgv/testable/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/get/trl/testable/index.json"
techRecordPUTComplete:
description: schemas for creating and updating complete technical records
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/car/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/lgv/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/motorcycle/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/psv/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/hgv/complete/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/trl/complete/index.json"
techRecordPUTSkeleton:
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/car/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/lgv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/motorcycle/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/psv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/hgv/skeleton/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/trl/skeleton/index.json"
techRecordPUTTestable:
oneOf:
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/psv/testable/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/hgv/testable/index.json"
- $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.4.0/json-schemas/v3/tech-record/put/trl/testable/index.json"
security:
- OAuth2:
- read
- write