Merge branch 'main' into feat/add-forbidden-response

.githooks/pre-commit

@@ -0,0 +1,29 @@
+#!/bin/sh
+# This is a simple check to ensure people remember to regenerate the docs
+# and the pb.go files if they change a .proto file.
+# It's not iron-clad but it's better than finding out later in github.
+
+# AMD = added, modified, deleted
+files=$(git diff --cached --name-only --diff-filter=AMD)
+
+LIGHT_RED='\033[1;31m'
+RESET='\033[0m' # No Color
+
+# naive regex check for .proto extension
+if [[ "$files" =~ \.proto ]]
+then
+    # Check if there's a staged diff in /docs and in the generated pb.go files
+    docs_change=$(git diff --cached --raw docs/)
+    go_change=$(git diff --cached --raw proto/openfga/)
+    if [ -n "$docs_change" ] && [ -n "$go_change" ]; then
+      # Both were changed, we're good
+      exit 0
+    else
+      # One of the two directories does not have changes, block this commit
+      echo "This commit contains .proto changes but either the docs or generated /proto files are not part of this commit."
+      echo "${LIGHT_RED}Your changes were not committed, please run 'make all' and add the resulting changes${RESET}\n"
+      exit 1
+    fi
+fi
+
+exit 0

Makefile

@@ -1,10 +1,13 @@
 all: patch-swagger-doc format
 
-buf-gen:
+buf-gen: init-git-hooks
 	./buf.gen.yaml
 
 patch-swagger-doc: buf-gen
 	./scripts/update_swagger.sh docs/openapiv2/apidocs.swagger.json
 
 format: buf-gen
 	buf format -w
+
+init-git-hooks:
+	git config --local core.hooksPath .githooks/

README.md

@@ -10,10 +10,12 @@ To generate source code from the protobuf definitions contained in this project
 > **Note**: You must have [Buf CLI](https://docs.buf.build/installation) installed to run the following command.
 > 
 ```bash
-./buf.gen.yaml
+make buf-gen
 ```
 
-The command above will generate source code in the `proto/` directory.
+The command above will generate source code in the `proto/` directory. It will also configure a local git hook to check
+that files requiring auto-generation after `.proto` changes have been updated. There are some cases where that git hook
+may be overly strict. In those cases you can bypass it with `commit --no-verify`.
 
 ## Use the generated sources in OpenFGA
 
@@ -31,6 +33,8 @@ The command above will generate source code in the `proto/` directory.
 ## Generating OpenAPI Documentation
 To generate the OpenAPI documentation from the protobuf sources you can run the following commands:
 
+> **Note**: You must have [jq](https://jqlang.github.io/jq/download/) installed to run the `format` step below
+
 ```bash
 ./buf.gen.yaml
 ./scripts/update_swagger.sh docs/openapiv2/apidocs.swagger.json
@@ -40,4 +44,4 @@ buf format -w
 Or you can just use
 ```bash
 make
-```
+```

openfga/v1/openfga_service.proto

@@ -777,7 +777,7 @@ service OpenFGAService {
         "You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly.\n"
         "The response will contain the related users in an array in the \"users\" field of the response. These results may include specific objects, usersets \n"
         "or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string."
-        "In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects\n"
+        "In cases where a type-bound public access result is returned (e.g. `user:*`), it cannot be inferred that all subjects\n"
         "of that type have a relation to the object; it is possible that negations exist and checks should still be queried\n"
         "on individual subjects to ensure access to that document."
         "The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE "
@@ -993,7 +993,11 @@ message ReadRequest {
       gte: 1
       lte: 100
     },
-    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "50"}
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      example: "50"
+      minimum: 1
+      maximum: 100
+    }
   ];
 
   string continuation_token = 4 [