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

[Craig Whittington (CraigFW)]

This pull request updates the Cloud Matrix audit detail API to improve versioning, clarify parameter naming, and enhance the audit detail schema. The changes introduce a new required version parameter, replace auditId with correlationId, and restructure the audit detail object for better clarity and extensibility.

API Endpoint and Parameter Updates:

• Changed the primary identifier in the audit detail API from auditId to correlationId and updated the endpoint path to /Api/CloudMatrix/Audits/{correlationId}. The endpoint now also requires an explicit version query parameter (auditVersion) in the format Major.Minor.Patch.IterationVersion (e.g., 1.2.3.1). [1] [2]

Schema and Example Changes:

• Refactored the audit detail schema: replaced required fields auditId and auditFilename with correlationId and name, added a message field, and enhanced descriptions for clarity. Updated examples to match the new schema. [1] [2]
• Removed obsolete fields (template, reasonForUpdate) from the audit detail object, streamlining the schema.
• Updated the example version number format throughout to include the new four-part version (e.g., 1.2.3.1).

SDK Version Bump:

• Bumped the TypeScript SDK package version to 3.3.2 to reflect these API changes.

[Copilot]

Pull request overview

This pull request updates the Data Gateway OpenAPI spec and TypeScript SDK version to support a revised Cloud Matrix audit detail API contract, including a new required audit version selector and updated audit detail identifiers/schema.

Changes:

• Bump Data Gateway TypeScript SDK version to 3.3.2.
• Update Cloud Matrix audit detail endpoint to use {correlationId} and require a version (component: auditVersion) query parameter.
• Refactor audit detail/summary schema fields (auditId/auditFilename → correlationId/name), add message, and remove obsolete fields.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/dataGateway/TypeScript/package.json	Bumps SDK package version to reflect the API contract changes.
specs/Data-Gateway.json	Updates the OpenAPI spec for the Cloud Matrix audit detail endpoint, parameters, and schemas/examples.

Comments suppressed due to low confidence (1)

specs/Data-Gateway.json:275

• components.parameters.auditId appears to be unused now that the audit detail endpoint was switched to correlationId (no remaining $ref: #/components/parameters/auditId). Keeping unused component parameters makes the spec harder to maintain and can confuse generated SDKs.

            },
            "auditId": {
                "description": "The unique identifier of the Cloud Matrix audit event.",
                "in": "path",
                "name": "auditId",

---

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

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.