From d342904b6cd4811b9ebe0a63d259150c7f79af2d Mon Sep 17 00:00:00 2001 From: Kenan Yildirim Date: Mon, 5 Feb 2024 14:35:40 -0500 Subject: [PATCH] pangea-node-sdk: correct `Audit.log()` param name (GEA-12282) The param is named `event`, not `content`. Also remove types from this TSDoc as that is already derived from the TS. --- packages/pangea-node-sdk/src/services/audit.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/pangea-node-sdk/src/services/audit.ts b/packages/pangea-node-sdk/src/services/audit.ts index 796400b0c..bce9ec779 100644 --- a/packages/pangea-node-sdk/src/services/audit.ts +++ b/packages/pangea-node-sdk/src/services/audit.ts @@ -39,7 +39,7 @@ class AuditService extends BaseService { * @summary Log an entry * @description Create a log entry in the Secure Audit Log. * @operationId audit_post_v1_log - * @param {Object} content - A structured event describing an auditable activity. Supported fields are: + * @param event A structured event describing an auditable activity. Supported fields are: * - actor (string): Record who performed the auditable activity. * - action (string): The auditable action that occurred. * - status (string): Record whether or not the activity was successful. @@ -50,9 +50,9 @@ class AuditService extends BaseService { * - new (string|object): The value of a record after it was changed. * - old (string|object): The value of a record before it was changed. * - tenant_id (string): Used to record the tenant associated with this activity. - * @param {Object} options - Log options. The following log options are supported: + * @param options Log options. The following log options are supported: * - verbose (bool): Return a verbose response, including the canonical event hash and received_at time. - * @returns {Promise} - A promise representing an async call to the /v1/log endpoint. + * @returns A promise representing an async call to the /v1/log endpoint. * @example * ```js * const auditData = {