docs/src/audit-logs/types.ts at 1f0d51bb8a0039825d5913c4012a1a3fa515cce9 · github/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
export type CategorizedEvents = Record<string, AuditLogEventT[]>

export type CategoryNotes = Record<string, string>

export type AuditLogEventT = {
  action: string
  description: string
  fields?: string[]
  docs_reference_links?: string
  docs_reference_titles?: string
}

export type RawAuditLogEventT = {
  _allowlists: string[]
  action: string
  description: string
  docs_reference_links: string
  docs_reference_titles?: string
  fields?: string[]
  ghes: Record<string, { _allowlists: string[]; fields?: string[] }>
}

export type VersionedAuditLogData = Record<string, Record<string, AuditLogEventT[]>>

export type AuditLogConfig = {
  sha: string
  appendedDescriptions: Record<string, string>
  categoryNotes?: CategoryNotes
}