Introduce new endpoints to support CSPM work by pasha-zayko · Pull Request #86 · Software-Hardware-Integration-Lab/OpenAPI

pasha-zayko · 2025-12-15T18:08:14Z

Significant enhancements and feature additions to the SHI Data Gateway and SHIELD OpenAPI specifications, along with corresponding SDK version bumps and dependency updates. Below is a consolidated, non-redundant summary of the notable changes based on the cumulative commit differences:

SHI Data Gateway & General OpenAPI Enhancements

License Report API Improvements:

Introduces versioned endpoints (/Api/V1/LicenseReport) supporting a new LicenseReportV1 schema that improves structure, clarity, and extensibility.
Adds new schemas for enhanced principal and license reporting, e.g., enhanced identity data for users, richer structure for available licenses and service plans, and improved correlation records.
Updates error handling, response schemas, and documentation for better alignment with customer scenarios and API consumers' needs.

Architecture Report API Additions:

Adds a complete API and schema for submitting and retrieving Architecture Analysis Reports (/Api/V1/ArchitectureReport).
Introduces correlation and principal data models for these architecture reports, supporting detailed tenant, user, and device metadata.
New endpoints supporting versioned architecture correlation records and report retrieval.

Tenant & Update API Improvements:

Expands tenant record endpoints: new PATCH and GET sources, better support for parent/child relationships and principal authorization lists.
Adds and documents new endpoints for retrieving/updating tenant configurations via SHIELD's update service.

SHIELD Specification & CSPM Features

CSPM & Security Posture Updates:

Substantial enrichment of the CSPM-related structures, including new policy assessment endpoints and result objects for architecture reports and remediation.
Adds new status endpoints and schemas for tracking deployment, remediation, and break glass scenarios.
Introduces operation selectors and result objects (e.g., flagging deploy, remediate, or analysis actions).

Configuration Item Metadata:

New endpoints and detailed schema for retrieving user-friendly, instructional metadata for configuration items (including guidance, compliance mapping, risk, and benefit analysis).

Remediation Automation Support:

Adds endpoints and models for tracking and returning remediation actions and results, allowing for clearer reporting on automated or user-approved remediation flows.

SDK & Dependency Management

SDK Package Version Updates:

Bumps @shi-corp/sdk-data-gateway to v2.4.0 and @shi-corp/sdk-shield to v3.1.0 to reflect breaking changes and new features.
Corresponding updates in package.json and package-lock.json files for each SDK.
Integrates newer/updated dependencies, including peer dependency refinements and essential dependency upgrades (e.g., linting, browser compatibility, comment handling, and type definitions).

Additional Quality & Maintenance

Expanded error handling and improved consistency in HTTP response codes (including more 500 and 404 responses).
Improved OpenAPI doc organization, code examples, and schema title/description for maintainability and clarity.
Numerous examples and extended documentation to facilitate SDK generation and user onboarding.

Creating definition for new remediation endpoint with POST request

Define new endpoint that attempts to create new group and return its name, or just returns name if the resource has already been provisioned

updated spec to include the newly added /Api/Deploy/BreakGlassStatus endpoint

removed unneeded object schema

…example to match the definition Deploy.ConfigurationItem response now also includes deployStatus field Change example to accurately present available fields

@pasha-zayko

updated endpoint name to match incoming schema update from @pasha-zayko

Fixed copilot pr suggested problems

…oup-and-users' into LAB-938-CSPM-main

Included optional query parameter with possible values to retrieve progress of the specific operation

Typos and text clarification

* Adding description to request remediation results Adding new schema and verb option to /Api/Deploy/Remediate path

- Added endpoint and schema descriptions for LicenseReportV1 - Extracted common schema into a shared object for reuse in both LicenseReport and LicenseReportV1

Adding schema to describe documentation response object when data is available. Adding path to handle retrieval of the configuration item documentation.

* LAB-979 - [SHIELD] Add Open API Spec for Deploy/Analyze/Invoke

Renamed LicenseReportV1 schemas to Report.* for consistency and updated all references. Added detailed descriptions, examples, and validation patterns to license, principal, and service plan fields. Improved API response codes and documentation for error handling and deletion endpoints.

Updated the Data-Gateway JSON schema to clarify and expand user and device principal records, including required fields and more detailed property definitions. Enhanced the structure and examples for inferred attributes and enhanced identity data, added explicit nullability, and improved descriptions for service plan and license references. These changes improve schema accuracy and documentation for integrators.

…ationId/Data * LAB-989: [SHIELD] Add Open API Spec for Discover/ArchitectureReport/Correlation/:correlationId/Data

Refactored user and device principal data schemas to use new CommonService, AssignedLicense, and PrincipalMetadata references under Report.PrincipalData. Simplified nullable property definitions and examples. Added 500 error responses to multiple API endpoints for improved error handling.

Revised the structure of the 'examples' field for assigned licenses, wrapping multiple example objects in an array and adding a new example. This improves consistency and clarity in the API specification.

Refactored and expanded example objects for available licenses, users, and devices to improve clarity and coverage. Adjusted nesting and array structures for consistency and added additional sample entries to better illustrate expected data formats.

* Adding new endpoint to provide list of correlation records Listing available correlation entries for the Architecture Report

…/LAB-980_Describe-V1-LicenseReport-API-Endpoints LAB-980

Introduces the ArchitectureReportV1 schema, supporting objects, and new API endpoints for submitting, retrieving, and deleting architecture reports and correlation records. Also adds the 'Architecture Reporting' tag to the API documentation.

Copilot

Pull request overview

Copilot reviewed 3 out of 6 changed files in this pull request and generated 2 comments.

Files not reviewed (2)

src/dataGateway/TypeScript/package-lock.json: Language not supported
src/shield/TypeScript/package-lock.json: Language not supported

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

specs/SHIELD.json

Providing description for the endpoint already available in the main code

Set all summary values to title case Correct any descriptions for readability

Copilot

Pull request overview

Copilot reviewed 2 out of 6 changed files in this pull request and generated 1 comment.

Files not reviewed (2)

src/dataGateway/TypeScript/package-lock.json: Language not supported
src/shield/TypeScript/package-lock.json: Language not supported

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

specs/SHIELD.json

Regenerate lock. Update overrides. Fix dev utils version specifier.

socket-security · 2026-01-27T18:49:48Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality	Maintenance
@shi-corp/development-utilities@2.1.0 ⏵ 2.2.0	⁺¹		^-2
@types/node@25.0.3 ⏵ 25.0.10	⁺¹	⁺¹	⁺¹
typia@11.0.0 ⏵ 11.0.3			⁺³

View full report

When data is not present 404 would be returned

Copilot

Pull request overview

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

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

Make the version match the published version of Data Gateway.

To match the product name.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Updating schema for LicenseReport to match new format for v1

…are-Integration-Lab/OpenAPI into LAB-938-CSPM-main

Copilot

Pull request overview

Copilot reviewed 3 out of 8 changed files in this pull request and generated 2 comments.

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

src/dataGateway/TypeScript/package.json

src/shield/TypeScript/package.json

Typo

Copilot

Pull request overview

Copilot reviewed 3 out of 8 changed files in this pull request and generated 3 comments.

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

src/dataGateway/TypeScript/package.json

src/urlShortener/TypeScript/package.json

src/dataGateway/TypeScript/package.json

To match the upcoming feature set for CSPM.

elliot-huffman

Looks good!

pasha-zayko and others added 30 commits October 13, 2025 12:35

Adding remediation point definition

9e1f440

Creating definition for new remediation endpoint with POST request

Merge branch 'main' into pasha-remediation-lab-815

bed1d14

Merge branch 'main' into pasha-remediation-lab-815

1294fd3

Merge branch 'main' into pasha-remediation-lab-815

79eafbc

Adding endpoint to create BreakGlass group resource

5627f91

Define new endpoint that attempts to create new group and return its name, or just returns name if the resource has already been provisioned

updated spec to include new endpoint

5a67984

updated spec to include the newly added /Api/Deploy/BreakGlassStatus endpoint

removed unneeded schema

c973430

removed unneeded object schema

Merge branch 'main' into pasha-remediation-lab-815

63eae81

Updating the spec definition to reflect all properties and adjusting …

cb38c2a

…example to match the definition Deploy.ConfigurationItem response now also includes deployStatus field Change example to accurately present available fields

updated endpoint path

e1e58f6

updated endpoint name to match incoming schema update from @pasha-zayko

fixed copilot suggestions

92ada1f

Fixed copilot pr suggested problems

Merge branch 'LAB-916-Update-API-to-check-for-existing-break-glass-gr…

33854be

…oup-and-users' into LAB-938-CSPM-main

Merge branch 'main' into LAB-938-CSPM-main

d793095

Adding optional operation to Deploy/Progress endpoint

8e85e33

Included optional query parameter with possible values to retrieve progress of the specific operation

Typos and text clarification

4612502

Typos and text clarification

Adding description to request remediation results (#70)

55104d8

* Adding description to request remediation results Adding new schema and verb option to /Api/Deploy/Remediate path

LAB-980

a56e847

- Added endpoint and schema descriptions for LicenseReportV1 - Extracted common schema into a shared object for reuse in both LicenseReport and LicenseReportV1

Adding new schema and path for configuration item metadata (#75)

6cf8173

Adding schema to describe documentation response object when data is available. Adding path to handle retrieval of the configuration item documentation.

LAB-979 - [SHIELD] Add Spec for Deploy/Analyze/Invoke (#73)

3e7c417

* LAB-979 - [SHIELD] Add Open API Spec for Deploy/Analyze/Invoke

Update Data-Gateway.json

0bd0f0d

LAB-1034: [SHIELD] Open Api Spec for Deploy/Progress (#78)

2d98a00

Add Open API Spec for Discover/ArchitectureReport/Correlation/:correl…

85d6ae6

…ationId/Data * LAB-989: [SHIELD] Add Open API Spec for Discover/ArchitectureReport/Correlation/:correlationId/Data

LAB-987

f9faf37

Revised the structure of the 'examples' field for assigned licenses, wrapping multiple example objects in an array and adding a new example. This improves consistency and clarity in the API specification.

LAB-980

381385a

Refactored and expanded example objects for available licenses, users, and devices to improve clarity and coverage. Adjusted nesting and array structures for consistency and added additional sample entries to better illustrate expected data formats.

Adding new endpoint to provide list of correlation records (#82)

0256206

* Adding new endpoint to provide list of correlation records Listing available correlation entries for the Architecture Report

Merge pull request #71 from Software-Hardware-Integration-Lab/feature…

228bd67

…/LAB-980_Describe-V1-LicenseReport-API-Endpoints LAB-980

Add Architecture Report V1 API and schemas

c629f9c

Introduces the ArchitectureReportV1 schema, supporting objects, and new API endpoints for submitting, retrieving, and deleting architecture reports and correlation records. Also adds the 'Architecture Reporting' tag to the API documentation.

Merge branch 'main' into LAB-938-CSPM-main

0ef4ebc

pasha-zayko requested a review from Copilot January 20, 2026 21:34

Copilot started reviewing on behalf of pasha-zayko January 20, 2026 21:34 View session

Copilot AI reviewed Jan 20, 2026

View reviewed changes

specs/SHIELD.json Show resolved Hide resolved

specs/SHIELD.json Outdated Show resolved Hide resolved

pasha-zayko added 2 commits January 21, 2026 14:16

Adding definition for new endpoint

5f300fb

Providing description for the endpoint already available in the main code

Update details of summaries and descriptions

d956e13

Set all summary values to title case Correct any descriptions for readability

Copilot AI review requested due to automatic review settings January 21, 2026 22:56

Copilot started reviewing on behalf of pasha-zayko January 21, 2026 22:57 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

specs/SHIELD.json Outdated Show resolved Hide resolved

Update Packages

b8387cd

Regenerate lock. Update overrides. Fix dev utils version specifier.

Removing empty response as string

182b986

When data is not present 404 would be returned

Copilot AI review requested due to automatic review settings January 29, 2026 15:53

Copilot started reviewing on behalf of pasha-zayko January 29, 2026 15:53 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

elliot-huffman added 2 commits February 2, 2026 12:52

Bump Version

562bc75

Make the version match the published version of Data Gateway.

Update Title

51b7a83

To match the product name.

Copilot AI review requested due to automatic review settings February 2, 2026 19:39

Copilot AI reviewed Feb 2, 2026

View reviewed changes

pasha-zayko added 2 commits February 2, 2026 17:56

Updating LicenseReport definition

c6ab7a4

Updating schema for LicenseReport to match new format for v1

Merge branch 'LAB-938-CSPM-main' of https://github.com/Software-Hardw…

29d8310

…are-Integration-Lab/OpenAPI into LAB-938-CSPM-main

pasha-zayko requested a review from Copilot February 2, 2026 22:57

Copilot AI reviewed Feb 2, 2026

View reviewed changes

src/dataGateway/TypeScript/package.json Show resolved Hide resolved

src/shield/TypeScript/package.json Show resolved Hide resolved

Typo

cd563a3

Typo

pasha-zayko requested a review from Copilot February 2, 2026 23:00

Copilot AI reviewed Feb 2, 2026

View reviewed changes

src/dataGateway/TypeScript/package.json Show resolved Hide resolved

src/urlShortener/TypeScript/package.json Show resolved Hide resolved

src/dataGateway/TypeScript/package.json Show resolved Hide resolved

Bump SHIELD Versions

35b6c7b

To match the upcoming feature set for CSPM.

elliot-huffman approved these changes Feb 3, 2026

View reviewed changes

elliot-huffman merged commit 702fb1b into main Feb 3, 2026
6 checks passed

elliot-huffman deleted the LAB-938-CSPM-main branch February 3, 2026 13:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce new endpoints to support CSPM work#86

Introduce new endpoints to support CSPM work#86
elliot-huffman merged 66 commits intomainfrom
LAB-938-CSPM-main

pasha-zayko commented Dec 15, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

socket-security bot commented Jan 27, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elliot-huffman left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

pasha-zayko commented Dec 15, 2025

SHI Data Gateway & General OpenAPI Enhancements

SHIELD Specification & CSPM Features

SDK & Dependency Management

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

socket-security bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elliot-huffman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

socket-security bot commented Jan 27, 2026 •

edited

Loading