Skip to content

Commit 6275cad

Browse files
committed
fix(docs): use 'reader' relation in perform-check example to match update-tuples
The perform-check.mdx example was using relation 'can_view', but the update-tuples page creates relation 'reader'. This brings the two getting-started examples into sync and prevents the ValidationException.
1 parent 0ba732b commit 6275cad

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/content/getting-started/perform-check.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,11 @@ To obtain the [access token](https://auth0.com/docs/get-started/authentication-a
144144

145145
### 02. Calling Check API
146146

147-
To check whether user `user:anne` has relationship `can_view` with object `document:Z`
147+
To check whether user `user:anne` has relationship `reader` with object `document:Z`
148148

149149
<CheckRequestViewer
150150
user={'user:anne'}
151-
relation={'can_view'}
151+
relation={'reader'}
152152
object={'document:Z'}
153153
allowed={true}
154154
skipSetup={true}
@@ -163,7 +163,12 @@ To check whether user `user:anne` has relationship `can_view` with object `docum
163163
]}
164164
/>
165165

166-
The result's `allowed` field will return `true` if the relationship exists and `false` if the relationship does not exist.
166+
The result's `allowed` field will be:
167+
- `true` if the relationship exists.
168+
- `false` if the relation is defined in your model but no matching tuple exists.
169+
170+
If the relation is *not defined* in your model, the API will return a `400 Bad Request` instead of `false`.
171+
167172

168173
### 03. Calling Batch Check API
169174

0 commit comments

Comments
 (0)