Skip to content

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

Merged
Pasha Zayko (pasha-zayko) merged 5 commits into
mainfrom
LAB-2305-Update-OpenAPI-spec-for-configuration-category-endpoint
May 28, 2026
Merged

LAB-2305 Update OpenAPI spec for configuration category endpoint#175
Pasha Zayko (pasha-zayko) merged 5 commits into
mainfrom
LAB-2305-Update-OpenAPI-spec-for-configuration-category-endpoint

Conversation

@bowaybilly

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings May 26, 2026 10:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.ConfigurationCategory schema (array of configuration category records).
  • Added GET /Api/Deploy/Component/ConfigurationCategory returning Deploy.ConfigurationCategory.
  • Added a documented 400 response to GET /Api/Deploy/Progress.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread specs/SHIELD.json Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@pasha-zayko Pasha Zayko (pasha-zayko) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread specs/SHIELD.json Outdated
Comment thread specs/SHIELD.json Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@pasha-zayko
Pasha Zayko (pasha-zayko) merged commit 894eb2d into main May 28, 2026
7 of 9 checks passed
@pasha-zayko
Pasha Zayko (pasha-zayko) deleted the LAB-2305-Update-OpenAPI-spec-for-configuration-category-endpoint branch May 28, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants