Audit Log Typings

openapi/components/schemas/GroupAuditLogEntry.yaml

@@ -1,34 +1,5 @@
 title: GroupAuditLogEntry
-type: object
-properties:
-  actorDisplayName:
-    type: string
-  actorId:
-    $ref: ./UserID.yaml
-  created_at:
-    type: string
-    format: date-time
-  data:
-    type: object
-    description: The data associated with the event. The format of this data is dependent on the event type.
-    examples:
-      - description:
-          new: "My exciting new group. It's pretty nifty!"
-          old: "My exciting new group.  It's pretty nifty!"
-        joinState:
-          new: request
-          old: closed
-  description:
-    type: string
-    description: A human-readable description of the event.
-    examples:
-      - Group role updated
-  eventType:
-    $ref: ./GroupAuditLogEntryType.yaml
-  groupId:
-    $ref: ./GroupID.yaml
-  id:
-    $ref: ./GroupAuditLogID.yaml
-  targetId:
-    type: string
-    description: Typically a UserID, GroupID, GroupRoleID, or Location, but could be other types of IDs.
+description: A group audit log entry. The shape of `data` depends on `eventType`.
+allOf:
+  - $ref: ./GroupAuditLogEntryBase.yaml
+  - $ref: ./GroupAuditLogEntryEvent.yaml

openapi/components/schemas/GroupAuditLogEntryBase.yaml

@@ -0,0 +1,33 @@
+title: GroupAuditLogEntryBase
+type: object
+properties:
+  actorDisplayName:
+    type: string
+    description: The display name of the user who performed the action.
+  actorId:
+    $ref: ./UserID.yaml
+    description: The ID of the user who performed the action.
+  created_at:
+    type: string
+    description: When the action was performed.
+    format: date-time
+  description:
+    type: string
+    description: A human-readable description of the event.
+  eventType:
+    $ref: ./GroupAuditLogEntryType.yaml
+    description: The type of event that occurred.
+  groupId:
+    $ref: ./GroupID.yaml
+    description: The ID of the group the entry belongs to.
+  id:
+    $ref: ./GroupAuditLogID.yaml
+    description: The unique ID of this audit log entry.
+required:
+  - actorDisplayName
+  - actorId
+  - created_at
+  - description
+  - eventType
+  - groupId
+  - id

openapi/components/schemas/GroupAuditLogEntryBooleanChange.yaml

@@ -0,0 +1,11 @@
+title: GroupAuditLogEntryBooleanChange
+type: object
+description: A boolean field's value before and after an update.
+properties:
+  new:
+    type: boolean
+  old:
+    type: boolean
+required:
+  - new
+  - old

openapi/components/schemas/GroupAuditLogEntryDataEmpty.yaml

@@ -0,0 +1,4 @@
+title: GroupAuditLogEntryDataEmpty
+type: object
+additionalProperties: false
+properties: {}

openapi/components/schemas/GroupAuditLogEntryDataGroupAnnouncement.yaml

@@ -0,0 +1,26 @@
+title: GroupAuditLogEntryDataGroupAnnouncement
+type: object
+properties:
+  authorId:
+    $ref: ./UserID.yaml
+    description: The ID of the announcement author.
+  imageId:
+    description: The image file ID attached to the announcement.
+    anyOf:
+      - $ref: ./FileID.yaml
+      - type: "null"
+  sendNotification:
+    type: boolean
+    description: Whether a notification was sent for this announcement.
+  text:
+    type: string
+    description: The text content of the announcement.
+  title:
+    type: string
+    description: The title of the announcement.
+required:
+  - authorId
+  - imageId
+  - sendNotification
+  - text
+  - title

openapi/components/schemas/GroupAuditLogEntryDataGroupCalendarEventCreate.yaml

@@ -0,0 +1,25 @@
+title: GroupAuditLogEntryDataGroupCalendarEventCreate
+type: object
+properties:
+  accessType:
+    $ref: ./CalendarEventAccess.yaml
+  description:
+    type: string
+    description: The description of the calendar event.
+  imageId:
+    description: The image file ID for the event.
+    anyOf:
+      - $ref: ./FileID.yaml
+      - type: "null"
+  title:
+    type: string
+    description: The title of the calendar event.
+  type:
+    type: string
+    description: The type of calendar entry.
+required:
+  - accessType
+  - description
+  - imageId
+  - title
+  - type

openapi/components/schemas/GroupAuditLogEntryDataGroupCalendarEventDelete.yaml

@@ -0,0 +1,125 @@
+title: GroupAuditLogEntryDataGroupCalendarEventDelete
+type: object
+properties:
+  category:
+    type: string
+    description: The category of the event.
+  closeInstanceAfterEndMinutes:
+    type: integer
+    description: Minutes after the event ends to close the instance.
+  createdAt:
+    type: string
+    description: The creation timestamp.
+    format: date-time
+  deletedAt:
+    type:
+      - string
+      - "null"
+    description: The deletion timestamp.
+    format: date-time
+  durationInMs:
+    type: integer
+    description: The duration of the event in milliseconds.
+  endsAt:
+    type: string
+    description: The end timestamp.
+    format: date-time
+  featured:
+    type: boolean
+    description: Whether the event is featured.
+  guestEarlyJoinMinutes:
+    type: integer
+    description: Minutes before the start that guests can join.
+  hostEarlyJoinMinutes:
+    type: integer
+    description: Minutes before the start that hosts can join.
+  interestedUserCount:
+    type: integer
+    description: The number of interested users.
+  isDraft:
+    type: boolean
+    description: Whether the event is a draft.
+  languages:
+    type: array
+    description: The languages for the event.
+    items:
+      type: string
+  occurrenceKind:
+    $ref: ./CalendarEventOccurrenceKind.yaml
+  occurrenceModified:
+    type:
+      - string
+      - "null"
+  ownerId:
+    $ref: ./GroupID.yaml
+    description: The ID of the group that owns the event.
+  platforms:
+    type: array
+    description: The supported platforms.
+    items:
+      type: string
+  recurrence:
+    description: The recurrence rule.
+    anyOf:
+      - $ref: ./CalendarEventRecurrence.yaml
+      - type: "null"
+  roleIds:
+    type:
+      - array
+      - "null"
+    description: Group roles that may join this event.
+    items:
+      $ref: ./GroupRoleID.yaml
+  seriesId:
+    type:
+      - string
+      - "null"
+    description: The ID of the recurring series the event belongs to.
+  shortCode:
+    type:
+      - string
+      - "null"
+    description: The short code.
+  startsAt:
+    type: string
+    description: The start timestamp.
+    format: date-time
+  tags:
+    type: array
+    description: The event tags.
+    items:
+      type: string
+  updatedAt:
+    type: string
+    description: The last update timestamp.
+    format: date-time
+  usesInstanceOverflow:
+    type: boolean
+    description: Whether the event uses instance overflow.
+required:
+  - category
+  - closeInstanceAfterEndMinutes
+  - createdAt
+  - deletedAt
+  - durationInMs
+  - endsAt
+  - featured
+  - guestEarlyJoinMinutes
+  - hostEarlyJoinMinutes
+  - interestedUserCount
+  - isDraft
+  - languages
+  - occurrenceKind
+  - occurrenceModified
+  - ownerId
+  - platforms
+  - recurrence
+  - roleIds
+  - seriesId
+  - shortCode
+  - startsAt
+  - tags
+  - updatedAt
+  - usesInstanceOverflow
+allOf:
+  - $ref: ./GroupAuditLogEntryDataGroupCalendarEventCreate.yaml

openapi/components/schemas/GroupAuditLogEntryDataGroupGalleryCreate.yaml

@@ -0,0 +1,48 @@
+title: GroupAuditLogEntryDataGroupGalleryCreate
+type: object
+properties:
+  description:
+    type: string
+    description: The gallery description.
+  membersOnly:
+    type: boolean
+    description: Whether the gallery is members only.
+  name:
+    type: string
+    description: The gallery name.
+  roleIdsToAutoApprove:
+    type:
+      - array
+      - "null"
+    description: The role IDs whose submissions are approved automatically.
+    items:
+      $ref: ./GroupRoleID.yaml
+  roleIdsToManage:
+    type:
+      - array
+      - "null"
+    description: The role IDs that can manage the gallery.
+    items:
+      $ref: ./GroupRoleID.yaml
+  roleIdsToSubmit:
+    type:
+      - array
+      - "null"
+    description: The role IDs that can submit to the gallery.
+    items:
+      $ref: ./GroupRoleID.yaml
+  roleIdsToView:
+    type:
+      - array
+      - "null"
+    description: The role IDs that can view the gallery.
+    items:
+      $ref: ./GroupRoleID.yaml
+required:
+  - description
+  - membersOnly
+  - name
+  - roleIdsToAutoApprove
+  - roleIdsToManage
+  - roleIdsToSubmit
+  - roleIdsToView

openapi/components/schemas/GroupAuditLogEntryDataGroupGalleryDelete.yaml

@@ -0,0 +1,16 @@
+title: GroupAuditLogEntryDataGroupGalleryDelete
+type: object
+properties:
+  createdAt:
+    type: string
+    description: The creation timestamp of the gallery.
+    format: date-time
+  updatedAt:
+    type: string
+    description: The last update timestamp of the gallery.
+    format: date-time
+required:
+  - createdAt
+  - updatedAt
+allOf:
+  - $ref: ./GroupAuditLogEntryDataGroupGalleryCreate.yaml

openapi/components/schemas/GroupAuditLogEntryDataGroupGalleryUpdate.yaml

@@ -0,0 +1,8 @@
+title: GroupAuditLogEntryDataGroupGalleryUpdate
+type: object
+description: Carries only the fields the update changed.
+properties:
+  membersOnly:
+    $ref: ./GroupAuditLogEntryBooleanChange.yaml
+  name:
+    $ref: ./GroupAuditLogEntryStringChange.yaml

openapi/components/schemas/GroupAuditLogEntryDataGroupInstanceAnnouncement.yaml

@@ -0,0 +1,12 @@
+title: GroupAuditLogEntryDataGroupInstanceAnnouncement
+type: object
+properties:
+  message:
+    type: string
+    description: The announcement message.
+  title:
+    type: string
+    description: The announcement title.
+required:
+  - message
+  - title

openapi/components/schemas/GroupAuditLogEntryDataGroupInstanceClose.yaml

@@ -0,0 +1,15 @@
+title: GroupAuditLogEntryDataGroupInstanceClose
+type: object
+properties:
+  groupAccessType:
+    $ref: ./GroupAccessType.yaml
+  roleIds:
+    type:
+      - array
+      - "null"
+    description: The role IDs that have access to the instance.
+    items:
+      $ref: ./GroupRoleID.yaml
+required:
+  - groupAccessType
+  - roleIds

openapi/components/schemas/GroupAuditLogEntryDataGroupInstanceCreate.yaml

@@ -0,0 +1,17 @@
+title: GroupAuditLogEntryDataGroupInstanceCreate
+type: object
+properties:
+  calendarEntryId:
+    description: The calendar entry ID if the instance was created from a calendar event.
+    anyOf:
+      - $ref: ./CalendarID.yaml
+      - type: "null"
+  groupAccessType:
+    $ref: ./GroupAccessType.yaml
+  roleIds:
+    $ref: ./GroupRoleIDList.yaml
+    description: The role IDs that have access to the instance.
+required:
+  - calendarEntryId
+  - groupAccessType
+  - roleIds

openapi/components/schemas/GroupAuditLogEntryDataGroupInstanceModeration.yaml

@@ -0,0 +1,8 @@
+title: GroupAuditLogEntryDataGroupInstanceModeration
+type: object
+properties:
+  location:
+    $ref: ./LocationID.yaml
+    description: The instance the target was kicked from or warned in.
+required:
+  - location