chore: update Audit docs to include Audit Actions

Kira-Pilot · Kira-Pilot · commit 2521976f629d · 2023-01-26T23:35:59.000Z
diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go
@@ -4,8 +4,26 @@ import (
 	"reflect"
 
 	"github.com/coder/coder/coderd/database"
+	"github.com/coder/coder/codersdk"
 )
 
+// This mapping creates a relationship between an Auditable Resource
+// and the Audit Actions we track for that resource.
+// It is important to maintain this mapping when adding a new Auditable Resource to the
+// AuditableResources map (below) as our documentation - generated in scripts/auditdocgen/main.go -
+// depends upon it.
+var AuditActionMap = map[string][]string{
+	"GitSSHKey":          {string(codersdk.AuditActionCreate)},
+	"OrganizationMember": {},
+	"Organization":       {},
+	"Template":           {string(codersdk.AuditActionWrite), string(codersdk.AuditActionDelete)},
+	"TemplateVersion":    {string(codersdk.AuditActionCreate), string(codersdk.AuditActionWrite)},
+	"User":               {string(codersdk.AuditActionCreate), string(codersdk.AuditActionWrite), string(codersdk.AuditActionDelete)},
+	"Workspace":          {string(codersdk.AuditActionCreate), string(codersdk.AuditActionWrite), string(codersdk.AuditActionDelete)},
+	"WorkspaceBuild":     {string(codersdk.AuditActionStart), string(codersdk.AuditActionStop)},
+	"AuditableGroup":     {string(codersdk.AuditActionCreate), string(codersdk.AuditActionWrite), string(codersdk.AuditActionDelete)},
+}
+
 type Action string
 
 const (
diff --git a/scripts/auditdocgen/main.go b/scripts/auditdocgen/main.go
@@ -117,7 +117,8 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([]
 	buffer.WriteString("|--|-----------------|\n")
 
 	for _, resourceName := range sortedResourceNames {
-		buffer.WriteString("|" + resourceName + "|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>")
+		auditActionsString := strings.Join(audit.AuditActionMap[resourceName], ", ")
+		buffer.WriteString("|" + resourceName + "<br><i>" + auditActionsString + "|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>")
 
 		// We must sort the field names to ensure sub-table ordering
 		sortedFieldNames := sortKeys(auditableResourcesMap[resourceName])
