chore: add test to cover not sending empty array when other has data (…

…#75) * docs: update read doc string * fix: fix example makefile to run openfga Co-authored-by: Jim Anderson <[email protected]> * chore: add test to cover not sending empty array when other has data --------- Co-authored-by: Jim Anderson <[email protected]>
openfga · Feb 12, 2024 · f7429ac · f7429ac
1 parent 60fc2a1
commit f7429ac
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/api_open_fga.go b/api_open_fga.go
@@ -221,7 +221,9 @@ type OpenFgaApi interface {
 
 	/*
 		 * Read Get tuples from the store that matches a query, without following userset rewrite rules
-		 * The Read API will return the tuples for a certain store that match a query filter specified in the body of the request. 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.
+		 * The Read API will return the tuples for a certain store that match a query filter specified in the body of the request.
+	The API doesn't guarantee order by any field.
+	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.
 	In the body:
 	1. `tuple_key` is optional. If not specified, it will return all tuples in the store.
 	2. `tuple_key.object` is mandatory if `tuple_key` is specified. It can be a full object (e.g., `type:object_id`) or type only (e.g., `type:`).
@@ -2544,8 +2546,10 @@ func (r ApiReadRequest) Execute() (ReadResponse, *_nethttp.Response, error) {
 
 /*
   - Read Get tuples from the store that matches a query, without following userset rewrite rules
-  - The Read API will return the tuples for a certain store that match a query filter specified in the body of the request. 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.
+  - The Read API will return the tuples for a certain store that match a query filter specified in the body of the request.
 
+The API doesn't guarantee order by any field.
+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.
 In the body:
 1. `tuple_key` is optional. If not specified, it will return all tuples in the store.
 2. `tuple_key.object` is mandatory if `tuple_key` is specified. It can be a full object (e.g., `type:object_id`) or type only (e.g., `type:`).

diff --git a/client/client_test.go b/client/client_test.go
@@ -972,6 +972,7 @@ func TestOpenFgaClient(t *testing.T) {
 				Relation: "viewer",
 				Object:   "document:roadmap",
 			}},
+			Deletes: []ClientTupleKeyWithoutCondition{},
 		}
 		options := ClientWriteOptions{
 			AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),

diff --git a/example/Makefile b/example/Makefile
@@ -11,4 +11,4 @@ run: restore
 
 run-openfga:
 	docker pull docker.io/openfga/openfga:${openfga_version} && \
-		docker run -p 8080:8080 docker.io/openfga/openfga:${openfga_version}
+		docker run -p 8080:8080 docker.io/openfga/openfga:${openfga_version} run