diff --git a/docs/.generated/proto-api.mdx b/docs/.generated/proto-api.mdx index 18cc1bfea..50368be8a 100644 --- a/docs/.generated/proto-api.mdx +++ b/docs/.generated/proto-api.mdx @@ -4,8 +4,9 @@ title: Protocol Buffers API -The API is divided into the [read APIs](../concepts/api-overview.mdx#read-apis) -and [write APIs](../concepts/api-overview.mdx#write-apis). Each service is +The API is divided into the +[read APIs](../concepts/25_api-overview.mdx#read-apis) and +[write APIs](../concepts/25_api-overview.mdx#write-apis). Each service is annotated with the API it belongs to. ## ory/keto/acl/v1alpha1/acl.proto @@ -26,10 +27,10 @@ RelationTuple defines a relation between an Object and a Subject. Subject is either a concrete subject id or a `SubjectSet` expanding to more Subjects. -| Field | Type | Label | Description | -| ----- | ----------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------- | -| id | [string](#string) | | A concrete id of the subject. | -| set | [SubjectSet](#ory.keto.acl.v1alpha1.SubjectSet) | | A subject set that expands to more Subjects. More information are available under [concepts](../concepts/subjects.mdx). | +| Field | Type | Label | Description | +| ----- | ----------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------- | +| id | [string](#string) | | A concrete id of the subject. | +| set | [SubjectSet](#ory.keto.acl.v1alpha1.SubjectSet) | | A subject set that expands to more Subjects. More information are available under [concepts](../concepts/15_subjects.mdx). | ### SubjectSet @@ -48,7 +49,8 @@ SubjectSet refers to all subjects who have the same `relation` on an `object`. The service that performs authorization checks based on the stored Access Control Lists. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ----------- | --------------------------------------------------- | ----------------------------------------------------- | -------------------------------- | @@ -85,7 +87,8 @@ The response for a CheckService.Check rpc. The service that performs subject set expansion based on the stored Access Control Lists. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ----------- | ----------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------ | @@ -133,7 +136,8 @@ The response for a ExpandService.Expand RPC. The service to query relation tuples. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------- | @@ -190,8 +194,9 @@ The response of a ReadService.ListRelationTuples RPC. The service returning the specific Ory Keto instance version. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis) -and [write-APIs](../concepts/api-overview.mdx#write-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis) and +[write-APIs](../concepts/25_api-overview.mdx#write-apis). | Method Name | Request Type | Response Type | Description | | ----------- | ------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------- | @@ -216,7 +221,7 @@ Response of the VersionService.GetVersion RPC. The write service to create and delete Access Control Lists. This service is part of the -[write-APIs](../concepts/api-overview.mdx#write-apis). +[write-APIs](../concepts/25_api-overview.mdx#write-apis). | Method Name | Request Type | Response Type | Description | | ---------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------- | diff --git a/proto/buf.md b/proto/buf.md index 19b9fcd67..7d89debfe 100644 --- a/proto/buf.md +++ b/proto/buf.md @@ -176,10 +176,10 @@ RelationTuple defines a relation between an Object and a Subject. Subject is either a concrete subject id or a `SubjectSet` expanding to more Subjects. -| Field | Type | Label | Description | -| ----- | ----------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------- | -| id | [string](#string) | | A concrete id of the subject. | -| set | [SubjectSet](#ory-keto-relation_tuples-v1alpha2-SubjectSet) | | A subject set that expands to more Subjects. More information are available under [concepts](../concepts/subjects.mdx). | +| Field | Type | Label | Description | +| ----- | ----------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------- | +| id | [string](#string) | | A concrete id of the subject. | +| set | [SubjectSet](#ory-keto-relation_tuples-v1alpha2-SubjectSet) | | A subject set that expands to more Subjects. More information are available under [concepts](../concepts/15_subjects.mdx). | @@ -279,7 +279,8 @@ seconds). --> | The service that performs authorization checks based on the stored Access Control Lists. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ----------- | --------------------------------------------------------------- | ----------------------------------------------------------------- | -------------------------------- | @@ -364,7 +365,8 @@ This is never set if `node_type` == `NODE_TYPE_LEAF`. | The service that performs subject set expansion based on the stored Access Control Lists. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ----------- | ----------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------ | @@ -404,7 +406,8 @@ Request for ReadService.ListNamespaces RPC. The service to query namespaces. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | -------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------- | @@ -494,7 +497,8 @@ The response of a ReadService.ListRelationTuples RPC. The service to query relationships. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis). | Method Name | Request Type | Response Type | Description | | ------------------ | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------ | @@ -528,8 +532,9 @@ Response of the VersionService.GetVersion RPC. The service returning the specific Ory Keto instance version. -This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis) -and [write-APIs](../concepts/api-overview.mdx#write-apis). +This service is part of the +[read-APIs](../concepts/25_api-overview.mdx#read-apis) and +[write-APIs](../concepts/25_api-overview.mdx#write-apis). | Method Name | Request Type | Response Type | Description | | ----------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------- | @@ -618,7 +623,7 @@ index. --> | The write service to create and delete Access Control Lists. This service is part of the -[write-APIs](../concepts/api-overview.mdx#write-apis). +[write-APIs](../concepts/25_api-overview.mdx#write-apis). | Method Name | Request Type | Response Type | Description | | ---------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | diff --git a/proto/ory/keto/relation_tuples/v1alpha2/check_service.proto b/proto/ory/keto/relation_tuples/v1alpha2/check_service.proto index 7476964e3..bda49a33f 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/check_service.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/check_service.proto @@ -14,7 +14,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The service that performs authorization checks // based on the stored Access Control Lists. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). service CheckService { // Performs an authorization check. rpc Check(CheckRequest) returns (CheckResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/check_service_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/check_service_grpc_pb.js index 65fe201f5..57fdbffb3 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/check_service_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/check_service_grpc_pb.js @@ -31,7 +31,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_CheckResponse(buffer_arg) // The service that performs authorization checks // based on the stored Access Control Lists. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). var CheckServiceService = exports.CheckServiceService = { // Performs an authorization check. check: { diff --git a/proto/ory/keto/relation_tuples/v1alpha2/expand_service.proto b/proto/ory/keto/relation_tuples/v1alpha2/expand_service.proto index e0c776bf5..c1d222a01 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/expand_service.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/expand_service.proto @@ -14,7 +14,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The service that performs subject set expansion // based on the stored Access Control Lists. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). service ExpandService { // Expands the subject set into a tree of subjects. rpc Expand(ExpandRequest) returns (ExpandResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/expand_service_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/expand_service_grpc_pb.js index ab89c4b40..a68a2b437 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/expand_service_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/expand_service_grpc_pb.js @@ -31,7 +31,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_ExpandResponse(buffer_arg // The service that performs subject set expansion // based on the stored Access Control Lists. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). var ExpandServiceService = exports.ExpandServiceService = { // Expands the subject set into a tree of subjects. expand: { diff --git a/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service.proto b/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service.proto index 441d905e9..1ea37c721 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service.proto @@ -11,7 +11,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The service to query namespaces. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). service NamespacesService { // Lists Namespaces rpc ListNamespaces(ListNamespacesRequest) returns (ListNamespacesResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service_grpc_pb.js index 8ca080c8e..a7aad5f61 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/namespaces_service_grpc_pb.js @@ -29,7 +29,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_ListNamespacesResponse(bu // The service to query namespaces. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). var NamespacesServiceService = exports.NamespacesServiceService = { // Lists Namespaces listNamespaces: { diff --git a/proto/ory/keto/relation_tuples/v1alpha2/read_service.proto b/proto/ory/keto/relation_tuples/v1alpha2/read_service.proto index 55380299d..78260a69d 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/read_service.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/read_service.proto @@ -14,7 +14,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The service to query relationships. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). service ReadService { // Lists ACL relationships. rpc ListRelationTuples(ListRelationTuplesRequest) returns (ListRelationTuplesResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/read_service_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/read_service_grpc_pb.js index b7f6ffdba..5f3a2e045 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/read_service_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/read_service_grpc_pb.js @@ -31,7 +31,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_ListRelationTuplesRespons // The service to query relationships. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis). var ReadServiceService = exports.ReadServiceService = { // Lists ACL relationships. listRelationTuples: { diff --git a/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.pb.go b/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.pb.go index 815719913..167ca1c0c 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.pb.go +++ b/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.pb.go @@ -267,7 +267,7 @@ type Subject_Id struct { type Subject_Set struct { // A subject set that expands to more Subjects. - // More information are available under [concepts](../concepts/subjects.mdx). + // More information are available under [concepts](../concepts/15_subjects.mdx). Set *SubjectSet `protobuf:"bytes,2,opt,name=set,proto3,oneof"` } diff --git a/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.proto b/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.proto index 7cd1d17e0..bc6eac5d9 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.proto @@ -56,7 +56,7 @@ message Subject { // A concrete id of the subject. string id = 1; // A subject set that expands to more Subjects. - // More information are available under [concepts](../concepts/subjects.mdx). + // More information are available under [concepts](../concepts/15_subjects.mdx). SubjectSet set = 2; } } diff --git a/proto/ory/keto/relation_tuples/v1alpha2/version.proto b/proto/ory/keto/relation_tuples/v1alpha2/version.proto index 5afa45d9b..33ecd11a8 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/version.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/version.proto @@ -11,7 +11,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The service returning the specific Ory Keto instance version. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis) and [write-APIs](../concepts/api-overview.mdx#write-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis) and [write-APIs](../concepts/25_api-overview.mdx#write-apis). service VersionService { // Returns the version of the Ory Keto instance. rpc GetVersion(GetVersionRequest) returns (GetVersionResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/version_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/version_grpc_pb.js index 8099d1e7e..8dba0fae7 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/version_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/version_grpc_pb.js @@ -29,7 +29,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_GetVersionResponse(buffer // The service returning the specific Ory Keto instance version. // -// This service is part of the [read-APIs](../concepts/api-overview.mdx#read-apis) and [write-APIs](../concepts/api-overview.mdx#write-apis). +// This service is part of the [read-APIs](../concepts/25_api-overview.mdx#read-apis) and [write-APIs](../concepts/25_api-overview.mdx#write-apis). var VersionServiceService = exports.VersionServiceService = { // Returns the version of the Ory Keto instance. getVersion: { diff --git a/proto/ory/keto/relation_tuples/v1alpha2/write_service.proto b/proto/ory/keto/relation_tuples/v1alpha2/write_service.proto index f29e94937..d3b0a58e8 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/write_service.proto +++ b/proto/ory/keto/relation_tuples/v1alpha2/write_service.proto @@ -13,7 +13,7 @@ option php_namespace = "Ory\\Keto\\RelationTuples\\v1alpha2"; // The write service to create and delete Access Control Lists. // -// This service is part of the [write-APIs](../concepts/api-overview.mdx#write-apis). +// This service is part of the [write-APIs](../concepts/25_api-overview.mdx#write-apis). service WriteService { // Writes one or more relationships in a single transaction. rpc TransactRelationTuples(TransactRelationTuplesRequest) returns (TransactRelationTuplesResponse); diff --git a/proto/ory/keto/relation_tuples/v1alpha2/write_service_grpc_pb.js b/proto/ory/keto/relation_tuples/v1alpha2/write_service_grpc_pb.js index 7fe0972b5..44547a688 100644 --- a/proto/ory/keto/relation_tuples/v1alpha2/write_service_grpc_pb.js +++ b/proto/ory/keto/relation_tuples/v1alpha2/write_service_grpc_pb.js @@ -52,7 +52,7 @@ function deserialize_ory_keto_relation_tuples_v1alpha2_TransactRelationTuplesRes // The write service to create and delete Access Control Lists. // -// This service is part of the [write-APIs](../concepts/api-overview.mdx#write-apis). +// This service is part of the [write-APIs](../concepts/25_api-overview.mdx#write-apis). var WriteServiceService = exports.WriteServiceService = { // Writes one or more relationships in a single transaction. transactRelationTuples: {