feat: unified APIs with REST, gRPC and Connect RPC

.schema/openapi/patches/checkServices.yaml

@@ -0,0 +1,22 @@
+- op: add
+  path: /paths/~1relation-tuples~1check/get/operationId
+  value: checkPermissionOrError
+- op: add
+  path: /paths/~1relation-tuples~1check/post/operationId
+  value: postCheckPermissionOrError
+- op: add
+  path: /paths/~1relation-tuples~1check~1openapi/get/operationId
+  value: checkPermission
+- op: add
+  path: /paths/~1relation-tuples~1check~1openapi/post/operationId
+  value: postCheckPermission
+
+# Remove schema from empty response.
+- op: replace
+  path: /paths/~1admin~1relation-tuples/delete/responses/204
+  value:
+    description: An empty response.
+- op: replace
+  path: /paths/~1admin~1relation-tuples/patch/responses/204
+  value:
+    description: An empty response.

.schema/openapi/patches/health.yaml

@@ -1,4 +1,4 @@
-- op: replace
+- op: add
   path: /paths/~1health~1alive
   value:
     get:
@@ -17,17 +17,22 @@
           content:
             application/json:
               schema:
-                "$ref": "#/components/schemas/healthStatus"
+                required:
+                  - status
+                type: object
+                properties:
+                  status:
+                    type: string
           description: {{.ProjectHumanName}} is ready to accept connections.
         '500':
           content:
             application/json:
               schema:
-                "$ref": "#/components/schemas/genericError"
+                "$ref": "#/definitions/errorGeneric"
           description: genericError
       summary: Check HTTP Server Status
       tags: {{ .HealthPathTags | toJson }}
-- op: replace
+- op: add
   path: /paths/~1health~1ready
   value:
     get:
@@ -46,6 +51,8 @@
           content:
             application/json:
               schema:
+                required:
+                  - status
                 type: object
                 properties:
                   status:
@@ -56,6 +63,8 @@
           content:
             application/json:
               schema:
+                required:
+                  - errors
                 properties:
                   errors:
                     additionalProperties:
@@ -85,6 +94,8 @@
             application/json:
               schema:
                 type: object
+                required:
+                  - version
                 properties:
                   version:
                     description: The version of {{.ProjectHumanName}}.

.schema/openapi/patches/meta.yaml

@@ -1,4 +1,4 @@
-- op: replace
+- op: add
   path: /info
   value:
     title: Ory Keto API

.schema/openapi/patches/replacements.sed

@@ -0,0 +1,11 @@
+s/ory.keto.relation_tuples.v1alpha2.ErrorResponse/errorGeneric/g
+s/ory.keto.relation_tuples.v1alpha2.ErrorResponse.Error/genericError/g
+s/ory.keto.relation_tuples.v1alpha2.CreateRelationTupleRequest.Relationship/createRelationshipBody/g
+s/ory.keto.relation_tuples.v1alpha2.SubjectSet/subjectSet/g
+s/ory.keto.relation_tuples.v1alpha2.SubjectTree/expandedPermissionTree/g
+s/ory.keto.relation_tuples.v1alpha2.RelationTuple/relationship/g
+s/ory.keto.relation_tuples.v1alpha2.ListRelationTuplesResponse/relationships/g
+s/ory.keto.relation_tuples.v1alpha2.ListNamespacesResponse/relationshipNamespaces/g
+s/ory.keto.relation_tuples.v1alpha2.CheckRequest/postCheckPermissionBody/g
+s/ory.keto.relation_tuples.v1alpha2.CheckResponse/checkPermissionResult/g
+s/ory.keto.opl.v1alpha1.CheckResponse/checkOplSyntaxResult/g

Makefile

@@ -7,8 +7,8 @@ export IMAGE_TAG	:= $(if $(IMAGE_TAG),$(IMAGE_TAG),latest)
 GO_DEPENDENCIES = golang.org/x/tools/cmd/goimports \
 				  github.com/mattn/goveralls \
 				  github.com/ory/go-acc \
-				  github.com/bufbuild/buf/cmd/buf \
 				  github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc \
+				  github.com/bufbuild/buf/cmd/buf \
 				  github.com/josephburnett/jd \
 				  github.com/mikefarah/yq/v4 \
 				  golang.org/x/tools/cmd/stringer \
@@ -46,10 +46,11 @@ authors:  # updates the AUTHORS file
 	curl https://raw.githubusercontent.com/ory/ci/master/authors/authors.sh | env PRODUCT="Ory Keto" bash
 
 .PHONY: format
-format: .bin/ory .bin/goimports node_modules
+format: .bin/buf .bin/ory .bin/goimports node_modules
 	.bin/ory dev headers copyright --type=open-source --exclude=.bin --exclude=internal/httpclient --exclude=proto
 	.bin/goimports -w -local github.com/ory/keto *.go internal cmd contrib ketoctx ketoapi embedx
 	npm exec -- prettier --write .
+	buf format -w
 
 .PHONY: install
 install:
@@ -61,21 +62,18 @@ docker:
 
 # Generates the SDKs
 .PHONY: sdk
-sdk: .bin/swagger .bin/ory node_modules
+sdk: buf .bin/swagger .bin/ory node_modules
 	rm -rf internal/httpclient
-	swagger generate spec -m -o spec/swagger.json \
-		-c github.com/ory/keto \
-		-c github.com/ory/x/healthx \
-		-x internal/httpclient \
-		-x internal/e2e
-	.bin/ory dev swagger sanitize ./spec/swagger.json
-	swagger validate ./spec/swagger.json
+	.bin/ory dev swagger sanitize ./spec/api.swagger.json
+	sed -i -f ./.schema/openapi/patches/replacements.sed ./spec/api.swagger.json
+	swagger validate ./spec/api.swagger.json
 	CIRCLE_PROJECT_USERNAME=ory CIRCLE_PROJECT_REPONAME=keto \
 		.bin/ory dev openapi migrate \
 			--health-path-tags metadata \
-			-p https://raw.githubusercontent.com/ory/x/master/healthx/openapi/patch.yaml \
+			-p file://.schema/openapi/patches/health.yaml \
 			-p file://.schema/openapi/patches/meta.yaml \
-			spec/swagger.json spec/api.json
+			-p file://.schema/openapi/patches/checkServices.yaml \
+			spec/api.swagger.json spec/api.json
 
 	mkdir -p internal/httpclient
 
@@ -103,6 +101,7 @@ build:
 #
 .PHONY: buf-gen
 buf-gen: .bin/buf .bin/protoc-gen-doc node_modules
+	buf format -w
 	buf generate proto
 	make format
 	@echo "All code was generated successfully!"

buf.gen.yaml

@@ -9,6 +9,10 @@ plugins:
     out: proto
     opt: paths=source_relative,require_unimplemented_servers=false
 
+  - plugin: buf.build/bufbuild/validate-go
+    out: proto
+    opt: paths=source_relative
+
   - plugin: buf.build/protocolbuffers/js
     out: proto
     opt: import_style=commonjs,binary
@@ -26,3 +30,18 @@ plugins:
     out: proto
     opt: proto/markdown.tmpl,proto/buf.md
     strategy: all
+
+  - plugin: buf.build/grpc-ecosystem/gateway
+    out: proto
+    opt: paths=source_relative
+
+  - plugin: buf.build/grpc-ecosystem/openapiv2
+    opt:
+      - allow_merge=true
+      - merge_file_name=api
+      - openapi_naming_strategy=fqn
+      - visibility_restriction_selectors=PUBLIC
+      - disable_service_tags=true
+      - disable_default_errors=true
+      - disable_default_responses=true
+    out: spec

cmd/check/root.go

@@ -10,15 +10,15 @@ import (
 	"github.com/ory/keto/ketoapi"
 	rts "github.com/ory/keto/proto/ory/keto/relation_tuples/v1alpha2"
 
-	"github.com/ory/keto/internal/check"
-
 	"github.com/ory/x/cmdx"
 	"github.com/spf13/cobra"
 
 	"github.com/ory/keto/cmd/client"
 )
 
-type checkOutput check.CheckPermissionResult
+type checkOutput struct {
+	Allowed bool `json:"allowed"`
+}
 
 func (o *checkOutput) String() string {
 	if o.Allowed {

cmd/expand/root.go

@@ -6,6 +6,8 @@ package expand
 import (
 	"fmt"
 
+	"google.golang.org/protobuf/encoding/protojson"
+
 	"github.com/ory/keto/ketoapi"
 
 	rts "github.com/ory/keto/proto/ory/keto/relation_tuples/v1alpha2"
@@ -53,7 +55,7 @@ func NewExpandCmd() *cobra.Command {
 				tree = ketoapi.TreeFromProto[*ketoapi.RelationTuple](resp.Tree)
 			}
 
-			cmdx.PrintJSONAble(cmd, tree)
+			cmdx.PrintJSONAble(cmd, &pbJSONValue{resp})
 			switch flagx.MustGetString(cmd, cmdx.FlagFormat) {
 			case string(cmdx.FormatDefault), "":
 				if tree == nil && !flagx.MustGetBool(cmd, cmdx.FlagQuiet) {
@@ -76,3 +78,20 @@ func NewExpandCmd() *cobra.Command {
 func RegisterCommandsRecursive(parent *cobra.Command) {
 	parent.AddCommand(NewExpandCmd())
 }
+
+type pbJSONValue struct{ *rts.ExpandResponse }
+
+func (v *pbJSONValue) MarshalJSON() ([]byte, error) {
+	marshaler := &protojson.MarshalOptions{EmitUnpopulated: true}
+	if v.Tree == nil || v.Tree.NodeType.Number() == 0 {
+		return []byte("null"), nil
+	}
+	return marshaler.Marshal(v.Tree)
+}
+func (v *pbJSONValue) String() string {
+	var tree *ketoapi.Tree[*ketoapi.RelationTuple]
+	if v.Tree != nil {
+		tree = ketoapi.TreeFromProto[*ketoapi.RelationTuple](v.Tree)
+	}
+	return tree.String()
+}

cmd/status/root_test.go

@@ -12,14 +12,15 @@ import (
 	"testing"
 	"time"
 
-	"github.com/ory/x/cmdx"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/sync/errgroup"
 	"google.golang.org/grpc"
 	grpcHealthV1 "google.golang.org/grpc/health/grpc_health_v1"
 	"google.golang.org/grpc/metadata"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/ory/keto/cmd/client"
 	"github.com/ory/keto/internal/driver"
 	"github.com/ory/keto/internal/namespace"
@@ -37,7 +38,7 @@ func TestStatusCmd(t *testing.T) {
 				defer cancel()
 
 				stdErr := cmdx.ExecExpectedErrCtx(ctx, t, newStatusCmd(), "--"+FlagEndpoint, string(serverType), "--"+ts.FlagRemote, ts.Addr[:len(ts.Addr)-1])
-				assert.Equal(t, "context deadline exceeded", stdErr)
+				assert.Contains(t, stdErr, "context deadline exceeded")
 			})
 
 			t.Run("case=noblock", func(t *testing.T) {