From 4dcb4c8de1d4a309435033771179aa46cb0e36b4 Mon Sep 17 00:00:00 2001 From: Pasha Zayko Date: Thu, 16 Apr 2026 16:11:01 -0400 Subject: [PATCH 1/2] Updating endpoints Changing deploy-related endpoints to reflect changed payloads and object structures --- specs/SHIELD.json | 110 +++++++++++++++++++----- src/shield/TypeScript/package-lock.json | 4 +- src/shield/TypeScript/package.json | 2 +- 3 files changed, 90 insertions(+), 26 deletions(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index cd9e826..1dc731d 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -3967,7 +3967,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.3.0" + "version": "3.4.0" }, "openapi": "3.1.1", "paths": { @@ -4782,12 +4782,14 @@ "summary": "Infrastructure Is Deployed", "value": { "deployedArchitecture": "4a7f2e9c-1b3d-4c6a-9f8e-2d5b3e1a7c9f", - "deployTagInclude": true, "deployedTags": [ "5e2a9c1f-8b3d-4f6a-9e7c-2d1f3a6b4c8e", "9c7f2e1a-3b6d-4a8e-9f5c-1d2a4b7e6c3f" ], - "isDeploying": true + "isDeploying": true, + "requestedConfigItems": [ + "d2f48c72-7a19-4b5d-9e20-1a6b09d9f515" + ] } }, "Infra not deployed": { @@ -4795,9 +4797,9 @@ "summary": "Infrastructure Is Not Deployed", "value": { "deployedArchitecture": null, - "deployTagInclude": false, "deployedTags": [], - "isDeploying": false + "isDeploying": false, + "requestedConfigItems": [] } } }, @@ -4817,13 +4819,6 @@ "6a2b7e1c-3d4f-4a8b-9e6a-2c1b7f3d8e4a" ] }, - "deployTagInclude": { - "description": "Flag that indicates if the tag list has been set to be in inclusion mode (`true`) or exclusion mode (`false`).", - "type": "boolean", - "examples": [ - true - ] - }, "deployedTags": { "description": "Collection of references to the groupings that list related or dependent resources to be deployed.", "type": "array", @@ -4837,7 +4832,12 @@ "9e1c2b7a-5d3f-4a8b-2c6e-7f1a3d9e8b5c" ] }, - "minItems": 0 + "minItems": 0, + "examples": [ + [ + "9e1c2b7a-5d3f-4a8b-2c6e-7f1a3d9e8b5c" + ] + ] }, "isDeploying": { "description": "Flag to indicate if process has started and ongoing (true) or not (false).", @@ -4845,14 +4845,34 @@ "examples": [ true ] + }, + "requestedConfigItems": { + "description": "List of configuration items user intentionally selected to provision.", + "type": "array", + "minItems": 0, + "items": { + "type": "string", + "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": [ + "d2f48c72-7a19-4b5d-9e20-1a6b09d9f515" + ] + }, + "examples": [ + [ + "d2f48c72-7a19-4b5d-9e20-1a6b09d9f515" + ] + ] } }, "type": "object", "required": [ "deployedArchitecture", - "deployTagInclude", "deployedTags", - "isDeploying" + "isDeploying", + "requestedConfigItems" ] } } @@ -4899,7 +4919,9 @@ "6b3e2f1a-8d9c-4f7e-9a3b-1c2d5e7f4a6b", "9e1c3a7b-2f4d-4e6a-8c9f-3b7d1a5e2f6c" ], - "include": false + "configIdList": [ + "ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3" + ] } } }, @@ -4936,13 +4958,31 @@ "5d1c7e2b-3a4f-4a8b-9e6a-7f2b3d1c9e45" ] }, - "minItems": 0 + "minItems": 0, + "examples": [ + [ + "5d1c7e2b-3a4f-4a8b-9e6a-7f2b3d1c9e45" + ] + ] }, - "include": { - "description": "Flag to indicate if calculated resources should be included (true) or excluded (false) from the deploy.", - "type": "boolean", + "configIdList": { + "description": "List of configuration items user intentionally selected to provision.", + "type": "array", + "minItems": 0, + "items": { + "type": "string", + "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": [ + "ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3" + ] + }, "examples": [ - true + [ + "ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3" + ] ] } }, @@ -4951,7 +4991,7 @@ "deploymentConsent", "architectureId", "tagList", - "include" + "configIdList" ] } } @@ -4997,6 +5037,9 @@ "tagList": [ "f3b9c7e2-1a4d-4c2e-9f3e-8b6a1c2d9e7a", "a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d" + ], + "configIdList": [ + "6e1a9b61-d5c7-4f23-a84d-5c2e98c8e404" ] } } @@ -5023,10 +5066,31 @@ "a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d" ] ] + }, + "configIdList": { + "description": "List of configuration items user intentionally selected to provision.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "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": [ + "6e1a9b61-d5c7-4f23-a84d-5c2e98c8e404" + ] + }, + "examples": [ + [ + "6e1a9b61-d5c7-4f23-a84d-5c2e98c8e404" + ] + ] } }, "required": [ - "tagList" + "tagList", + "configIdList" ] } } diff --git a/src/shield/TypeScript/package-lock.json b/src/shield/TypeScript/package-lock.json index a40049d..8e91679 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.3.0", + "version": "3.4.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@shi-corp/sdk-shield", - "version": "3.3.0", + "version": "3.4.0", "license": "MIT", "dependencies": { "@microsoft/kiota-authentication-azure": "~1.0.0-preview.100", diff --git a/src/shield/TypeScript/package.json b/src/shield/TypeScript/package.json index 76df2b0..f0deaf6 100644 --- a/src/shield/TypeScript/package.json +++ b/src/shield/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@shi-corp/sdk-shield", - "version": "3.3.0", + "version": "3.4.0", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHIELD application.", From cb34125ccf416775f91ebab3930f13d384c1e194 Mon Sep 17 00:00:00 2001 From: Pasha Zayko Date: Thu, 16 Apr 2026 16:46:00 -0400 Subject: [PATCH 2/2] Reflecting comments Updating description and example following comments --- specs/SHIELD.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specs/SHIELD.json b/specs/SHIELD.json index 1dc731d..47f4681 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -4906,7 +4906,9 @@ "tagList": [ "7a2e5b1f-9c4d-4e3a-8f1b-2d6c3e9a7f4e" ], - "include": true + "configIdList": [ + "ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3" + ] } }, "User Consented": { @@ -5017,7 +5019,7 @@ }, "patch": { "summary": "Augments the List of Tags Set as Deployed and Provisions New Resources", - "description": "Changes the list of tags based on include flags, calculates the list of matchings resources and deploys all the ones marked as not provisioned.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", + "description": "Changes the list of tags, calculates the list of matching resources based on provided list and deploys all the ones marked as not provisioned.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).", "operationId": "/Api/Deploy/Patch", "requestBody": { "content": {