Skip to content

LAB- 1957 Updating endpoints #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Elliot Huffman (elliot-huffman) merged 2 commits into from
Apr 27, 2026
Merged

LAB- 1957 Updating endpoints #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4dcb4c8
Updating endpoints
pasha-zayko Apr 16, 2026
cb34125
Reflecting comments
pasha-zayko Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 91 additions & 25 deletions specs/SHIELD.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -4782,22 +4782,24 @@
"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": {
"description": "Infrastructure is not deployed. Please run the deployment before attempting different API calls.",
"summary": "Infrastructure Is Not Deployed",
"value": {
"deployedArchitecture": null,
"deployTagInclude": false,
"deployedTags": [],
"isDeploying": false
"isDeploying": false,
"requestedConfigItems": []
}
}
},
Expand All @@ -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",
Expand All @@ -4837,22 +4832,47 @@
"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).",
"type": "boolean",
"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"
]
}
}
Expand Down Expand Up @@ -4886,7 +4906,9 @@
"tagList": [
"7a2e5b1f-9c4d-4e3a-8f1b-2d6c3e9a7f4e"
],
"include": true
"configIdList": [
"ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3"
]
}
},
"User Consented": {
Expand All @@ -4899,7 +4921,9 @@
"6b3e2f1a-8d9c-4f7e-9a3b-1c2d5e7f4a6b",
"9e1c3a7b-2f4d-4e6a-8c9f-3b7d1a5e2f6c"
],
"include": false
"configIdList": [
"ac37e450-2b84-4d71-8a96-e8f1b7b7d3f3"
]
Comment thread
pasha-zayko marked this conversation as resolved.
}
}
},
Expand Down Expand Up @@ -4936,13 +4960,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"
]
]
}
},
Expand All @@ -4951,7 +4993,7 @@
"deploymentConsent",
"architectureId",
"tagList",
"include"
"configIdList"
]
}
}
Expand All @@ -4977,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": {
Expand All @@ -4997,6 +5039,9 @@
"tagList": [
"f3b9c7e2-1a4d-4c2e-9f3e-8b6a1c2d9e7a",
"a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d"
],
"configIdList": [
"6e1a9b61-d5c7-4f23-a84d-5c2e98c8e404"
]
}
}
Expand All @@ -5023,10 +5068,31 @@
"a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d"
]
]
},
"configIdList": {
"description": "List of configuration items user intentionally selected to provision.",
"type": "array",
"minItems": 1,
"items": {
Comment thread
pasha-zayko marked this conversation as resolved.
"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"
]
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/shield/TypeScript/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/shield/TypeScript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.",
Expand Down
Loading