From 70088e6226e165819c5c1b4de631b958781ed9cf Mon Sep 17 00:00:00 2001 From: kristian carr Date: Fri, 15 Mar 2024 12:40:35 +0000 Subject: [PATCH 1/2] feat(cb2-11293): updated spec file to V3 standard and updated type definitions version to latest --- docs/spec.yml | 38 +++++++++++++++++++------------------- package-lock.json | 8 ++++---- package.json | 2 +- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/spec.yml b/docs/spec.yml index c5dacad1..b9a6d794 100644 --- a/docs/spec.yml +++ b/docs/spec.yml @@ -4,7 +4,6 @@ info: API spec for technical records v3 api version: 1.0.0 title: "Technical Record v3" - termsOfService: '' contact: email: user@email.com license: @@ -47,7 +46,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/search/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/search/index.json" '401': description: Not authenticated '403': @@ -78,7 +77,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': @@ -114,7 +113,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': @@ -145,7 +144,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': @@ -182,7 +181,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': @@ -213,24 +212,25 @@ paths: type: string required: true description: Date at which the record was created. Sort key of the DynamoDB table. - - in: body - description: The desired status code of the new tech record and the reason for the unarchival - schema: - type: object - required: status, reasonForUnarchiving - properties: - status: - type: string - reasonForUnarchiving: - type: string - + requestBody: + description: The desired status code of the new tech 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 tech record with the supplied status content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': @@ -274,7 +274,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v2.0.21/json-schemas/v3/tech-record/get/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/get/psv/complete/index.json" '400': description: Bad request '401': diff --git a/package-lock.json b/package-lock.json index 96c19f19..82f2bd94 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.2.1", "license": "MIT", "dependencies": { - "@dvsa/cvs-type-definitions": "^5.1.2", + "@dvsa/cvs-type-definitions": "^6.1.0", "@types/luxon": "^3.3.0", "jwt-decode": "^3.1.2", "luxon": "^3.3.0", @@ -4385,9 +4385,9 @@ } }, "node_modules/@dvsa/cvs-type-definitions": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/@dvsa/cvs-type-definitions/-/cvs-type-definitions-5.1.2.tgz", - "integrity": "sha512-S30kWxpdMnh20bUoe2/j1yXYxX0ELNMvS7N5NgtSEGeaMINQgjwrw3oYMvgt3I3LD45hgZqy1jNMOMfOMSY61Q==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@dvsa/cvs-type-definitions/-/cvs-type-definitions-6.1.0.tgz", + "integrity": "sha512-NPS0mvEfRAiwCuLNHdq5Ip+dmx9KJQKX0RkHV6g0lmsDFwPasL+91R716Mgo44O/shBkeT9XsIQq3ZSoA3iOFA==", "dependencies": { "ajv": "^8.12.0", "json-schema-deref-sync": "^0.14.0", diff --git a/package.json b/package.json index 0d5897f1..6872d8af 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ ], "license": "MIT", "dependencies": { - "@dvsa/cvs-type-definitions": "^5.1.2", + "@dvsa/cvs-type-definitions": "^6.1.0", "@types/luxon": "^3.3.0", "jwt-decode": "^3.1.2", "luxon": "^3.3.0", From 1ca1bbcea918057ba8ab2e83e7e62e30c699f6de Mon Sep 17 00:00:00 2001 From: kristian carr Date: Mon, 18 Mar 2024 08:57:39 +0000 Subject: [PATCH 2/2] feat(cb2-11293): removed references to develop from spec file --- docs/spec.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/spec.yml b/docs/spec.yml index 65e0c7d8..e23f113a 100644 --- a/docs/spec.yml +++ b/docs/spec.yml @@ -113,7 +113,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/develop/json-schemas/v3/tech-record/put/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/put/psv/complete/index.json" responses: '200': description: Returns the technical record @@ -144,7 +144,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/develop/json-schemas/v3/tech-record/put/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/put/psv/complete/index.json" responses: '200': description: Returns the created tech record @@ -274,7 +274,7 @@ paths: content: application/json: schema: - $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/develop/json-schemas/v3/tech-record/put/psv/complete/index.json" + $ref: "https://raw.githubusercontent.com/dvsa/cvs-type-definitions/v6.1.0/json-schemas/v3/tech-record/put/psv/complete/index.json" responses: '200': description: Returns the new upadted tech record @@ -310,5 +310,3 @@ security: - OAuth2: - read - write -servers: - - url: 'https://url/api/v1'