autogen(docs): generate and format documentation

ory · Apr 7, 2021 · 6cd2415 · 6cd2415
1 parent d6745dd
commit 6cd2415
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 41 deletions.
diff --git a/docs/docs/guides/expand-api-display-who-has-access.mdx b/docs/docs/guides/expand-api-display-who-has-access.mdx
@@ -75,7 +75,7 @@ tree of everyone who has access to that file:
 
 <CodeTabs
   sampleId="expand-api-display-access/01-expand-beach"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ### Maximum Tree Depth

diff --git a/docs/docs/guides/list-api-display-objects.mdx b/docs/docs/guides/list-api-display-objects.mdx
@@ -77,7 +77,7 @@ chats, the application uses Keto's list API:
 
 <CodeTabs
   sampleId="list-api-display-objects/01-list-PM"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 As a response, the application gets the list of all chats the user `PM` is a
@@ -103,7 +103,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:
 
 <CodeTabs
   sampleId="list-api-display-objects/02-list-coffee-break"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ## Application Context

diff --git a/docs/docs/guides/simple-access-check-guide.mdx b/docs/docs/guides/simple-access-check-guide.mdx
@@ -83,15 +83,15 @@ Try this yourself by first adding the relation tuple using the
 
 <CodeTabs
   sampleId="simple-access-check-guide/00-write-direct-access"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 Now, we can use the check-API to verify that `john` is allowed to `decypher` the
 message:
 
 <CodeTabs
   sampleId="simple-access-check-guide/01-check-direct-access"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ### Indirectly Defined Access

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run Ory Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.6.0-alpha.1.pre.6
-$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.6 help
+$ docker pull oryd/keto:v0.6.0-alpha.1.pre.7
+$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.7 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.6
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.7
 $ ./keto help
 ```
 

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -69,7 +69,7 @@ video service client would do. In this example we will use the Keto CLI client.
 If you want to run the Keto CLI within **Docker**, set the alias
 
 ```shell
-alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.6"
+alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.7"
 ```
 
 in your terminal session. Alternatively, you need to set the remote endpoint so

diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md
@@ -677,7 +677,7 @@ namespaces: http://a.aaa
 # - Windows Command Line (CMD):
 #    > set VERSION=<value>
 #
-version: v0.6.0-alpha.1.pre.6
+version: v0.6.0-alpha.1.pre.7
 
 ## Data Source Name ##
 #

diff --git a/docs/versioned_docs/version-v0.6/guides/expand-api-display-who-has-access.mdx b/docs/versioned_docs/version-v0.6/guides/expand-api-display-who-has-access.mdx
@@ -75,7 +75,7 @@ tree of everyone who has access to that file:
 
 <CodeTabs
   sampleId="expand-api-display-access/01-expand-beach"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ### Maximum Tree Depth

diff --git a/docs/versioned_docs/version-v0.6/guides/list-api-display-objects.mdx b/docs/versioned_docs/version-v0.6/guides/list-api-display-objects.mdx
@@ -77,7 +77,7 @@ chats, the application uses Keto's list API:
 
 <CodeTabs
   sampleId="list-api-display-objects/01-list-PM"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 As a response, the application gets the list of all chats the user `PM` is a
@@ -103,7 +103,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:
 
 <CodeTabs
   sampleId="list-api-display-objects/02-list-coffee-break"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ## Application Context

diff --git a/docs/versioned_docs/version-v0.6/guides/simple-access-check-guide.mdx b/docs/versioned_docs/version-v0.6/guides/simple-access-check-guide.mdx
@@ -83,15 +83,15 @@ Try this yourself by first adding the relation tuple using the
 
 <CodeTabs
   sampleId="simple-access-check-guide/00-write-direct-access"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 Now, we can use the check-API to verify that `john` is allowed to `decypher` the
 message:
 
 <CodeTabs
   sampleId="simple-access-check-guide/01-check-direct-access"
-  version="v0.6.0-alpha.1.pre.6"
+  version="v0.6.0-alpha.1.pre.7"
 />
 
 ### Indirectly Defined Access

diff --git a/docs/versioned_docs/version-v0.6/install.md b/docs/versioned_docs/version-v0.6/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run Ory Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.6.0-alpha.1.pre.6
-$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.6 help
+$ docker pull oryd/keto:v0.6.0-alpha.1.pre.7
+$ docker run --rm -it oryd/keto:v0.6.0-alpha.1.pre.7 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.6
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.6.0-alpha.1.pre.7
 $ ./keto help
 ```
 

diff --git a/docs/versioned_docs/version-v0.6/milestones.md b/docs/versioned_docs/version-v0.6/milestones.md
@@ -132,12 +132,12 @@ Affects documentation.
 
 #### Issues
 
-- [ ] Next Gen Documentation
-      ([keto#420](https://github.com/ory/keto/issues/420)) -
-      [@Patrik](https://github.com/zepatrik)
 - [x] Improve documentation of Expand API's max_depth parameter
       ([keto#419](https://github.com/ory/keto/issues/419)) -
       [@Patrik](https://github.com/zepatrik)
+- [x] Next Gen Documentation
+      ([keto#420](https://github.com/ory/keto/issues/420)) -
+      [@Patrik](https://github.com/zepatrik)
 - [x] Do not use latest tags in docker-compose examples
       ([keto#481](https://github.com/ory/keto/issues/481)) -
       [@Patrik](https://github.com/zepatrik)
@@ -163,18 +163,15 @@ Blocks milestones or other issues or pulls.
       [@hackerman](https://github.com/aeneasr),
       [@Patrik](https://github.com/zepatrik),
       [@Robin Brämer](https://github.com/robinbraemer)
-- [ ] Next Gen Documentation
-      ([keto#420](https://github.com/ory/keto/issues/420)) -
-      [@Patrik](https://github.com/zepatrik)
-- [ ] Require relations to be defined in the namespace config
-      ([keto#509](https://github.com/ory/keto/issues/509)) -
-      [@Patrik](https://github.com/zepatrik)
 - [x] Define and architect SQL schema and queries for querying relations
       ([keto#300](https://github.com/ory/keto/issues/300)) -
       [@Patrik](https://github.com/zepatrik)
 - [x] Ensure goreleaser config is still working
       ([keto#410](https://github.com/ory/keto/issues/410)) -
       [@hackerman](https://github.com/aeneasr)
+- [x] Next Gen Documentation
+      ([keto#420](https://github.com/ory/keto/issues/420)) -
+      [@Patrik](https://github.com/zepatrik)
 - [x] Add health check and version endpoints to read/write REST (and gRPC?) API
       ([keto#422](https://github.com/ory/keto/issues/422)) -
       [@Patrik](https://github.com/zepatrik)
@@ -320,6 +317,9 @@ Blocks milestones or other issues or pulls.
 - [ ] Use fizz migrations to generate SQL migrations
       ([keto#448](https://github.com/ory/keto/issues/448)) -
       [@Patrik](https://github.com/zepatrik)
+- [ ] Require relations to be defined in the namespace config
+      ([keto#509](https://github.com/ory/keto/issues/509)) -
+      [@Patrik](https://github.com/zepatrik)
 - [x] Write benchmark tests for relationtuple package
       ([keto#301](https://github.com/ory/keto/issues/301)) -
       [@Patrik](https://github.com/zepatrik)

diff --git a/docs/versioned_docs/version-v0.6/quickstart.mdx b/docs/versioned_docs/version-v0.6/quickstart.mdx
@@ -69,7 +69,7 @@ video service client would do. In this example we will use the Keto CLI client.
 If you want to run the Keto CLI within **Docker**, set the alias
 
 ```shell
-alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.6"
+alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.6.0-alpha.1.pre.7"
 ```
 
 in your terminal session. Alternatively, you need to set the remote endpoint so

diff --git a/docs/versioned_docs/version-v0.6/reference/configuration.md b/docs/versioned_docs/version-v0.6/reference/configuration.md
@@ -677,7 +677,7 @@ namespaces: http://a.aaa
 # - Windows Command Line (CMD):
 #    > set VERSION=<value>
 #
-version: v0.6.0-alpha.1.pre.6
+version: v0.6.0-alpha.1.pre.7
 
 ## Data Source Name ##
 #

diff --git a/docs/versioned_docs/version-v0.6/reference/proto-api.mdx b/docs/versioned_docs/version-v0.6/reference/proto-api.mdx
@@ -178,11 +178,10 @@ Example use cases (namespace is always required):
 
 The response of a ReadService.ListRelationTuples RPC.
 
-| Field           | Type                                                  | Label    | Description                                                                                                                    |
-| --------------- | ----------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| relation_tuples | [RelationTuple](#ory.keto.acl.v1alpha1.RelationTuple) | repeated | The relation tuples matching the list request.                                                                                 |
-| next_page_token | [string](#string)                                     |          | The token required to get the next page. Please use the `is_last_page` field to determine whether this was the last page.      |
-| is_last_page    | [bool](#bool)                                         |          | Whether this is the last page. Using the `next_page_token` in a subsequent request if this field is true will return an error. |
+| Field           | Type                                                  | Label    | Description                                                                                            |
+| --------------- | ----------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| relation_tuples | [RelationTuple](#ory.keto.acl.v1alpha1.RelationTuple) | repeated | The relation tuples matching the list request.                                                         |
+| next_page_token | [string](#string)                                     |          | The token required to get the next page. If this is the last page, the token will be the empty string. |
 
 ## ory/keto/acl/v1alpha1/version.proto
 

diff --git a/docs/versioned_docs/version-v0.6/reference/rest-api.mdx b/docs/versioned_docs/version-v0.6/reference/rest-api.mdx
@@ -540,7 +540,6 @@ Status Code **500**
 
 ```json
 {
-  "is_last_page": true,
   "next_page_token": "string",
   "relation_tuples": [
     {
@@ -1996,7 +1995,6 @@ _Represents the response for a check request._
 
 ```json
 {
-  "is_last_page": true,
   "next_page_token": "string",
   "relation_tuples": [
     {
@@ -2011,11 +2009,10 @@ _Represents the response for a check request._
 
 #### Properties
 
-| Name            | Type                                                    | Required | Restrictions | Description |
-| --------------- | ------------------------------------------------------- | -------- | ------------ | ----------- |
-| is_last_page    | boolean                                                 | false    | none         | none        |
-| next_page_token | string                                                  | false    | none         | none        |
-| relation_tuples | [[InternalRelationTuple](#schemainternalrelationtuple)] | false    | none         | none        |
+| Name            | Type                                                    | Required | Restrictions | Description                                                                                                                         |
+| --------------- | ------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
+| next_page_token | string                                                  | false    | none         | The opaque token to provide in a subsequent request<br/>to get the next page. It is the empty string iff this is<br/>the last page. |
+| relation_tuples | [[InternalRelationTuple](#schemainternalrelationtuple)] | false    | none         | none                                                                                                                                |
 
 <a id="tocShealthnotreadystatus"></a>