You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add documentation for the StreamedListObjects API to the List Objects guide.
Changes:
- Add Streamed List Objects section explaining streaming differences
- Include Node.js and Python SDK examples
- Add note about SDK availability
- Add related link to StreamedListObjects API reference
Related:
- openfga/js-sdk#280
- openfga/sdk-generator#654
- openfga/sdk-generator#76
Copy file name to clipboardExpand all lines: docs/content/getting-started/perform-list-objects.mdx
+50Lines changed: 50 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,6 +182,51 @@ The result `document:otherdoc` and `document:planning` are the document objects
182
182
The performance characteristics of the ListObjects endpoint vary drastically depending on the model complexity, number of tuples, and the relations it needs to evaluate. Relations with 'and' or 'but not' are more expensive to evaluate than relations with 'or'.
183
183
:::
184
184
185
+
## Streamed List Objects
186
+
187
+
The Streamed ListObjects API is similar to the ListObjects API, with two key differences:
188
+
189
+
1.**Streaming Response**: Instead of collecting all objects before returning a response, it streams them to the client as they are collected.
190
+
2.**No Result Limit**: The number of results returned is only limited by the execution timeout specified in the flag `OPENFGA_LIST_OBJECTS_DEADLINE`, not by a fixed limit.
191
+
192
+
:::info Node.js & Python Only
193
+
The streaming functionality is currently available in the **Node.js SDK** and **Python SDK**. Other SDKs return results using the standard ListObjects endpoint.
0 commit comments