Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: docs broken links #1254

Merged
merged 2 commits into from
Feb 23, 2023
Merged

fix: docs broken links #1254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0474fc2
fix: docs broken links
tomekpapiernik Feb 23, 2023
bc3619d
fix: edit proto files to fix links
tomekpapiernik Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions docs/.generated/proto-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ title: Protocol Buffers API

<!-- This file is generated. Please edit the .proto files instead to update the documentation -->

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
Expand All @@ -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

Expand All @@ -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 |
| ----------- | --------------------------------------------------- | ----------------------------------------------------- | -------------------------------- |
Expand Down Expand Up @@ -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 |
| ----------- | ----------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------ |
Expand Down Expand Up @@ -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 |
| ------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------- |
Expand Down Expand Up @@ -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 |
| ----------- | ------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------- |
Expand All @@ -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 |
| ---------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
Expand Down
27 changes: 16 additions & 11 deletions proto/buf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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). |

<a name="ory-keto-relation_tuples-v1alpha2-SubjectSet"></a>

Expand Down Expand Up @@ -279,7 +279,8 @@ seconds). --&gt; |
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 |
| ----------- | --------------------------------------------------------------- | ----------------------------------------------------------------- | -------------------------------- |
Expand Down Expand Up @@ -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 |
| ----------- | ----------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------ |
Expand Down Expand Up @@ -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 |
| -------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------- |
Expand Down Expand Up @@ -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 |
| ------------------ | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------ |
Expand Down Expand Up @@ -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 |
| ----------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------- |
Expand Down Expand Up @@ -618,7 +623,7 @@ index. --&gt; |
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 |
| ---------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/check_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/check_service_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/expand_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/expand_service_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/namespaces_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/namespaces_service_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/read_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/read_service_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/relation_tuples.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/version.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/version_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/write_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion proto/ory/keto/relation_tuples/v1alpha2/write_service_grpc_pb.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.