Skip to content
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.

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

Add parameters to /groups/{groupId}/auditLogs #426

Merged
merged 2 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
Loading