Skip to content

Feature/lab 1198 update open api description for cm updated table #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JagdishKhunti merged 5 commits into from
Jan 8, 2026
Merged

Feature/lab 1198 update open api description for cm updated table #92

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
face16c
LAB-1198
JagdishKhunti Dec 23, 2025
1c98381
LAB-1198 Rename CloudMatrixAssessment.Correlation to CloudMatrix.Corr…
JagdishKhunti Jan 8, 2026
2cb831b
LAB-1198 Rename CloudMatrix.Correlation to CloudMatrixCorrelationRecord
JagdishKhunti Jan 8, 2026
c654bfc
LAB-1198-Update Cloud Matrix tag and description in spec
JagdishKhunti Jan 8, 2026
f90523c
LAB-1198- Update Cloud Matrix descriptions in Data-Gateway spec
JagdishKhunti Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions specs/Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2302,12 +2302,12 @@
"$ref": "#/components/schemas/Report.PrincipalData",
"title": "Architecture Report - Principal Data"
},
"CloudMatrixAssessmentRecord": {
"description": "Represents a cloud matrix record, including customer, assessment, and publisher details, as well as key timestamps and identifiers.",
"CloudMatrixCorrelationRecord": {
"description": "Represents a Cloud Matrix correlation record, including customer and publisher details, as well as key timestamps and identifiers.",
"examples": [
{
"accountName": "Test Account Name",
"assessmentId": "bbab2907-c781-4bf1-b912-b91510853052",
"correlationId": "bbab2907-c781-4bf1-b912-b91510853052",
"createdAt": "2025-12-15T21:13:12.821Z",
"crmId": "75498125-33cb-4b33-8705-f0fadadb1a2f",
"discoverDate": "2025-12-15T21:13:12.821Z",
Expand All @@ -2318,14 +2318,14 @@
],
"properties": {
"accountName": {
"description": "The name of the customer account associated with this cloud matrix assessment record.",
"description": "The name of the customer account associated with this cloud matrix correlation record.",
"examples": [
"Test Account Name"
],
"type": "string"
},
"assessmentId": {
"description": "The unique identifier (UUID) of the discovery session associated with this cloud matrix assessment record.",
"correlationId": {
"description": "The unique identifier (UUID) of the discovery session associated with this cloud matrix correlation record.",
"examples": [
"bbab2907-c781-4bf1-b912-b91510853052"
],
Expand All @@ -2344,7 +2344,7 @@
"type": "string"
},
"crmId": {
"description": "The unique identifier (UUID) of the customer associated with this cloud matrix assessment record.",
"description": "The unique identifier (UUID) of the customer associated with this cloud matrix correlation record.",
"examples": [
"75498125-33cb-4b33-8705-f0fadadb1a2f"
],
Expand All @@ -2363,14 +2363,14 @@
"type": "string"
},
"isComplete": {
"description": "Indicates whether the discovery process has been completed for this cloud matrix assessment record.",
"description": "Indicates whether the discovery process has been completed for this cloud matrix correlation record.",
"examples": [
true
],
"type": "boolean"
},
"publisher": {
"description": "The name of the publisher associated with this cloud matrix assessment record.",
"description": "The name of the publisher associated with this cloud matrix correlation record.",
"examples": [
"Test Publisher"
],
Expand All @@ -2391,7 +2391,7 @@
"discoverDate",
"publisher"
],
"title": "Cloud Matrix Assessment Record",
"title": "Cloud Matrix Correlation Record",
"type": "object"
}
},
Expand Down Expand Up @@ -6796,7 +6796,7 @@
},
"/Api/CloudMatrix/Dashboard": {
"get": {
"description": "Retrieves the list of cloud matrix records. Can use filters targeting creation date to limit results. Cloud matrix records store the metadata for a specific cloud matrix assessment.\n\nThis endpoint requires the `CloudMatrix.Read`, `CloudMatrix.Read.All`, `CloudMatrix.ReadWrite`, or `CloudMatrix.ReadWrite.All` scope (permission).",
"description": "Retrieves the list of cloud matrix correlation records. Can use filters targeting creation date to limit results. Cloud matrix records store the metadata for a specific cloud matrix correlation.\n\nThis endpoint requires the `CloudMatrix.Read`, `CloudMatrix.Read.All`, `CloudMatrix.ReadWrite`, or `CloudMatrix.ReadWrite.All` scope (permission).",
"operationId": "/Api/CloudMatrix/Dashboard/Get",
"parameters": [
{
Expand All @@ -6808,17 +6808,17 @@
],
"responses": {
"200": {
"description": "A list of cloud matrix records.",
"description": "A list of cloud matrix correlation records.",
"content": {
"application/json": {
"examples": {
"Example Cloud Matrix Records": {
"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",
Copy link

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

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

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",

Copilot uses AI. Check for mistakes.
"value": [
{
"accountName": "Test Account Name",
"assessmentId": "bbab2907-c781-4bf1-b912-b91510853052",
"correlationId": "bbab2907-c781-4bf1-b912-b91510853052",
"createdAt": "2025-12-15T21:13:12.821Z",
"crmId": "75498125-33cb-4b33-8705-f0fadadb1a2f",
"discoverDate": "2025-12-15T21:13:12.821Z",
Expand All @@ -6828,7 +6828,7 @@
},
{
"accountName": "Test Account Name",
"assessmentId": "e7cc9996-3c5f-4be4-bba2-c815a157dedb",
"correlationId": "e7cc9996-3c5f-4be4-bba2-c815a157dedb",
"createdAt": "2025-12-15T21:13:12.821Z",
"crmId": "fbea61c3-6c80-4fbb-9bd7-b6fa2356892e",
"discoverDate": "2025-12-15T21:13:12.821Z",
Expand All @@ -6844,7 +6844,7 @@
[
{
"accountName": "Test Account Name",
"assessmentId": "bbab2907-c781-4bf1-b912-b91510853052",
"correlationId": "bbab2907-c781-4bf1-b912-b91510853052",
"createdAt": "2025-12-15T21:13:12.821Z",
"crmId": "75498125-33cb-4b33-8705-f0fadadb1a2f",
"discoverDate": "2025-12-15T21:13:12.821Z",
Expand All @@ -6854,7 +6854,7 @@
},
{
"accountName": "Test Account Name",
"assessmentId": "e7cc9996-3c5f-4be4-bba2-c815a157dedb",
"correlationId": "e7cc9996-3c5f-4be4-bba2-c815a157dedb",
"createdAt": "2025-12-15T21:13:12.821Z",
"crmId": "fbea61c3-6c80-4fbb-9bd7-b6fa2356892e",
"discoverDate": "2025-12-15T21:13:12.821Z",
Expand All @@ -6865,7 +6865,7 @@
]
],
"items": {
"$ref": "#/components/schemas/CloudMatrixAssessmentRecord"
"$ref": "#/components/schemas/CloudMatrixCorrelationRecord"
},
"minItems": 0,
"type": "array"
Expand All @@ -6881,9 +6881,9 @@
}
},
"tags": [
"Cloud Matrix Assessment"
"Cloud Matrix"
],
"summary": "Get Cloud Matrix Assessment Records"
"summary": "Get Cloud Matrix Correlation Records"
}
}
},
Expand Down Expand Up @@ -6940,8 +6940,8 @@
"description": "Enables query for available information (like tenant, license, etc) via conversation with OpenAI agent."
},
{
"description": "Collects and manages data for customer's cloud matrix assessments.",
"name": "Cloud Matrix Assessment"
"description": "Collects and manages customer Cloud Matrix data.",
"name": "Cloud Matrix"
}
]
}