Skip to content

docs: document the Audit logs page and export via API [OD-767] - #2814

Draft
claudiacodacy wants to merge 3 commits into
masterfrom
docs-audit-logs-page-user-facing-documentation-od-767
Draft

claudiacodacy wants to merge 3 commits into
masterfrom
docs-audit-logs-page-user-facing-documentation-od-767

Conversation

@claudiacodacy

@claudiacodacy claudiacodacy commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Updates Audit logs for organizations for the new Audit logs page in organization settings (OD-767). The page URL and the #audit-log-events anchor are unchanged, since the SPA links to both.

  • Viewing audit logs: where the page is, one day at a time with a date picker, search within the selected day, the table columns, the empty-day message, and the upgrade prompt for organizations without access.
  • Exporting with the Codacy API: the Export via API modal, plus a hand-built curl request against listAuditLogsForOrganization (from/to in epoch ms, from apiv3.yaml).
  • Access: Admin-only, matching the roles page after OD-757 (fix: Change audit logs permission for org manager (OD-757) #2769). The old text still said organization managers.
  • Retention: one year, counted from when audit logs were enabled for the organization.
  • Event table: 7 action names corrected and 5 rows added to match what codacy-website @5d1425b records (AuditRequestMatcher.scala). For example, organizations.settings.hooks.create is now organizations.hooks.create, and the manager actions are security.managers.create / security.manager.delete.

Structure follows the Webhooks page (upgrade prompt wording, See also).

Important

Don't merge before the feature flag rollout. The table and date picker shipped in codacy-spa #3209. Search (OD-772), the Export via API modal (OD-765) and the upsell (OD-774) are documented from their specs and aren't merged yet. Recheck their labels before merging.

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

mkdocs build --strict passes locally. Vale reports only two existing "Unignore" rows that this PR doesn't touch.

🤖 Generated with Claude Code

Add how to view, search and export audit logs, make access Admin-only,
list what isn't logged, and correct the event action names against
codacy-website @5d1425b (AuditRequestMatcher.scala).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Overall readability score: 54.43 (🟢 +0.04)

File Readability
audit-logs-for-organizations.md 74.81 (🟢 +11.98)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
audit-logs-for-organizations.md 74.81 37.37 6 8.3 10.87 6.34
  🟢 +11.98 🟢 +15.3 🟢 +0.73 🟢 +1.6 🟢 +2.48 🟢 +0.74

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.43 42.93 10.82 12.3 12.32 7.95
  🟢 +0.04 🟢 +0.05 🟢 +0 🟢 +0.01 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@github-actions
github-actions Bot temporarily deployed to Netlify November 3, 2026 15:30 Inactive
Toggling one pattern calls configureTool / updateCodingStandardToolConfiguration,
which the audit matcher records as repositories.tools.update and
organizations.codingstandards.tools.update (codacy-website @5d1425b).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify November 3, 2026 15:35 Inactive
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify November 3, 2026 16:28 Inactive

This branch was previously deployed

1 inactive deployment
Netlify — 0566c519 Deployed Nov 3, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant