Skip to content

Lab 2097 Update Configuration Item Endpoint and Spec #156

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
pasha-zayko merged 7 commits into from
May 1, 2026
Merged

Lab 2097 Update Configuration Item Endpoint and Spec #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
160c8f1
Add docs and name to SHIELD config items
TheMartianMaker Apr 24, 2026
553845e
Add docs and name to SHIELD spec
TheMartianMaker Apr 28, 2026
59f930f
Merge branch 'main' into LAB-2097-Implement-Data-Retrievel-from-backend
TheMartianMaker Apr 28, 2026
4bccb75
fixed copilot suggestions
TheMartianMaker Apr 29, 2026
c74a65b
Small adjustment
pasha-zayko Apr 30, 2026
8348a16
Addressed review comments
TheMartianMaker Apr 30, 2026
54697c3
making requested changes
TheMartianMaker Apr 30, 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
29 changes: 28 additions & 1 deletion specs/SHIELD.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,6 +1117,14 @@
"deployed"
]
},
"docs": {
"type": "string",
"description": "URL to the documentation of the Configuration Item.",
"format": "uri",
"examples": [
"https://docs.shilab.com"
]
},
"groupTagList": {
"type": "array",
"description": "List of metadata tags that indicate which deployment sets the configuration item is compatible with.",
Expand Down Expand Up @@ -1189,6 +1197,13 @@
]
]
},
"name": {
"type": "string",
"description": "Human friendly name of the Configuration Item.",
"examples": [
"Conditional Policy"
]
},
"parentDependencies": {
"type": "array",
"description": "List of Object IDs in UUID format that reference configuration items identified as entities which deploy and existence is required for the current item.",
Expand Down Expand Up @@ -1231,8 +1246,10 @@
"required": [
"childDependencies",
"deployState",
"docs",
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before making docs required, confirm it is always present for every configuration item. The /Api/Deploy/Component/ConfigurationItem/{templateId}/Docs endpoint description explicitly mentions documentation may be missing; if some items don’t have docs, keep docs optional (or document an explicit sentinel value).

Suggested change
"docs",

Copilot uses AI. Check for mistakes.
"groupTagList",
"msCloudTypes",
"name",
Comment on lines +1249 to +1252
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs and name were added to the schema’s required list, but the schema-level array example that follows still contains an item missing these fields (the notDeployed item in the Deploy.ConfigurationItem examples list). Update that example to include docs/name, or don’t mark these properties as required.

Suggested change
"docs",
"groupTagList",
"msCloudTypes",
"name",
"groupTagList",
"msCloudTypes",

Copilot uses AI. Check for mistakes.
Comment on lines +1249 to +1252
"parentDependencies",
Comment on lines 1246 to 1253
"templateId",
"urlPath"
Expand All @@ -1244,6 +1261,7 @@
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
],
"deployState": "deployed",
"docs": "https://docs.shilab.com",
"groupTagList": [
{
"description": "Collection of policies covering critical conditional access settings.",
Expand All @@ -1254,6 +1272,7 @@
"msCloudTypes": [
"Public"
],
"name": "Conditional Policy",
"parentDependencies": [
"8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
],
Expand All @@ -1270,6 +1289,7 @@
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
],
"deployState": "deployed",
"docs": "https://docs.shilab.com",
"groupTagList": [
{
"description": "Collection of policies covering critical conditional access settings.",
Expand All @@ -1280,6 +1300,7 @@
"msCloudTypes": [
"Public"
],
"name": "Conditional Policy",
"parentDependencies": [
"8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
],
Expand All @@ -1291,6 +1312,7 @@
"1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
],
"deployState": "notDeployed",
"docs": "https://docs.shilab.com",
"groupTagList": [
{
"description": "Principal containers that are used to provide assignments.",
Expand All @@ -1301,6 +1323,7 @@
"msCloudTypes": [
"Public"
],
"name": "Privileged Objects",
"parentDependencies": [],
"templateId": "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a",
"urlPath": "/directory/administrativeUnits"
Expand Down Expand Up @@ -3967,7 +3990,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.4.0"
"version": "3.4.1"
},
"openapi": "3.1.1",
"paths": {
Expand Down Expand Up @@ -5268,6 +5291,7 @@
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
],
"deployState": "deployed",
"docs": "https://docs.shilab.com",
"groupTagList": [
{
"description": "Collection of policies covering critical conditional access settings.",
Expand All @@ -5278,6 +5302,7 @@
"msCloudTypes": [
"Public"
],
"name": "Conditional Access - Baseline",
"parentDependencies": [
"8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
],
Expand All @@ -5289,6 +5314,7 @@
"1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
],
"deployState": "notDeployed",
"docs": "https://docs.shilab.com",
"groupTagList": [
{
"description": "Principal containers that are used to provide assignments.",
Expand All @@ -5299,6 +5325,7 @@
"msCloudTypes": [
"Public"
],
"name": "Admin Unit - Baseline",
"parentDependencies": [],
"templateId": "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a",
"urlPath": "/directory/administrativeUnits"
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.4.0",
"version": "3.4.1",
"type": "module",
"main": "bin/index.js",
"description": "SDK client used to interface with the SHIELD application.",
Expand Down
Loading