From 292594ceaa3a1e6887c1f7ba2975063a6663f353 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20Log=C3=A9?= Date: Tue, 29 Apr 2025 00:57:38 +0200 Subject: [PATCH] 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. --- docs/content/getting-started/perform-check.mdx | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/content/getting-started/perform-check.mdx b/docs/content/getting-started/perform-check.mdx index f9c10dbc9c..8d75662e31 100644 --- a/docs/content/getting-started/perform-check.mdx +++ b/docs/content/getting-started/perform-check.mdx @@ -144,11 +144,11 @@ To obtain the [access token](https://auth0.com/docs/get-started/authentication-a ### 02. Calling Check API -To check whether user `user:anne` has relationship `can_view` with object `document:Z` +To check whether user `user:anne` has relationship `reader` with object `document:Z` -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`. + ### 03. Calling Batch Check API