Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitfa5b612

Browse files
authored
fix: ensure fields show up for group resource in docs (#5918)
* fix: ensure fields show up for group resource in docs* ran prettier
1 parent23176bf commitfa5b612

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

‎docs/admin/audit-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We track the following resources:
1111

1212
| <b>Resource<b>||
1313
| -----------------------------------------| -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| Group<br><i>create, write, delete</i>| <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody></tbody></table>|
14+
| Group<br><i>create, write, delete</i>| <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>avatar_url</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>members</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>quota_allowance</td><td>true</td></tr></tbody></table>|
1515
| GitSSHKey<br><i>create</i>| <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>private_key</td><td>true</td></tr><tr><td>public_key</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table>|
1616
| Template<br><i>write, delete</i>| <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>active_version_id</td><td>true</td></tr><tr><td>allow_user_cancel_workspace_jobs</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>default_ttl</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>group_acl</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>is_private</td><td>true</td></tr><tr><td>min_autostart_interval</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>provisioner</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_acl</td><td>true</td></tr></tbody></table>|
1717
| TemplateVersion<br><i>create, write</i>| <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>readme</td><td>true</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table>|

‎enterprise/audit/table.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var AuditActionMap = map[string][]codersdk.AuditAction{
2121
"User": {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},
2222
"Workspace": {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},
2323
"WorkspaceBuild": {codersdk.AuditActionStart,codersdk.AuditActionStop},
24-
"AuditableGroup": {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},
24+
"Group": {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},
2525
}
2626

2727
typeActionstring

‎scripts/auditdocgen/main.go

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,20 +117,21 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([]
117117
buffer.WriteString("|--|-----------------|\n")
118118

119119
for_,resourceName:=rangesortedResourceNames {
120+
readableResourceName:=resourceName
121+
// AuditableGroup is really a combination of Group and GroupMember resources
122+
// but we use the label 'Group' in our docs to avoid confusion.
123+
ifresourceName=="AuditableGroup" {
124+
readableResourceName="Group"
125+
}
126+
120127
// Create a string of audit actions for each resource
121128
varauditActions []string
122-
for_,action:=rangeaudit.AuditActionMap[resourceName] {
129+
for_,action:=rangeaudit.AuditActionMap[readableResourceName] {
123130
auditActions=append(auditActions,string(action))
124131
}
125132
auditActionsString:=strings.Join(auditActions,", ")
126133

127-
// AuditableGroup is really a combination of Group and GroupMember resources
128-
// but we use the label 'Group' in our docs to avoid confusion.
129-
ifresourceName=="AuditableGroup" {
130-
resourceName="Group"
131-
}
132-
133-
buffer.WriteString("|"+resourceName+"<br><i>"+auditActionsString+"</i>|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>")
134+
buffer.WriteString("|"+readableResourceName+"<br><i>"+auditActionsString+"</i>|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>")
134135

135136
// We must sort the field names to ensure sub-table ordering
136137
sortedFieldNames:=sortKeys(auditableResourcesMap[resourceName])

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp