docs: update Read API description (#133)

openfga · Feb 5, 2024 · a8c57d3 · a8c57d3
1 parent 05de9d8
commit a8c57d3
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -26,7 +26,8 @@ service OpenFGAService {
       operation_id: "Read"
       description:
         "The Read API will return the tuples for a certain store that match a "
-        "query filter specified in the body of the request. "
+        "query filter specified in the body of the request. \n"
+        "The API doesn't guarantee order by any field. \n"
         "It is different from the `/stores/{store_id}/expand` API in that it only "
         "returns relationship tuples that are stored in the system and satisfy the query. \n"
         "In the body:\n"

diff --git a/proto/openfga/v1/openfga_service.pb.go b/proto/openfga/v1/openfga_service.pb.go