Skip to content

LAB-1051#90

Merged
JagdishKhunti merged 4 commits intofeature/LAB-611_CMA_Endpoints_Descriptionsfrom
feature/LAB-1051_Create-OpenAPI-Spec-For-CMA-Dashboard-Data
Dec 18, 2025
Merged

LAB-1051#90
JagdishKhunti merged 4 commits intofeature/LAB-611_CMA_Endpoints_Descriptionsfrom
feature/LAB-1051_Create-OpenAPI-Spec-For-CMA-Dashboard-Data

Conversation

@JagdishKhunti
Copy link
Copy Markdown
Contributor

  • Introduces the CloudMatrix schema to the API specification, representing cloud matrix records.
  • Adds the /Api/CloudMatrix/Dashboard GET endpoint for retrieving cloud matrix records with optional date filters.
  • Adds the 'Cloud Matrix Assessment' tag for API documentation.

- Introduces the CloudMatrix schema to the API specification, representing cloud matrix assessment records.
- Adds the /Api/CloudMatrix/Dashboard GET endpoint for retrieving cloud matrix records with optional date filters.
- Adds the 'Cloud Matrix Assessment' tag for API documentation.
Corrected wording in the 'assessmentId' and 'discoverDate' property descriptions to improve clarity and fix typographical errors.
Changed the 'isComplete' field type from integer to boolean in the Data-Gateway.json spec, updated example values, and removed the 'format' property. This improves schema accuracy and aligns example data with the new type.
Copy link
Copy Markdown
Contributor

@pasha-zayko pasha-zayko left a comment

Choose a reason for hiding this comment

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

A few minor tweaks. And pending discussion on the required fields.
The missing piece - version update in the spec file and package.json to reflect the new changes. Considering these are new endpoints, incrementing minor value is the best approach.

Copy link
Copy Markdown

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 introduces the Cloud Matrix Assessment API to the Data Gateway specification, enabling retrieval of cloud matrix assessment metadata. The changes add a new schema definition, a GET endpoint for querying records with date filtering, and appropriate API documentation tagging.

  • Adds CloudMatrix schema with properties for customer account, assessment identifiers, timestamps, and completion status
  • Introduces GET endpoint /Api/CloudMatrix/Dashboard with optional date range filtering
  • Adds "Cloud Matrix Assessment" tag for API documentation organization

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

- Updated the schema name from CloudMatrix to CloudMatrixAssessmentRecord in Data-Gateway.json.
- Adjusted references, property descriptions, and example values to reflect the new naming and provide clearer documentation.
- Updated the version in package and package.lock json
@JagdishKhunti JagdishKhunti merged commit 1994fbb into feature/LAB-611_CMA_Endpoints_Descriptions Dec 18, 2025
2 checks passed
@JagdishKhunti JagdishKhunti deleted the feature/LAB-1051_Create-OpenAPI-Spec-For-CMA-Dashboard-Data branch December 18, 2025 08:51
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.

4 participants