[RORDEV-1574] New logged_user audit field

[mgoworko]

Summary by CodeRabbit

• Documentation
  • Audit event examples and required fields updated: the single "user" field is replaced by separate "logged_user" and "presented_identity" fields; the original "user" entry is marked deprecated.
  • Available placeholders updated: {LOGGED_USER} and {PRESENTED_IDENTITY} added, with revised descriptions replacing {USER}.

[coderabbitai]

Walkthrough

Documentation updates in details/audit.md: the single user field in examples and placeholders is split into logged_user and presented_identity, and placeholder references {USER} are replaced by {LOGGED_USER} and {PRESENTED_IDENTITY} with updated descriptions.

Changes

Cohort / File(s)	Summary
Audit Documentation details/audit.md	Replaced the user field in audit event examples with logged_user and presented_identity; added deprecation note for user in required-fields section; replaced {USER} placeholder with {LOGGED_USER} and {PRESENTED_IDENTITY} and updated their descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰
I hopped through logs both near and wide,
One user split — now two beside.
logged_user hums, presented_identity sings,
Together they trace the tiniest things. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "[RORDEV-1574] New logged_user audit field" is directly related to the primary change in the pull request. The changeset modifies the audit documentation to introduce a new "logged_user" field alongside other related updates like adding "presented_identity" and deprecating the existing "user" field. The title specifically calls out the core addition of the logged_user field, which is accurate and aligns with the source branch name. While the title doesn't capture all aspects of the changeset (such as the presented_identity field or the deprecation), it effectively highlights the main point from the developer's perspective and remains clear, concise, and specific enough for a teammate to understand the primary focus of the change.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 040651d and 0baa516.

📒 Files selected for processing (1)

• details/audit.md (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• details/audit.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c3efbd and 040651d.

📒 Files selected for processing (1)

• details/audit.md (2 hunks)

🔇 Additional comments (1)

details/audit.md (1)

33-34: Verify consistency with predefined serializers documentation.

The example audit event now includes the new logged_user and presented_identity fields. However, line 412 in the predefined serializers section still documents the old user field. If this field is being removed or replaced, the predefined serializers documentation should be updated accordingly to avoid confusion.

Please verify one of the following:

1. Should line 412 be updated to reference logged_user instead of user?
2. Should the predefined serializers section document both the old user field and the new logged_user and presented_identity fields for backward compatibility?
3. Is this an intentional change where the two new fields coexist with the old user field?

[coutoPL]

LGTM