Skip to content

Commit b7fb31c

Browse files
authored
fix(docs): remove batchcheck endpoint support to js/python sdk note (#1035)
1 parent e1e5f97 commit b7fb31c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/content/interacting/relationship-queries.mdx

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,24 @@ For example, you can call Batch Check to determine whether `bob` has `can_view_n
181181

182182
The <ProductName format={ProductNameFormat.ShortForm}/> API will return `true` depending on the level of access assigned to that user and the implied relationships inherited in the authorization model.
183183

184-
185184
### Caveats and when not to use it
186185

187186
If you are making less than 10 checks, it may be faster to call the [Check API](/api/service#Relationship%20Queries/Check) in parallel instead of Batch Check.
188187

189-
The new BatchCheck endpoint is currently supported by the JS SDK (>=[v0.8.0](https://github.com/openfga/js-sdk/releases/tag/v0.8.0) and the Python SDK (>=[v0.9.0](https://github.com/openfga/python-sdk/releases/tag/v0.9.0)). Support in the other SDKs is being worked on.
188+
:::note
189+
The BatchCheck endpoint is currently supported by the following SDKs:
190+
- Go SDK ([>=0.7.0](https://github.com/openfga/go-sdk/releases/tag/v0.7.0))
191+
- JavaScript SDK ([>=v0.8.0](https://github.com/openfga/js-sdk/releases/tag/v0.8.0))
192+
- Python SDK ([>=v0.9.0](https://github.com/openfga/python-sdk/releases/tag/v0.9.0))
193+
- Java SDK ([>=0.8.1](https://github.com/openfga/java-sdk/releases/tag/v0.8.1))
194+
- Support for .NET is in progress and coming soon.
195+
196+
In SDKs that support the `BatchCheck` endpoint (server-side batch checks), the previous `BatchCheck` method has been renamed to `ClientBatchCheck`. `ClientBatchCheck` performs client-side batch checks by making multiple check requests with limited parallelization.
197+
198+
The .NET SDK does not yet support the `BatchCheck` endpoint (coming soon). Until then, the `BatchCheck` method maintains its current behavior, performing client-side batch checks equivalent to `ClientBatchCheck` in other SDKs.
199+
200+
Refer to the README for each SDK for more information. Refer to the release notes of the relevant SDK version for more information on how to migrate from client-side to the server-side `BatchCheck`.
201+
:::
190202

191203
## Read
192204

0 commit comments

Comments
 (0)