Update Open API specs for CSPM Assessment and Shield operations - #200
Merged
Conversation
…81_PostCSPMAssessmentSpec LAB-2581: Post CSPM Assessment Specs
LAB-2750 - Open API spec for shield operation mode endpoint
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ruman Mulla <91155446+Loop-infinity@users.noreply.github.com>
LAB-2585: [Data Gateway] Open API Spec for CSPM Assessment Data Retrieval
…5_CM_multiple_products YearConfig schema change for Assessment
Copilot started reviewing on behalf of
Jonny Pound (JonnyPound90)
September 9, 2026 12:43
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates the OpenAPI specifications to add API support for retrieving SHIELD’s current operation mode and to introduce CSPM Policy Assessment (V1) schemas and endpoints in the Data Gateway spec.
Changes:
- Added
Core.OperationModeschema andGET /Api/Core/OperationModeendpoint tospecs/SHIELD.json. - Added CSPM Policy Assessment V1 schemas plus submit/retrieve endpoints under
/Api/V1/ArchitectureReport/CspmPolicyAssessmentinspecs/Data-Gateway.json. - Updated the
altProductfield in an existing schema to be an array (now requiring an explicititemsschema).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| specs/SHIELD.json | Adds an operation-mode schema and a public endpoint to retrieve the SHIELD app’s current mode. |
| specs/Data-Gateway.json | Adds CSPM Policy Assessment V1 schemas/endpoints and adjusts an existing altProduct field representation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
2904
to
+2909
| "altProduct": { | ||
| "type": [ | ||
| "string", | ||
| "array", | ||
| "null" | ||
| ], | ||
| "description": "Alternate product, if any, or null.", | ||
| "description": "Alternative products that may be used for this year phase, or null when no alternatives apply.", |
…n-update Increasing Data Gateway package version
Introduces SHIELD telemetry event support in the Data Gateway OpenAPI spec, including new event schemas, event-name enum values, and endpoints to create events plus list events globally or by tenant with optional date filtering. Also bumps the API and TypeScript SDK package versions to 3.3.4 to publish the new contract.
Marks SHIELD event identifiers and timestamps as read-only in the OpenAPI schema. Updates the GET endpoint permission text to reflect the required Telemetry.Shield.Read.All and Telemetry.Shield.ReadWrite.All scopes, and adjusts the spec version metadata accordingly.
This change updates the Data Gateway schema descriptions for SHIELD event types and records to make the wording more concise and consistent. It removes redundant 'telemetry' phrasing and clarifies that the eventId uniquely identifies the event itself.
Update the Data Gateway OpenAPI specification and TypeScript SDK package metadata to version 3.4.0, keeping the published API version and generated package artifacts in sync.
This change adds example payloads for Shield event arrays in the Data-Gateway OpenAPI spec. The examples illustrate common event lifecycle entries such as installation and license report progress, improving discoverability and documentation for API consumers.
…e/ATL-674_Shield-Event-Endpoints-Description ATL-674:- Add SHIELD telemetry event API endpoints
Updating version for Shield
…fix-changes-to-shield Updating version for Shield
Pasha Zayko (pasha-zayko)
approved these changes
Sep 10, 2026
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.
This pull request adds support for exposing and documenting the current operation mode of the SHIELD application via the API. The main changes include the introduction of a new schema for operation mode and a new API endpoint to retrieve it.
API additions:
Core.OperationModetoSHIELD.jsonto represent the application's current operation mode, with example values such as"normal"and"discover"./Api/Core/OperationMode(GET) to retrieve the current operation mode, including response schema, example payload, and documentation.