Skip to content

LAB-2305 Update OpenAPI spec for configuration category endpoint #175

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 (pasha-zayko) merged 5 commits into from
May 28, 2026
Merged

LAB-2305 Update OpenAPI spec for configuration category endpoint #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
987762c
initial configuration
bowaybilly May 26, 2026
a6874a6
removed 400 response
bowaybilly May 26, 2026
9ac83f9
code review- rework, updated property names to match expected shape
bowaybilly May 28, 2026
a82a593
bumped up app version, ready for packaging
bowaybilly May 28, 2026
7839e22
added spec api version
bowaybilly May 28, 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
166 changes: 165 additions & 1 deletion specs/SHIELD.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,125 @@
]
]
},
"Deploy.ConfigurationCategory": {
"title": "Deploy - Configuration Category List",
"description": "Collection of objects representing configuration categories used to organize deployable configuration items.",
"type": "array",
"items": {
"description": "Single configuration category with curated properties and values in a user-friendly format.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal Object ID in UUID format to uniquely identify this configuration category definition.",
"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": [
"6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a"
]
},
"displayName": {
"type": "string",
"description": "Human friendly name of the Configuration Category.",
"examples": [
"Identity Protection"
]
},
"description": {
"type": "string",
"description": "Lengthier explanation of how this category groups related configuration items.",
"examples": [
"Baseline controls that harden identity and access related workloads."
]
},
"parentCategoryId": {
"type": "string",
"description": "Object ID in UUID format that references the parent configuration category when this category is nested.",
"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": [
"1b7e2a3c-5d4f-4a8b-9e6a-7c2b1d3f8e4a"
]
},
"groupTagMetadataId": {
"type": "string",
"description": "Object ID in UUID format that references the deploy group tag metadata record associated with this category.",
"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": [
"5d3f9c2e-7a1b-4a8b-8c6e-1a3d7e8b5c4a"
]
},
"templateIds": {
"type": "array",
"description": "List of configuration item templateIds assigned to this category.",
"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": [
"2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a"
]
},
"examples": [
[
"2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
"4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a"
]
]
}
},
"required": [
"id",
"displayName"
],
"examples": [
{
"id": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a",
"displayName": "Identity Protection",
"description": "Baseline controls that harden identity and access related workloads.",
"groupTagMetadataId": "5d3f9c2e-7a1b-4a8b-8c6e-1a3d7e8b5c4a",
"templateIds": [
"2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
"4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a"
]
},
{
"id": "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
"displayName": "Conditional Access",
"parentCategoryId": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a"
}
]
},
"examples": [
[
{
"id": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a",
"displayName": "Identity Protection",
"description": "Baseline controls that harden identity and access related workloads.",
"groupTagMetadataId": "5d3f9c2e-7a1b-4a8b-8c6e-1a3d7e8b5c4a",
"templateIds": [
"2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
"4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a"
]
},
{
"id": "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
"displayName": "Conditional Access",
"parentCategoryId": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a"
}
]
]
},
"Deploy.ConfigurationItemMetaData": {
"title": "Deploy - Configuration Item Meta Data",
"description": "Object representing populated information expanding details of the Configuration Item with user friendly information.",
Expand Down Expand Up @@ -3990,7 +4109,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.1"
"version": "3.4.2"
},
"openapi": "3.1.1",
"paths": {
Expand Down Expand Up @@ -5346,6 +5465,51 @@
]
}
},
"/Api/Deploy/Component/ConfigurationCategory": {
"get": {
"summary": "Returns List of Available Configuration Categories",
"description": "Retrieves the collection of all existing configuration categories with curated set of metadata.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
"operationId": "/Api/Deploy/Component/ConfigurationCategory/Get",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Sample List of Available Configuration Categories": {
"description": "Sample list of configuration category records available for deploy component organization.",
"summary": "Available Configuration Categories",
"value": [
{
"id": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a",
"displayName": "Identity Protection",
"description": "Baseline controls that harden identity and access related workloads.",
"groupTagMetadataId": "5d3f9c2e-7a1b-4a8b-8c6e-1a3d7e8b5c4a",
"templateIds": [
"2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
"4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a"
]
},
{
"id": "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
"displayName": "Conditional Access",
"parentCategoryId": "6a2c7e1b-4d5f-4a8b-9e6a-2b1c7f3d8e4a"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/Deploy.ConfigurationCategory"
}
}
},
"description": "OK"
}
},
"tags": [
"Deploy"
]
}
},
"/Api/Deploy/Component/ConfigurationItem/{templateId}/Docs": {
"get": {
"summary": "Return Result of Retrieving Configuration Item Documentation",
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.1",
"version": "3.4.2",
"type": "module",
"main": "bin/index.js",
"description": "SDK client used to interface with the SHIELD application.",
Expand Down
Loading