autogen(docs): generate cli docs

ory-bot · ory-bot · commit fcc2f9cd1877 · 2022-03-04T10:22:56.000Z
diff --git a/docs/keto/cli/keto-check.md b/docs/keto/cli/keto-check.md
@@ -9,15 +9,13 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto check
 
 Check whether a subject has a relation on an object
 
 ### Synopsis
 
-Check whether a subject has a relation on an object. This method resolves
-subject sets and subject set rewrites.
+Check whether a subject has a relation on an object. This method resolves subject sets and subject set rewrites.
 
 ```
 keto check &lt;subject&gt; &lt;relation&gt; &lt;namespace&gt; &lt;object&gt; [flags]
@@ -42,4 +40,5 @@ keto check &lt;subject&gt; &lt;relation&gt; &lt;namespace&gt; &lt;object&gt; [fl
 
 ### SEE ALSO
 
-- [keto](keto) - Global and consistent permission and authorization server
+* [keto](keto)	 - Global and consistent permission and authorization server
+
diff --git a/docs/keto/cli/keto-expand.md b/docs/keto/cli/keto-expand.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto expand
 
 Expand a subject set
@@ -41,4 +40,5 @@ keto expand &lt;relation&gt; &lt;namespace&gt; &lt;object&gt; [flags]
 
 ### SEE ALSO
 
-- [keto](keto) - Global and consistent permission and authorization server
+* [keto](keto)	 - Global and consistent permission and authorization server
+
diff --git a/docs/keto/cli/keto-migrate-down.md b/docs/keto/cli/keto-migrate-down.md
@@ -9,15 +9,14 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto migrate down
 
 Migrate the database down
 
 ### Synopsis
 
-Migrate the database down a specific amount of steps. Pass 0 steps to fully
-migrate down.
+Migrate the database down a specific amount of steps.
+Pass 0 steps to fully migrate down.
 
 ```
 keto migrate down &lt;steps&gt; [flags]
@@ -40,4 +39,5 @@ keto migrate down &lt;steps&gt; [flags]
 
 ### SEE ALSO
 
-- [keto migrate](keto-migrate) - Commands to migrate the database
+* [keto migrate](keto-migrate)	 - Commands to migrate the database
+
diff --git a/docs/keto/cli/keto-migrate-status.md b/docs/keto/cli/keto-migrate-status.md
@@ -9,15 +9,14 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto migrate status
 
 Get the current migration status
 
 ### Synopsis
 
-Get the current migration status. This does not affect namespaces. Use
-`keto namespace migrate status` for migrating namespaces.
+Get the current migration status.
+This does not affect namespaces. Use `keto namespace migrate status` for migrating namespaces.
 
 ```
 keto migrate status [flags]
@@ -39,4 +38,5 @@ keto migrate status [flags]
 
 ### SEE ALSO
 
-- [keto migrate](keto-migrate) - Commands to migrate the database
+* [keto migrate](keto-migrate)	 - Commands to migrate the database
+
diff --git a/docs/keto/cli/keto-migrate-up.md b/docs/keto/cli/keto-migrate-up.md
@@ -9,24 +9,22 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto migrate up
 
 Migrate the database up
 
 ### Synopsis
 
-Run this command on a fresh SQL installation and when you upgrade Ory Keto from
-version v0.7.x and later.
+Run this command on a fresh SQL installation and when you upgrade Ory Keto from version v0.7.x and later.
 
-It is recommended to run this command close to the SQL instance (e.g. same
-subnet) instead of over the public internet. This decreases risk of failure and
-decreases time required.
+It is recommended to run this command close to the SQL instance (e.g. same subnet) instead of over the public internet.
+This decreases risk of failure and decreases time required.
 
-### WARNING
+### WARNING ###
 
 Before running this command on an existing database, create a back up!
 
+
 ```
 keto migrate up [flags]
 ```
@@ -48,4 +46,5 @@ keto migrate up [flags]
 
 ### SEE ALSO
 
-- [keto migrate](keto-migrate) - Commands to migrate the database
+* [keto migrate](keto-migrate)	 - Commands to migrate the database
+
diff --git a/docs/keto/cli/keto-migrate.md b/docs/keto/cli/keto-migrate.md
@@ -9,15 +9,14 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto migrate
 
 Commands to migrate the database
 
 ### Synopsis
 
-Commands to migrate the database. This does not affect namespaces. Use
-`keto namespace migrate` for migrating namespaces.
+Commands to migrate the database.
+This does not affect namespaces. Use `keto namespace migrate` for migrating namespaces.
 
 ### Options
 
@@ -33,7 +32,8 @@ Commands to migrate the database. This does not affect namespaces. Use
 
 ### SEE ALSO
 
-- [keto](keto) - Global and consistent permission and authorization server
-- [keto migrate down](keto-migrate-down) - Migrate the database down
-- [keto migrate status](keto-migrate-status) - Get the current migration status
-- [keto migrate up](keto-migrate-up) - Migrate the database up
+* [keto](keto)	 - Global and consistent permission and authorization server
+* [keto migrate down](keto-migrate-down)	 - Migrate the database down
+* [keto migrate status](keto-migrate-status)	 - Get the current migration status
+* [keto migrate up](keto-migrate-up)	 - Migrate the database up
+
diff --git a/docs/keto/cli/keto-namespace-migrate-legacy.md b/docs/keto/cli/keto-namespace-migrate-legacy.md
@@ -1,27 +1,24 @@
 ---
 id: keto-namespace-migrate-legacy
 title: keto namespace migrate legacy
-description:
-  keto namespace migrate legacy Migrate a namespace from v0.6.x to v0.7.x and
-  later.
+description: keto namespace migrate legacy Migrate a namespace from v0.6.x to v0.7.x and later.
 ---
 
 <!--
 This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto namespace migrate legacy
 
 Migrate a namespace from v0.6.x to v0.7.x and later.
 
 ### Synopsis
 
-Migrate a legacy namespaces from v0.6.x to the v0.7.x and later. This step only
-has to be executed once. If no namespace is specified, all legacy namespaces
-will be migrated. Please ensure that namespace IDs did not change in the config
-file and you have a backup in case something goes wrong!
+Migrate a legacy namespaces from v0.6.x to the v0.7.x and later.
+This step only has to be executed once.
+If no namespace is specified, all legacy namespaces will be migrated.
+Please ensure that namespace IDs did not change in the config file and you have a backup in case something goes wrong!
 
 ```
 keto namespace migrate legacy [&lt;namespace-name&gt;] [flags]
@@ -47,4 +44,5 @@ keto namespace migrate legacy [&lt;namespace-name&gt;] [flags]
 
 ### SEE ALSO
 
-- [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace
+* [keto namespace migrate](keto-namespace-migrate)	 - Migrate a namespace
+
diff --git a/docs/keto/cli/keto-namespace-migrate.md b/docs/keto/cli/keto-namespace-migrate.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto namespace migrate
 
 Migrate a namespace
@@ -28,6 +27,6 @@ Migrate a namespace
 
 ### SEE ALSO
 
-- [keto namespace](keto-namespace) - Read and manipulate namespaces
-- [keto namespace migrate legacy](keto-namespace-migrate-legacy) - Migrate a
-  namespace from v0.6.x to v0.7.x and later.
+* [keto namespace](keto-namespace)	 - Read and manipulate namespaces
+* [keto namespace migrate legacy](keto-namespace-migrate-legacy)	 - Migrate a namespace from v0.6.x to v0.7.x and later.
+
diff --git a/docs/keto/cli/keto-namespace-validate.md b/docs/keto/cli/keto-namespace-validate.md
@@ -9,16 +9,16 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto namespace validate
 
 Validate namespace definitions
 
 ### Synopsis
 
-validate Validates namespace definitions. Parses namespace yaml files or
-configuration files passed via the configuration flag. Returns human readable
-errors. Useful for debugging.
+validate
+Validates namespace definitions. Parses namespace yaml files or configuration
+files passed via the configuration flag. Returns human readable errors. Useful for
+debugging.
 
 ```
 keto namespace validate &lt;namespace.yml&gt; [&lt;namespace2.yml&gt; ...] | validate -c &lt;config.yaml&gt; [flags]
@@ -38,4 +38,5 @@ keto namespace validate &lt;namespace.yml&gt; [&lt;namespace2.yml&gt; ...] | val
 
 ### SEE ALSO
 
-- [keto namespace](keto-namespace) - Read and manipulate namespaces
+* [keto namespace](keto-namespace)	 - Read and manipulate namespaces
+
diff --git a/docs/keto/cli/keto-namespace.md b/docs/keto/cli/keto-namespace.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto namespace
 
 Read and manipulate namespaces
@@ -28,7 +27,7 @@ Read and manipulate namespaces
 
 ### SEE ALSO
 
-- [keto](keto) - Global and consistent permission and authorization server
-- [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace
-- [keto namespace validate](keto-namespace-validate) - Validate namespace
-  definitions
+* [keto](keto)	 - Global and consistent permission and authorization server
+* [keto namespace migrate](keto-namespace-migrate)	 - Migrate a namespace
+* [keto namespace validate](keto-namespace-validate)	 - Validate namespace definitions
+
diff --git a/docs/keto/cli/keto-relation-tuple-create.md b/docs/keto/cli/keto-relation-tuple-create.md
@@ -9,16 +9,15 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto relation-tuple create
 
 Create relation tuples from JSON files
 
 ### Synopsis
 
-Create relation tuples from JSON files. A directory will be traversed and all
-relation tuples will be created. Pass the special filename `-` to read from
-STD_IN.
+Create relation tuples from JSON files.
+A directory will be traversed and all relation tuples will be created.
+Pass the special filename `-` to read from STD_IN.
 
 ```
 keto relation-tuple create &lt;relation-tuple.json&gt; [&lt;relation-tuple-dir&gt;] [flags]
@@ -42,5 +41,5 @@ keto relation-tuple create &lt;relation-tuple.json&gt; [&lt;relation-tuple-dir&g
 
 ### SEE ALSO
 
-- [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation
-  tuples
+* [keto relation-tuple](keto-relation-tuple)	 - Read and manipulate relation tuples
+
diff --git a/docs/keto/cli/keto-relation-tuple-delete-all.md b/docs/keto/cli/keto-relation-tuple-delete-all.md
@@ -1,26 +1,22 @@
 ---
 id: keto-relation-tuple-delete-all
 title: keto relation-tuple delete-all
-description:
-  keto relation-tuple delete-all Delete ALL relation tuples matching the
-  relation query.
+description: keto relation-tuple delete-all Delete ALL relation tuples matching the relation query.
 ---
 
 <!--
 This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto relation-tuple delete-all
 
 Delete ALL relation tuples matching the relation query.
 
 ### Synopsis
 
-Delete all relation tuples matching the relation query. It is recommended to
-first run the command without the `--force` flag to verify that the operation is
-safe.
+Delete all relation tuples matching the relation query.
+It is recommended to first run the command without the `--force` flag to verify that the operation is safe.
 
 ```
 keto relation-tuple delete-all [flags]
@@ -50,5 +46,5 @@ keto relation-tuple delete-all [flags]
 
 ### SEE ALSO
 
-- [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation
-  tuples
+* [keto relation-tuple](keto-relation-tuple)	 - Read and manipulate relation tuples
+
diff --git a/docs/keto/cli/keto-relation-tuple-delete.md b/docs/keto/cli/keto-relation-tuple-delete.md
@@ -1,25 +1,23 @@
 ---
 id: keto-relation-tuple-delete
 title: keto relation-tuple delete
-description:
-  keto relation-tuple delete Delete relation tuples defined in JSON files
+description: keto relation-tuple delete Delete relation tuples defined in JSON files
 ---
 
 <!--
 This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto relation-tuple delete
 
 Delete relation tuples defined in JSON files
 
 ### Synopsis
 
-Delete relation tuples defined in the given JSON files. A directory will be
-traversed and all relation tuples will be deleted. Pass the special filename `-`
-to read from STD_IN.
+Delete relation tuples defined in the given JSON files.
+A directory will be traversed and all relation tuples will be deleted.
+Pass the special filename `-` to read from STD_IN.
 
 ```
 keto relation-tuple delete &lt;relation-tuple.json&gt; [&lt;relation-tuple-dir&gt;] [flags]
@@ -43,5 +41,5 @@ keto relation-tuple delete &lt;relation-tuple.json&gt; [&lt;relation-tuple-dir&g
 
 ### SEE ALSO
 
-- [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation
-  tuples
+* [keto relation-tuple](keto-relation-tuple)	 - Read and manipulate relation tuples
+
diff --git a/docs/keto/cli/keto-relation-tuple-get.md b/docs/keto/cli/keto-relation-tuple-get.md
@@ -9,14 +9,14 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## keto relation-tuple get
 
 Get relation tuples
 
 ### Synopsis
 
-Get relation tuples matching the given partial tuple. Returns paginated results.
+Get relation tuples matching the given partial tuple.
+Returns paginated results.
 
 ```
 keto relation-tuple get [flags]
@@ -47,5 +47,5 @@ keto relation-tuple get [flags]
 
 ### SEE ALSO
 
-- [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation
-  tuples
+* [keto relation-tuple](keto-relation-tuple)	 - Read and manipulate relation tuples
+
diff --git a/docs/keto/cli/keto-relation-tuple-parse.md b/docs/keto/cli/keto-relation-tuple-parse.md
diff --git a/docs/keto/cli/keto-relation-tuple.md b/docs/keto/cli/keto-relation-tuple.md
diff --git a/docs/keto/cli/keto-serve.md b/docs/keto/cli/keto-serve.md
diff --git a/docs/keto/cli/keto-status.md b/docs/keto/cli/keto-status.md
diff --git a/docs/keto/cli/keto-version.md b/docs/keto/cli/keto-version.md
diff --git a/docs/keto/cli/keto.md b/docs/keto/cli/keto.md
