Merged
Conversation
Minor change to the format of the endpoint returning documentation for the configuration item
There was a problem hiding this comment.
Pull request overview
This pull request renames an API endpoint for retrieving configuration item documentation from /Api/Deploy/Component/ConfigurationItemMetaData/{templateId} to /Api/Deploy/Component/ConfigurationItem/{templateId}/Docs. The new naming is more RESTful and better aligns with the existing /Api/Deploy/Component/ConfigurationItem endpoint. The version is bumped from 3.2.0 to 3.2.1.
Changes:
- Updated endpoint path to follow RESTful naming convention with
/Docssuffix - Updated operationId to match the new endpoint path structure
- Bumped SDK version to 3.2.1 across package.json, package-lock.json, and OpenAPI specification
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/shield/TypeScript/package.json | Incremented package version from 3.2.0 to 3.2.1 |
| src/shield/TypeScript/package-lock.json | Updated lockfile version references to 3.2.1 |
| specs/SHIELD.json | Renamed endpoint path and operationId, updated API version |
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Minor change to the format of the endpoint returning documentation for the configuration item