Skip to content

Conversation

@pasha-zayko
Copy link
Contributor

Deploy v3 update

  • /Api/Deploy - updated with new status codes and request/response object structures
  • /Api/Deploy/Architecture - added new endpoint that returns list of usable architectures
  • /Api/Deploy/Version - obsolete endpoint was removed
  • /Api/Deploy/Compare - added new endpoint to get caches results of resources' evaluation
  • /Api/Deploy/Compare/Invoke - added new endpoint to request new evaluation and return results
  • /Api/Deploy/Restore/:templateId - added new endpoint to modify resource with original values
  • /Api/Deploy/Remove - added new endpoint to trigger process of removing entire provisioned infrastructure
  • /Api/Deploy/Skip - added new endpoint to retrieve list of rules indicating ignored targets during the evaluation
  • /Api/Deploy/Skip/:templateId - added new endpoint to enable add/remove operations with ignore targets

Added routes for compare/restore/remove operations on the deployed resources

Included routes for override handling during the evaluation process

Updated existing routes to reflect current set of possible response codes and changed payloads or returned structures

Removing obsolete /version route
@pasha-zayko pasha-zayko self-assigned this Jul 10, 2025
@pasha-zayko pasha-zayko added the enhancement New feature or request label Jul 10, 2025
@pasha-zayko pasha-zayko changed the title Updates Shield routes to reflect changes with Deploy V3 process Updates to Shield routes to reflect changes with Deploy V3 process Jul 10, 2025
@pasha-zayko pasha-zayko marked this pull request as draft July 15, 2025 14:17
Updating Get call to include another property being returned

Adding Patch call for the tag handling and extra resource provisioning
… to list records

Compare and Compare/Invoke endpoints now return data as arrays instead of objects with dynamic property names
@pasha-zayko pasha-zayko marked this pull request as ready for review July 17, 2025 20:11
Copilot AI review requested due to automatic review settings July 17, 2025 20:11
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Shield API routes to reflect the new Deploy V3 process architecture, expanding the deployment functionality from basic infrastructure deployment to a comprehensive resource management system.

  • Updates existing /Api/Deploy endpoint with new status codes and enhanced request/response structures
  • Adds new endpoints for architecture management, resource evaluation, restoration, removal, and skip rule handling
  • Removes obsolete /Api/Deploy/Version endpoint and updates several endpoint summaries for consistency

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 Version bump from 3.0.4 to 3.0.5
specs/SHIELD.json Major API specification update adding new Deploy V3 schemas, endpoints, and restructuring existing deployment routes
Files not reviewed (1)
  • src/shield/TypeScript/package-lock.json: Language not supported

Thanks copilot
Adding new endpoint to handle requests for list of configuration items

Adjusting path on the request for the list of architectures
Properties describing used plugins are not needed
@elliot-huffman elliot-huffman changed the title Updates to Shield routes to reflect changes with Deploy V3 process [Feature] SHIELD - Deploy v3 Oct 9, 2025
Copy link
Contributor

@elliot-huffman elliot-huffman left a comment

Choose a reason for hiding this comment

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

Please update to OpenAPI 3.1 as seen on the main branch. Thanks!

@pasha-zayko pasha-zayko marked this pull request as draft October 9, 2025 15:18
Enhanced information presentation with elements expected in OpenApi spec v3.1
@pasha-zayko pasha-zayko marked this pull request as ready for review October 9, 2025 19:08
Copy link

Copilot AI left a comment

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 3 changed files in this pull request and generated no new comments.

Files not reviewed (1)
  • src/shield/TypeScript/package-lock.json: Language not supported

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Add missing route ("operationId": "/Api/Deploy/Remove/Get").
Move all the deploy operations next to each other so that the reading party doesn't have to bounce around the doc.
Update permission wording.
Copy link
Contributor

@elliot-huffman elliot-huffman left a comment

Choose a reason for hiding this comment

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

After fixes, looks good!

@elliot-huffman elliot-huffman merged commit 662da40 into main Oct 14, 2025
6 checks passed
@elliot-huffman elliot-huffman deleted the pasha-deploy-v3-routes branch October 14, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants