From 5f0bdde184d54feb8aa7a54c479b633fa3481938 Mon Sep 17 00:00:00 2001 From: Pasha Zayko Date: Tue, 17 Jun 2025 10:30:27 -0400 Subject: [PATCH 1/2] Adding deploy progress endpooint Defining new endpoint /Api/Deploy/Progress that returns latest known progressbar details for the deploy process --- specs/SHIELD.json | 24 +++++++++++++++++++++++- src/shield/TypeScript/package-lock.json | 4 ++-- src/shield/TypeScript/package.json | 2 +- 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index 6ac5800..c7236bd 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -1114,7 +1114,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.0.3" + "version": "3.0.4" }, "openapi": "3.0.0", "paths": { @@ -1774,6 +1774,28 @@ "security": [] } }, + "/Api/Deploy/Progress": { + "get": { + "summary": "Current execution progress of the Deploy module.", + "description": "Provides a detailed breakdown of the current progress of the deploy module and it sub-components, if any.\n\nThis endpoint requires the `Deploy.Read`, or the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", + "operationId": "/Api/Deploy/Progress/Get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Core.ProgressBar" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "Infrastructure Deployment" + ] + } + }, "/Api/Deploy/Version": { "get": { "description": "Gets the version of the API server and the architecture version deployed as well as the supported version of the architecture spec from the server.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", diff --git a/src/shield/TypeScript/package-lock.json b/src/shield/TypeScript/package-lock.json index 610bfad..599d3bf 100644 --- a/src/shield/TypeScript/package-lock.json +++ b/src/shield/TypeScript/package-lock.json @@ -1,12 +1,12 @@ { "name": "@shi-corp/sdk-shield", - "version": "3.0.3", + "version": "3.0.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@shi-corp/sdk-shield", - "version": "3.0.3", + "version": "3.0.4", "license": "MIT", "dependencies": { "@microsoft/kiota-authentication-azure": "~1.0.0-preview.93", diff --git a/src/shield/TypeScript/package.json b/src/shield/TypeScript/package.json index 5d276ff..89eb3bf 100644 --- a/src/shield/TypeScript/package.json +++ b/src/shield/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-shield", - "version": "3.0.3", + "version": "3.0.4", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHIELD application.", From 44b03711bc25a8a76392387b7259e1958d466b54 Mon Sep 17 00:00:00 2001 From: Pasha Zayko Date: Tue, 17 Jun 2025 10:34:10 -0400 Subject: [PATCH 2/2] Grammar update Per copillot --- specs/SHIELD.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index c7236bd..77030ab 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -1777,7 +1777,7 @@ "/Api/Deploy/Progress": { "get": { "summary": "Current execution progress of the Deploy module.", - "description": "Provides a detailed breakdown of the current progress of the deploy module and it sub-components, if any.\n\nThis endpoint requires the `Deploy.Read`, or the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", + "description": "Provides a detailed breakdown of the current progress of the deploy module and its sub-components, if any.\n\nThis endpoint requires the `Deploy.Read`, or the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", "operationId": "/Api/Deploy/Progress/Get", "responses": { "200": {