From 2e8380ef58ab9ba1c7487163280912c12fc2bd8e Mon Sep 17 00:00:00 2001 From: Craig Whittington Date: Tue, 7 Jul 2026 13:46:15 +0100 Subject: [PATCH 1/3] Update SDK version to 3.3.2 and add auditVersion parameter to Data Gateway API --- specs/Data-Gateway.json | 94 +++++++++++++++++-------- src/dataGateway/TypeScript/package.json | 2 +- 2 files changed, 65 insertions(+), 31 deletions(-) diff --git a/specs/Data-Gateway.json b/specs/Data-Gateway.json index a7f5a6a..9c16bd4 100644 --- a/specs/Data-Gateway.json +++ b/specs/Data-Gateway.json @@ -90,7 +90,7 @@ "Valid version number": { "summary": "Example Valid Version Number", "description": "An example string represents a valid semantic version number.", - "value": "1.2.3" + "value": "1.2.3.1" } } }, @@ -249,6 +249,26 @@ "default": 50 } }, + "auditVersion": { + "name": "version", + "in": "query", + "description": "Exact version selector for the Cloud Matrix audit detail record. Required format: Major.Minor.Patch.IterationVersion.", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", + "examples": [ + "1.2.3.1" + ] + }, + "examples": { + "valid audit version": { + "summary": "Example valid audit version", + "description": "A valid Cloud Matrix audit detail version.", + "value": "6.0.1.1" + } + } + }, "auditId": { "description": "The unique identifier of the Cloud Matrix audit event.", "in": "path", @@ -5254,35 +5274,54 @@ "type": "object", "additionalProperties": false, "required": [ - "auditId", - "auditFilename", + "correlationId", + "name", "lastUpdated", "lastUpdatedBy", "version", "auditArea" ], "properties": { - "auditId": { + "correlationId": { "type": "string", - "format": "uuid" + "description": "Matches ID from whatever is being audited." }, - "auditFilename": { - "type": "string" + "name": { + "type": "string", + "description": "Name associated with the audit record." }, "lastUpdated": { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/DateTimeStringType", + "description": "Timestamp of the last update to the audit record." }, "lastUpdatedBy": { - "$ref": "#/components/schemas/CloudMatrix.LastUpdatedBy" + "$ref": "#/components/schemas/CloudMatrix.LastUpdatedBy", + "description": "User who last updated the audit record." }, "version": { - "type": "string" + "type": "string", + "description": "Version of the audit record." }, "auditArea": { - "type": "string" + "type": "string", + "description": "Area of the application or system that this audit record pertains to." + }, + "message": { + "type": "string", + "description": "Reason for the update, if provided." } - } + }, + "examples": [ + { + "correlationId": "8c9d7e36-8b71-4b46-b4da-7d1f7fd9a001", + "name": "cloud-matrix-template-update.json", + "lastUpdated": "2026-03-09T09:30:16.000Z", + "lastUpdatedBy": "Joe Bloggs", + "version": "6.0.1.1", + "auditArea": "Cloud Matrix Template", + "message": "Updated display name and contact email." + } + ] }, "CloudMatrix.AuditDetail": { "allOf": [ @@ -5293,18 +5332,11 @@ "type": "object", "additionalProperties": false, "required": [ - "template", "originalRecord", "updatedRecord", "diff" ], "properties": { - "template": { - "type": "string" - }, - "reasonForUpdate": { - "type": "string" - }, "originalRecord": { "$ref": "#/components/schemas/CloudMatrix.AuditValue" }, @@ -5319,14 +5351,13 @@ ], "examples": [ { - "auditId": "8c9d7e36-8b71-4b46-b4da-7d1f7fd9a001", - "auditFilename": "cloud-matrix-template-update.json", + "correlationId": "8c9d7e36-8b71-4b46-b4da-7d1f7fd9a001", + "name": "cloud-matrix-template-update.json", "lastUpdated": "2026-03-09T09:30:16.000Z", "lastUpdatedBy": "Joe Bloggs", "version": "6.0.1.1", "auditArea": "Cloud Matrix Template", - "template": "Microsoft Enterprise", - "reasonForUpdate": "Updated display name and contact email.", + "message": "Updated display name and contact email.", "originalRecord": { "name": "Claudine Potter", "email": "claudine.potter@acme_widgets.com" @@ -12326,22 +12357,25 @@ } } }, - "/Api/CloudMatrix/Audits/{auditId}": { + "/Api/CloudMatrix/Audits/{correlationId}": { "get": { "tags": [ "Cloud Matrix" ], - "summary": "Get a specific Cloud Matrix audit event", - "description": "Returns the specified Cloud Matrix audit event by audit ID.\n\nThis endpoint requires the `CloudMatrix.Read` scope (permission).", - "operationId": "/Api/CloudMatrix/Audits/:auditId/Get", + "summary": "Get a specific Cloud Matrix audit detail record", + "description": "Returns the specified Cloud Matrix audit detail record by correlation ID and version.\n\nThis endpoint requires the `CloudMatrix.Read` scope (permission).", + "operationId": "/Api/CloudMatrix/Audits/:correlationId/Get", "parameters": [ { - "$ref": "#/components/parameters/auditId" + "$ref": "#/components/parameters/correlationId" + }, + { + "$ref": "#/components/parameters/auditVersion" } ], "responses": { "200": { - "description": "Cloud Matrix audit event retrieved successfully.", + "description": "Cloud Matrix audit detail record retrieved successfully.", "content": { "application/json": { "schema": { diff --git a/src/dataGateway/TypeScript/package.json b/src/dataGateway/TypeScript/package.json index 560803e..29bea49 100644 --- a/src/dataGateway/TypeScript/package.json +++ b/src/dataGateway/TypeScript/package.json @@ -1,6 +1,6 @@ { "name": "@software-hardware-integration-lab/sdk-data-gateway", - "version": "3.3.1", + "version": "3.3.2", "type": "module", "main": "bin/index.js", "description": "SDK client used to interface with the SHI Data Gateway service.", From 253667bbea7acf13e6e73e3d0bc40781e902ed5e Mon Sep 17 00:00:00 2001 From: Craig Whittington Date: Tue, 7 Jul 2026 14:00:30 +0100 Subject: [PATCH 2/3] Update version examples and add UUID format for correlationId in Data Gateway API --- specs/Data-Gateway.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/specs/Data-Gateway.json b/specs/Data-Gateway.json index 9c16bd4..0c0a11b 100644 --- a/specs/Data-Gateway.json +++ b/specs/Data-Gateway.json @@ -82,7 +82,7 @@ "required": true, "schema": { "examples": [ - "1.12.5" + "1.12.5.2" ], "type": "string" }, @@ -90,7 +90,7 @@ "Valid version number": { "summary": "Example Valid Version Number", "description": "An example string represents a valid semantic version number.", - "value": "1.2.3.1" + "value": "1.12.5.2" } } }, @@ -5284,6 +5284,7 @@ "properties": { "correlationId": { "type": "string", + "format":"uuid", "description": "Matches ID from whatever is being audited." }, "name": { From ab76129b34377e40ba104ae72ce1ba65acfed84f Mon Sep 17 00:00:00 2001 From: Craig Whittington Date: Tue, 7 Jul 2026 14:14:19 +0100 Subject: [PATCH 3/3] Refactor correlationId property to reference Uuid schema in Data Gateway API --- specs/Data-Gateway.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specs/Data-Gateway.json b/specs/Data-Gateway.json index 0c0a11b..364a9f6 100644 --- a/specs/Data-Gateway.json +++ b/specs/Data-Gateway.json @@ -5283,8 +5283,7 @@ ], "properties": { "correlationId": { - "type": "string", - "format":"uuid", + "$ref": "#/components/schemas/Uuid", "description": "Matches ID from whatever is being audited." }, "name": {