Lab 2097 Update Configuration Item Endpoint and Spec#156
Conversation
added properties to config item endpoint
Update specs/SHIELD.json to include 'docs' and 'name' metadata: add 'docs' and 'name' to the required properties list and populate sample entries with a docs URL and name value.
There was a problem hiding this comment.
Pull request overview
Updates the SHIELD OpenAPI spec to enrich Deploy configuration item metadata with a documentation URL and human-friendly name, aligning the /Api/Deploy/Component/ConfigurationItem response shape with the updated model.
Changes:
- Added
docs(documentation URL) toDeploy.ConfigurationItemschema and marked it as required. - Added
name(human-friendly configuration item name) toDeploy.ConfigurationItemschema and marked it as required. - Updated response examples to include the new fields in several places.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "docs": { | ||
| "type": "string", | ||
| "description": "URL to the documentation of the Configuration Item.", | ||
| "examples": [ | ||
| "https://docs.shilab.com" | ||
| ] | ||
| }, |
There was a problem hiding this comment.
docs is a URL string, but unlike other URL fields in this spec (e.g., baseLink / learnLinkList), it doesn’t declare format: "uri". Adding the URI format will make validation and client generation consistent.
| "docs", | ||
| "groupTagList", | ||
| "msCloudTypes", | ||
| "name", |
There was a problem hiding this comment.
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.
| "docs", | |
| "groupTagList", | |
| "msCloudTypes", | |
| "name", | |
| "groupTagList", | |
| "msCloudTypes", |
| "required": [ | ||
| "childDependencies", | ||
| "deployState", | ||
| "docs", |
There was a problem hiding this comment.
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).
| "docs", |
| "Public" | ||
| ], | ||
| "name": "Admin Unit - Baseline", | ||
|
|
There was a problem hiding this comment.
There’s a blank/whitespace-only line inside the JSON example object. It doesn’t change semantics, but it introduces noisy diffs and can fail strict format checks—please remove it.
fixed various copilot pr suggestions
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "required": [ | ||
| "childDependencies", | ||
| "deployState", | ||
| "docs", | ||
| "groupTagList", | ||
| "msCloudTypes", | ||
| "name", | ||
| "parentDependencies", |
| "msCloudTypes": [ | ||
| "Public" | ||
| ], | ||
| "name": "Conditional Policy", |
Specifying the format Clarifying example value
Addressed review comments from @pasha-zayko
pr review changes from @pasha-zayko
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
Files not reviewed (1)
- src/shield/TypeScript/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "docs", | ||
| "groupTagList", | ||
| "msCloudTypes", | ||
| "name", |
No description provided.