chore: update deps and some docs (#156)

openfga · May 1, 2024 · 2b164f5 · 2b164f5
1 parent 3605041
commit 2b164f5
Show file tree

Hide file tree

Showing 13 changed files with 1,644 additions and 1,386 deletions.
diff --git a/buf.gen.yaml b/buf.gen.yaml
@@ -10,24 +10,24 @@ managed:
       - buf.build/envoyproxy/protoc-gen-validate
       - buf.build/grpc-ecosystem/grpc-gateway
 plugins:
-  - plugin: buf.build/protocolbuffers/go:v1.28.1
+  - plugin: buf.build/protocolbuffers/go:v1.34.0
     out: proto/
     opt:
       - paths=source_relative
   - plugin: buf.build/grpc/go:v1.3.0
     out: proto/
     opt:
       - paths=source_relative
-  - plugin: buf.build/bufbuild/validate-go:v0.10.1
+  - plugin: buf.build/bufbuild/validate-go:v1.0.4
     out: proto/
     opt:
       - paths=source_relative
-  - plugin: buf.build/grpc-ecosystem/gateway:v2.15.0
+  - plugin: buf.build/grpc-ecosystem/gateway:v2.19.1
     out: proto/
     opt:
       - paths=source_relative
       - logtostderr=true
-  - plugin: buf.build/grpc-ecosystem/openapiv2:v2.15.0
+  - plugin: buf.build/grpc-ecosystem/openapiv2:v2.16.0
     out: docs/openapiv2
     opt:
       - openapi_naming_strategy=simple

diff --git a/buf.lock b/buf.lock
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/openfga/v1/errors_ignore.proto b/openfga/v1/errors_ignore.proto
@@ -110,6 +110,12 @@ message ValidationErrorMessageResponse {
   string message = 2;
 }
 
+message UnauthenticatedResponse {
+  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {example: "{\"code\":\"unauthenticated\", \"message\":\"unauthenticated\"}"};
+  ErrorCode code = 1;
+  string message = 2;
+}
+
 message UnprocessableContentMessageResponse {
   option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {example: "{\"code\":\"throttled_timeout_error\", \"message\":\"timeout due to throttling on complex request\"}"};
   UnprocessableContentErrorCode code = 1;

diff --git a/openfga/v1/openapi.proto b/openfga/v1/openapi.proto
@@ -8,7 +8,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "OpenFGA";
     description: "A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.";
-    version: "0.1";
+    version: "1.x";
     contact: {
       name: "OpenFGA";
       email: "[email protected]";
@@ -31,6 +31,15 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
       }
     }
   }
+  responses: {
+    key: "401"
+    value: {
+      description: "Not authenticated."
+      schema: {
+        json_schema: {ref: ".openfga.v1.UnauthenticatedResponse"}
+      }
+    }
+  }
   responses: {
     key: "404"
     value: {

diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -265,8 +265,8 @@ service OpenFGAService {
         "}\n"
         "```\n"
         "will always return `{ \"allowed\": true }`. This is because usersets are self-defining: the userset `document:2021-budget#reader` will always have the `reader` relation with `document:2021-budget`.\n"
-        "### Querying usersets with exclusion in the model\n"
-        "A Check for a userset can yield results that must be treated carefully if the model involves exclusion. For example, for the following authorization model\n"
+        "### Querying usersets with difference in the model\n"
+        "A Check for a userset can yield results that must be treated carefully if the model involves difference. For example, for the following authorization model\n"
         "```python\n"
         "model\n"
         "  schema 1.1\n"
@@ -708,7 +708,7 @@ service OpenFGAService {
     };
 
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      summary: "[EXPERIMENTAL] Stream all objects of the given type that the user has a relation with"
+      summary: "Stream all objects of the given type that the user has a relation with"
       tags: ["Relationship Queries"]
       operation_id: "StreamedListObjects"
       description:
@@ -751,7 +751,7 @@ service OpenFGAService {
     };
 
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      summary: "List the users matching the provided filter who have a certain relation to a particular type."
+      summary: "[EXPERIMENTAL] List the users matching the provided filter who have a certain relation to a particular type."
       tags: ["Relationship Queries"]
       operation_id: "ListUsers"
       description:

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