Feature/lab 1198 update open api description for cm updated table#92
Merged
JagdishKhunti merged 5 commits intofeature/LAB-611_CMA_Endpoints_Descriptionsfrom Jan 8, 2026
Conversation
…elation Updated schema references, endpoint descriptions, tags, and summaries to use 'CloudMatrix.Correlation' instead of 'CloudMatrixAssessment.Correlation' for consistency and clarity in the API specification.
Updated schema references and descriptions from 'CloudMatrix.Correlation' to 'CloudMatrixCorrelationRecord' for clarity and consistency. Also updated related descriptions and titles to reflect the new naming, and adjusted the operation name and description for the cloud matrix feature.
Renamed the tag from 'Cloud Matrix Correlation' to 'Cloud Matrix' and revised the description for clarity in the Data-Gateway.json specification.
Revised descriptions for CloudMatrixCorrelationRecord and Cloud Matrix to improve clarity and consistency in terminology within the Data-Gateway.json specification.
pasha-zayko
approved these changes
Jan 8, 2026
JagdishKhunti
merged commit 4376a90
into
feature/LAB-611_CMA_Endpoints_Descriptions
6 checks passed
JagdishKhunti
deleted the
feature/LAB-1198_Update_OpenAPI_Description_For_CM_Updated_Table
branch
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAPI specification for the Cloud Matrix feature to align with database schema changes. The primary changes involve renaming the schema and field names to better reflect that the records represent correlation data rather than assessment data.
Key changes:
- Renamed
CloudMatrixAssessmentRecordschema toCloudMatrixCorrelationRecord - Renamed the
assessmentIdproperty tocorrelationIdthroughout the schema and examples - Updated all descriptions, summaries, and tag names from "Assessment" terminology to "Correlation" or generic "Cloud Matrix" terminology
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "description": "Sample list of cloud matrix records.", | ||
| "summary": "Available Cloud Matrix Records", | ||
| "description": "Sample list of cloud matrix correlation records.", | ||
| "summary": "Available Cloud Matrix correlation Records", |
There was a problem hiding this comment.
The summary has inconsistent capitalization of 'correlation'. It should be 'Correlation' (capitalized) to match the pattern used elsewhere in the file where 'Cloud Matrix Correlation Record' is capitalized.
Suggested change
| "summary": "Available Cloud Matrix correlation Records", | |
| "summary": "Available Cloud Matrix Correlation Records", |
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.
LAB-1198