Skip to content

Update audit log access docs#3091

Open
atharva-appwrite wants to merge 1 commit into
mainfrom
update-audit-log-access
Open

Update audit log access docs#3091
atharva-appwrite wants to merge 1 commit into
mainfrom
update-audit-log-access

Conversation

@atharva-appwrite

Copy link
Copy Markdown

Summary

  • remove stale Console Activity-tab guidance and screenshots from audit-log docs
  • update HIPAA log-access guidance and related audit-log blog reference
  • remove stale CLI activity-log command rows for tables, teams, and messaging resources

Verification

  • Verified Remove Activity screens from the console console#3109 is merged and removes Activity routes/screens for account, teams, users, topics, tables, collections, and rows
  • Checked upstream Appwrite API controller sources and existing website reference descriptions before limiting access guidance to the Users API reference
  • Ran git diff --check

Note: The full website check was not run because bun is not installed in this environment.

@appwrite

appwrite Bot commented Jul 9, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Ready Ready View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

Function builds can take up to 45 minutes before timing out

@greptile-apps

greptile-apps Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR removes stale Console Activity-tab guidance, screenshots, and CLI activity-log command rows following the removal of those routes in appwrite/console#3109, replacing them with a pointer to the Users API for user-specific audit data.

  • audit-logs/+page.markdoc: Activity-tab screenshots and Console guidance removed; access section now directs users to the Users API — but the opening paragraph still advertises audit logs across all products (Databases, Storage, Functions, Messaging), leaving no retrieval path documented for those.
  • hipaa/+page.markdoc and the security blog post: Audit log descriptions updated consistently to reflect the Console change.
  • CLI docs (tables, teams, topics): Stale list-*-logs command rows removed cleanly.

Confidence Score: 3/5

The CLI and image cleanup are safe, but the audit-logs doc ships with a misleading intro that needs updating before merge.

The CLI command removals and image deletions are mechanical and clearly correct. The one substantive issue is in audit-logs/+page.markdoc: the intro still tells readers that Databases, Storage, Functions, and Messaging all produce accessible audit logs, while the rewritten access section only exposes the Users API. Anyone following the docs for a non-user resource will hit a dead end with no explanation.

src/routes/docs/advanced/security/audit-logs/+page.markdoc — the opening paragraph needs to be aligned with the narrowed access section.

Important Files Changed

Filename Overview
src/routes/docs/advanced/security/audit-logs/+page.markdoc Removes Activity-tab guidance and screenshots; replaces with Users API reference — but the opening paragraph still claims all products (Databases, Storage, Functions, Messaging) provide accessible audit logs, leaving readers with no retrieval path for non-user logs.
src/routes/docs/advanced/security/hipaa/+page.markdoc Audit log bullet updated to reflect Console Activity tab removal and point to Users API; changes are internally consistent within this file.
src/routes/blog/post/security-is-a-revolving-door/+page.markdoc Blog post paragraph shortened to defer retrieval details to the audit-log docs; factually safe change.
src/routes/docs/tooling/command-line/topics/+page.markdoc Removes stale list-message-logs, list-provider-logs, list-subscriber-logs, and list-topic-logs CLI command rows; straightforward cleanup.
src/routes/docs/tooling/command-line/teams/+page.markdoc Removes stale list-logs CLI command row for teams; straightforward cleanup.
src/routes/docs/tooling/command-line/tables/+page.markdoc Removes stale list-table-logs CLI command row; straightforward cleanup.
static/images/docs/advanced/security/activity.avif Light-mode Activity screenshot deleted; no longer referenced in any doc page after this PR.
static/images/docs/advanced/security/dark/activity.avif Dark-mode Activity screenshot deleted; no longer referenced in any doc page after this PR.

Comments Outside Diff (1)

  1. src/routes/docs/advanced/security/audit-logs/+page.markdoc, line 7-18 (link)

    P1 Intro and access section are now inconsistent

    The opening paragraph (lines 7–11) still states that all products — Authentication, Databases, Storage, Functions, and Messaging — provide audit logs, but the updated access section (lines 15–18) only surfaces the Users API as a retrieval path. A reader looking for database, storage, function, or messaging audit logs now finds no route to that data. If Activity tabs for those products were removed and there is no API replacement, the intro should be tightened to reflect what is actually accessible (e.g., authentication/user events only), or a note should be added explaining that audit log access for other products is unavailable at this time.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: src/routes/docs/advanced/security/audit-logs/+page.markdoc
    Line: 7-18
    
    Comment:
    **Intro and access section are now inconsistent**
    
    The opening paragraph (lines 7–11) still states that *all* products — Authentication, Databases, Storage, Functions, and Messaging — provide audit logs, but the updated access section (lines 15–18) only surfaces the **Users API** as a retrieval path. A reader looking for database, storage, function, or messaging audit logs now finds no route to that data. If Activity tabs for those products were removed and there is no API replacement, the intro should be tightened to reflect what is actually accessible (e.g., authentication/user events only), or a note should be added explaining that audit log access for other products is unavailable at this time.
    
    How can I resolve this? If you propose a fix, please make it concise.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

    Fix in Claude Code Fix in Codex

Fix All in Claude Code Fix All in Codex

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
src/routes/docs/advanced/security/audit-logs/+page.markdoc:7-18
**Intro and access section are now inconsistent**

The opening paragraph (lines 7–11) still states that *all* products — Authentication, Databases, Storage, Functions, and Messaging — provide audit logs, but the updated access section (lines 15–18) only surfaces the **Users API** as a retrieval path. A reader looking for database, storage, function, or messaging audit logs now finds no route to that data. If Activity tabs for those products were removed and there is no API replacement, the intro should be tightened to reflect what is actually accessible (e.g., authentication/user events only), or a note should be added explaining that audit log access for other products is unavailable at this time.

Reviews (1): Last reviewed commit: "Update audit log access docs" | Re-trigger Greptile

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