docs: clarify omit is not a security feature

[ymc9]

Adds a warning callout to the omit docs clarifying that the omit feature (at all three layers — schema, client, and query) is not a security feature, but rather a convenient way to control the default set of fields returned during a query. Readers are pointed to access policies for protecting sensitive data.

Also removes the "for security reasons" phrasing from the allowQueryTimeOmitOverride section to stay consistent with this framing.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified that omit settings are not a security feature and should not be used to protect sensitive data.
  • Updated guidance on query-time omit overrides to better explain when always-hidden fields should remain omitted.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
zenstack-new-site	Ready	Preview, Comment	Jul 2, 2026 10:00pm

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 72ea7516-a91c-4b51-885e-f7d2adc68df8

📥 Commits

Reviewing files that changed from the base of the PR and between 1594db2 and 3d24380.

📒 Files selected for processing (1)

• docs/orm/api/omit.md

---

Walkthrough

Documentation update to the omit configuration page adding a warning that omit is not a security mechanism and recommending access policies instead, plus revised wording describing scenarios for disabling query-time omit overrides.

Changes

Omit documentation update

Layer / File(s)	Summary
Security warning and override wording docs/orm/api/omit.md	Adds a warning callout clarifying omit is not a security feature and revises wording on disabling query-time omit overrides via allowQueryTimeOmitOverride.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main documentation change: clarifying that omit is not a security feature.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/omit-not-security

---

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.}