Adding new schema and path for configuration item metadata #75
Conversation
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
Adding schema to describe documentation response object when data is available. Adding path to handle retrieval of the configuration item documentation.
There was a problem hiding this comment.
Pull request overview
This PR adds a new schema and API endpoint to support retrieving configuration item metadata/documentation. The schema defines comprehensive metadata fields including title, description, priority, risks, deployment guidance, compliance information, and educational links. The endpoint allows clients to retrieve this documentation for a specific configuration item by template ID.
Key Changes:
- Added
Deploy.ConfigurationItemMetaDataschema with 12 properties describing configuration item documentation - Added GET endpoint
/Api/Deploy/Component/ConfigurationItemMetaData/{templateId}to retrieve metadata - Implemented flexible response handling that returns either full metadata object or a message when documentation is unavailable
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pr0uxx
approved these changes
Nov 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adding schema to describe documentation response object when data is available.
Adding path to handle retrieval of the configuration item documentation.