Skip to content

fix(docs): use relation 'reader' instead of 'can_view' in perform-check.mdx #1022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxloge wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): use relation 'reader' instead of 'can_view' in perform-check.mdx #1022

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
292594c
fix(docs): use 'reader' relation in perform-check example to match up…
maxloge Apr 28, 2025
95ab428
Merge branch 'main' into fix/docs/reader-relation-mismatch
rhamzeh Apr 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/content/getting-started/perform-check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,12 @@ To check whether user `user:anne` has relationship `reader` with object `documen
]}
/>

The result's `allowed` field will return `true` if the relationship exists and `false` if the relationship does not exist.
The result's `allowed` field will be:
- `true` if the relationship exists.
- `false` if the relation is defined in your model but no matching tuple exists.

If the relation is *not defined* in your model, the API will return a `400 Bad Request` instead of `false`.
Comment on lines +166 to +170
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR title/description indicate that the example relation in this page was changed from can_view to reader, but this diff only updates the explanatory text about the allowed result. If the relation change is already present on the base branch, consider updating the PR title/description to match what’s actually being changed; if not, the intended can_view → reader change appears to be missing from this PR.

Copilot uses AI. Check for mistakes.


### 03. Calling Batch Check API

Expand Down
Loading