From a6f9f28577f9aa781103f6fb20388faecda1eed0 Mon Sep 17 00:00:00 2001 From: anthony bobbie <44766686+bowaybilly@users.noreply.github.com> Date: Tue, 9 Jun 2026 15:03:43 +0100 Subject: [PATCH 1/3] LAB-2404-Update-OpenApi-spec-to-reflect-new-get-errors-endpoint --- specs/SHIELD.json | 81 ++++++++++++++++++++ src/dataGateway/TypeScript/package-lock.json | 2 +- src/dataGateway/TypeScript/package.json | 2 +- 3 files changed, 83 insertions(+), 2 deletions(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index 2bdbd11..c5e3c31 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -5496,6 +5496,87 @@ ] } }, + "/Api/Deploy/Errors": { + "get": { + "summary": "Gets Captured Deployment Errors", + "description": "Returns the current collection of asynchronous deployment errors captured by the deploy engine. Each record identifies the configuration item template and the associated error message.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", + "operationId": "/Api/Deploy/Errors/Get", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "Collection of deployment errors recorded during asynchronous deploy operations.", + "items": { + "type": "object", + "properties": { + "templateId": { + "type": "string", + "description": "Internal reference identifier of the configuration item that encountered the deployment error.", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$", + "examples": [ + "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a" + ] + }, + "message": { + "type": "string", + "description": "Text with the details of the deployment failure.", + "examples": [ + "Deployment failed for test resource" + ] + } + }, + "required": [ + "templateId", + "message" + ], + "examples": [ + { + "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a", + "message": "Deployment failed for test resource" + } + ] + }, + "examples": [ + [ + { + "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a", + "message": "Deployment failed for test resource" + } + ] + ] + }, + "examples": { + "Captured Deployment Errors": { + "summary": "Example Deployment Errors", + "description": "An example response containing one tracked deployment error.", + "value": [ + { + "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a", + "message": "Deployment failed for test resource" + } + ] + }, + "No Deployment Errors": { + "summary": "No Errors Captured", + "description": "An example response when no asynchronous deployment errors have been recorded.", + "value": [] + } + } + } + } + } + }, + "tags": [ + "Deploy" + ] + } + }, "/Api/Deploy/BreakGlass": { "get": { "summary": "Check the Status of the Break Glass Groups and Required Users Existence", diff --git a/src/dataGateway/TypeScript/package-lock.json b/src/dataGateway/TypeScript/package-lock.json index 32e0c91..8513202 100644 --- a/src/dataGateway/TypeScript/package-lock.json +++ b/src/dataGateway/TypeScript/package-lock.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-data-gateway", - "version": "3.3.1", + "version": "3.3.2", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/src/dataGateway/TypeScript/package.json b/src/dataGateway/TypeScript/package.json index 2fc22cc..41f0a45 100644 --- a/src/dataGateway/TypeScript/package.json +++ b/src/dataGateway/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-data-gateway", - "version": "3.3.1", + "version": "3.3.2", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHI Data Gateway service.", From 9ca66a66e98ef3a506b2585d8f2976336f577a88 Mon Sep 17 00:00:00 2001 From: anthony bobbie <44766686+bowaybilly@users.noreply.github.com> Date: Tue, 9 Jun 2026 15:16:09 +0100 Subject: [PATCH 2/3] updated package json version --- src/dataGateway/TypeScript/package-lock.json | 2 +- src/dataGateway/TypeScript/package.json | 2 +- src/shield/TypeScript/package-lock.json | 2 +- src/shield/TypeScript/package.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/dataGateway/TypeScript/package-lock.json b/src/dataGateway/TypeScript/package-lock.json index 8513202..32e0c91 100644 --- a/src/dataGateway/TypeScript/package-lock.json +++ b/src/dataGateway/TypeScript/package-lock.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-data-gateway", - "version": "3.3.2", + "version": "3.3.1", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/src/dataGateway/TypeScript/package.json b/src/dataGateway/TypeScript/package.json index 41f0a45..2fc22cc 100644 --- a/src/dataGateway/TypeScript/package.json +++ b/src/dataGateway/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-data-gateway", - "version": "3.3.2", + "version": "3.3.1", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHI Data Gateway service.", diff --git a/src/shield/TypeScript/package-lock.json b/src/shield/TypeScript/package-lock.json index 7b076f7..061fa4c 100644 --- a/src/shield/TypeScript/package-lock.json +++ b/src/shield/TypeScript/package-lock.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-shield", - "version": "3.5.1", + "version": "3.5.2", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/src/shield/TypeScript/package.json b/src/shield/TypeScript/package.json index 6f39537..fa51bab 100644 --- a/src/shield/TypeScript/package.json +++ b/src/shield/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-shield", - "version": "3.5.1", + "version": "3.5.2", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHIELD application.", From f9aa7228ef146ae9d66667dc737db5840c0bdcec Mon Sep 17 00:00:00 2001 From: anthony bobbie <44766686+bowaybilly@users.noreply.github.com> Date: Tue, 9 Jun 2026 15:40:52 +0100 Subject: [PATCH 3/3] bumped up the json version --- specs/SHIELD.json | 2 +- src/shield/TypeScript/package-lock.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index c5e3c31..81072dd 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -4313,7 +4313,7 @@ }, "description": "Deprive your threats of practical significance. Deploy the Securing Privilege Access architecture. All in a few seconds.", "title": "SHI Environment Lockdown and Defense", - "version": "3.5.1" + "version": "3.5.2" }, "openapi": "3.1.1", "paths": { diff --git a/src/shield/TypeScript/package-lock.json b/src/shield/TypeScript/package-lock.json index 061fa4c..abcb407 100644 --- a/src/shield/TypeScript/package-lock.json +++ b/src/shield/TypeScript/package-lock.json @@ -6,7 +6,7 @@ "packages": { "": { "name": "@shi-corp/sdk-shield", - "version": "3.5.1", + "version": "3.5.2", "license": "MIT", "dependencies": { "@microsoft/kiota-authentication-azure": "~1.0.0-preview.100",