From fa5b6125a92fdce14f2445fdfcc35ab36849741d Mon Sep 17 00:00:00 2001 From: Kira Pilot Date: Mon, 30 Jan 2023 10:54:58 -0500 Subject: [PATCH] fix: ensure fields show up for group resource in docs (#5918) * fix: ensure fields show up for group resource in docs * ran prettier --- docs/admin/audit-logs.md | 2 +- enterprise/audit/table.go | 2 +- scripts/auditdocgen/main.go | 17 +++++++++-------- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md index 86507f44fc..192dacc2c8 100644 --- a/docs/admin/audit-logs.md +++ b/docs/admin/audit-logs.md @@ -11,7 +11,7 @@ We track the following resources: | Resource | | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Group
create, write, delete |
FieldTracked
| +| Group
create, write, delete |
FieldTracked
avatar_urltrue
idtrue
memberstrue
nametrue
organization_idfalse
quota_allowancetrue
| | GitSSHKey
create |
FieldTracked
created_atfalse
private_keytrue
public_keytrue
updated_atfalse
user_idtrue
| | Template
write, delete |
FieldTracked
active_version_idtrue
allow_user_cancel_workspace_jobstrue
created_atfalse
created_bytrue
default_ttltrue
deletedfalse
descriptiontrue
display_nametrue
group_acltrue
icontrue
idtrue
is_privatetrue
min_autostart_intervaltrue
nametrue
organization_idfalse
provisionertrue
updated_atfalse
user_acltrue
| | TemplateVersion
create, write |
FieldTracked
created_atfalse
created_bytrue
idtrue
job_idfalse
nametrue
organization_idfalse
readmetrue
template_idtrue
updated_atfalse
| diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go index be58f91410..6e4bcfebba 100644 --- a/enterprise/audit/table.go +++ b/enterprise/audit/table.go @@ -21,7 +21,7 @@ var AuditActionMap = map[string][]codersdk.AuditAction{ "User": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete}, "Workspace": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete}, "WorkspaceBuild": {codersdk.AuditActionStart, codersdk.AuditActionStop}, - "AuditableGroup": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete}, + "Group": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete}, } type Action string diff --git a/scripts/auditdocgen/main.go b/scripts/auditdocgen/main.go index 6217d4f2d3..c51f0de695 100644 --- a/scripts/auditdocgen/main.go +++ b/scripts/auditdocgen/main.go @@ -117,20 +117,21 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([] buffer.WriteString("|--|-----------------|\n") for _, resourceName := range sortedResourceNames { + readableResourceName := resourceName + // AuditableGroup is really a combination of Group and GroupMember resources + // but we use the label 'Group' in our docs to avoid confusion. + if resourceName == "AuditableGroup" { + readableResourceName = "Group" + } + // Create a string of audit actions for each resource var auditActions []string - for _, action := range audit.AuditActionMap[resourceName] { + for _, action := range audit.AuditActionMap[readableResourceName] { auditActions = append(auditActions, string(action)) } auditActionsString := strings.Join(auditActions, ", ") - // AuditableGroup is really a combination of Group and GroupMember resources - // but we use the label 'Group' in our docs to avoid confusion. - if resourceName == "AuditableGroup" { - resourceName = "Group" - } - - buffer.WriteString("|" + resourceName + "
" + auditActionsString + "|") + buffer.WriteString("|" + readableResourceName + "
" + auditActionsString + "|
FieldTracked
") // We must sort the field names to ensure sub-table ordering sortedFieldNames := sortKeys(auditableResourcesMap[resourceName])
FieldTracked