Skip to content

Commit

Permalink
Add parameters to /groups/{groupId}/auditLogs (#426)
Browse files Browse the repository at this point in the history
* Add parameters to /groups/{groupId}/auditLogs

actorIds
eventTypes
targetIds

* fix typo
  • Loading branch information
VinyarionHyarmendacil authored Jan 20, 2025
1 parent e2b4d28 commit 7f51416
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
24 changes: 24 additions & 0 deletions openapi/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions openapi/components/paths/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/GroupAuditLogEntry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7f51416

Please sign in to comment.