LAB-2305 Update OpenAPI spec for configuration category endpoint - #175
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the SHIELD OpenAPI (3.1.1) specification to document a new Deploy “configuration category” listing endpoint and its response model, and expands the documented responses for the Deploy progress endpoint.
Changes:
- Added
Deploy.ConfigurationCategoryschema (array of configuration category records). - Added
GET /Api/Deploy/Component/ConfigurationCategoryreturningDeploy.ConfigurationCategory. - Added a documented
400response toGET /Api/Deploy/Progress.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
The names of several properties do not align with what code outlines. As they are updated all examples (in the definition and in the path have to be adjusted to use the correct names).
On line 4112 version should be incremented to indicate an enhancement change to the spec.
This same version change should be reflected in the corresponding package.json file for Shield. And then "npm install" to update reference in the package-lock.json file
updated ticket fix in 9ac83f9
No description provided.