Skip to content

Update SDK version to 3.3.2 and add auditVersion parameter to Data Gateway API #189

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
Jonny Pound (JonnyPound90) merged 3 commits into from
Jul 8, 2026
Merged

Update SDK version to 3.3.2 and add auditVersion parameter to Data Gateway API #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e8380e
Update SDK version to 3.3.2 and add auditVersion parameter to Data Ga…
CraigFW Jul 7, 2026
253667b
Update version examples and add UUID format for correlationId in Data…
CraigFW Jul 7, 2026
ab76129
Refactor correlationId property to reference Uuid schema in Data Gate…
CraigFW Jul 7, 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
98 changes: 66 additions & 32 deletions specs/Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@
"required": true,
"schema": {
"examples": [
"1.12.5"
"1.12.5.2"
],
"type": "string"
},
"examples": {
"Valid version number": {
"summary": "Example Valid Version Number",
"description": "An example string represents a valid semantic version number.",
"value": "1.2.3"
"value": "1.12.5.2"
Comment thread
CraigFW marked this conversation as resolved.
}
}
},
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -5254,35 +5274,54 @@
"type": "object",
"additionalProperties": false,
"required": [
"auditId",
"auditFilename",
"correlationId",
"name",
"lastUpdated",
"lastUpdatedBy",
"version",
"auditArea"
],
"properties": {
"auditId": {
"type": "string",
"format": "uuid"
"correlationId": {
"$ref": "#/components/schemas/Uuid",
"description": "Matches ID from whatever is being audited."
},
Comment thread
CraigFW marked this conversation as resolved.
Comment thread
CraigFW marked this conversation as resolved.
"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": [
Expand All @@ -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"
},
Expand All @@ -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"
Expand Down Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion src/dataGateway/TypeScript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.",
Expand Down
Loading