Skip to content

LAB-2404-Update-OpenApi-spec-to-reflect-new-get-errors-endpoint #179

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
pr0uxx merged 3 commits into from
Jun 12, 2026
Merged

LAB-2404-Update-OpenApi-spec-to-reflect-new-get-errors-endpoint #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6f9f28
LAB-2404-Update-OpenApi-spec-to-reflect-new-get-errors-endpoint
bowaybilly Jun 9, 2026
9ca66a6
updated package json version
bowaybilly Jun 9, 2026
f9aa722
bumped up the json version
bowaybilly Jun 9, 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
83 changes: 82 additions & 1 deletion specs/SHIELD.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Comment thread
bowaybilly marked this conversation as resolved.
"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",
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.5.1",
"version": "3.5.2",
"type": "module",
"main": "bin/index.js",
"description": "SDK client used to interface with the SHIELD application.",
Expand Down
Loading