From 7f51416ecf92e98668161de0170627cf0cd33b93 Mon Sep 17 00:00:00 2001
From: Vinyarion <38413862+VinyarionHyarmendacil@users.noreply.github.com>
Date: Mon, 20 Jan 2025 17:30:20 -0600
Subject: [PATCH] Add parameters to /groups/{groupId}/auditLogs (#426)

* Add parameters to /groups/{groupId}/auditLogs

actorIds
eventTypes
targetIds

* fix typo
---
 openapi/components/parameters.yaml            | 24 +++++++++++++++++++
 openapi/components/paths/groups.yaml          |  3 +++
 .../schemas/GroupAuditLogEntry.yaml           |  2 +-
 3 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/openapi/components/parameters.yaml b/openapi/components/parameters.yaml
index 5c4e1587..41536ecd 100644
--- a/openapi/components/parameters.yaml
+++ b/openapi/components/parameters.yaml
@@ -67,6 +67,30 @@ endDate:
     type: string
     format: date-time
   description: The end date of the search range.
+actorIds:
+  name: actorIds
+  in: query
+  required: false
+  schema:
+    type: string
+    example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
+  description: The comma-separated actor ids to search for.
+eventTypes:
+  name: eventTypes
+  in: query
+  required: false
+  schema:
+    type: string
+    example: group.member.remove,group.instance.kick
+  description: The comma-separated event types to search for.
+targetIds:
+  name: targetIds
+  in: query
+  required: false
+  schema:
+    type: string
+    example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
+  description: The comma-separated target ids to search for.
 releaseStatus:
   name: releaseStatus
   in: query
diff --git a/openapi/components/paths/groups.yaml b/openapi/components/paths/groups.yaml
index 575eb933..733b6d2b 100644
--- a/openapi/components/paths/groups.yaml
+++ b/openapi/components/paths/groups.yaml
@@ -175,6 +175,9 @@ paths:
         - $ref: ../parameters.yaml#/offset
         - $ref: ../parameters.yaml#/startDate
         - $ref: ../parameters.yaml#/endDate
+        - $ref: ../parameters.yaml#/actorIds
+        - $ref: ../parameters.yaml#/eventTypes
+        - $ref: ../parameters.yaml#/targetIds
       responses:
         '200':
           $ref: ../responses/groups/GroupAuditLogListResponse.yaml
diff --git a/openapi/components/schemas/GroupAuditLogEntry.yaml b/openapi/components/schemas/GroupAuditLogEntry.yaml
index 026de61e..5b183d7e 100644
--- a/openapi/components/schemas/GroupAuditLogEntry.yaml
+++ b/openapi/components/schemas/GroupAuditLogEntry.yaml
@@ -13,7 +13,7 @@ properties:
   actorDisplayName:
     type: string
   targetId:
-    description: Typically GroupID or GroupRoleID, but could be other types of IDs.
+    description: Typically a UserID, GroupID, GroupRoleID, or Location, but could be other types of IDs.
     type: string
   eventType:
     type: string