Skip to content

Commit

Permalink
fix: resolve clidoc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Apr 25, 2021
1 parent 86ab245 commit ef12b4e
Show file tree
Hide file tree
Showing 24 changed files with 120 additions and 142 deletions.
9 changes: 4 additions & 5 deletions docs/docs/cli/keto-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <subject> <relation> <namespace> <object> [flags]
Expand All @@ -36,9 +34,10 @@ keto check <subject> <relation> <namespace> <object> [fl
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto](keto) - Global and consistent permission and authorization server
* [keto](keto) - Global and consistent permission and authorization server

6 changes: 3 additions & 3 deletions docs/docs/cli/keto-expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -35,9 +34,10 @@ keto expand <relation> <namespace> <object> [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto](keto) - Global and consistent permission and authorization server
* [keto](keto) - Global and consistent permission and authorization server

12 changes: 6 additions & 6 deletions docs/docs/cli/keto-migrate-down.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ 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. This does not affect namespaces. Use `keto namespace migrate down`
for migrating namespaces.
Migrate the database down a specific amount of steps.
Pass 0 steps to fully migrate down.
This does not affect namespaces. Use `keto namespace migrate down` for migrating namespaces.

```
keto migrate down <steps> [flags]
Expand All @@ -36,9 +35,10 @@ keto migrate down <steps> [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto migrate](keto-migrate) - Commands to migrate the database
* [keto migrate](keto-migrate) - Commands to migrate the database

10 changes: 5 additions & 5 deletions docs/docs/cli/keto-migrate-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -34,9 +33,10 @@ keto migrate status [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto migrate](keto-migrate) - Commands to migrate the database
* [keto migrate](keto-migrate) - Commands to migrate the database

10 changes: 5 additions & 5 deletions docs/docs/cli/keto-migrate-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 up

Migrate the database up

### Synopsis

Migrate the database up. This does not affect namespaces. Use
`keto namespace migrate up` for migrating namespaces.
Migrate the database up.
This does not affect namespaces. Use `keto namespace migrate up` for migrating namespaces.

```
keto migrate up [flags]
Expand All @@ -36,9 +35,10 @@ keto migrate up [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto migrate](keto-migrate) - Commands to migrate the database
* [keto migrate](keto-migrate) - Commands to migrate the database

16 changes: 8 additions & 8 deletions docs/docs/cli/keto-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -28,12 +27,13 @@ Commands to migrate the database. This does not affect namespaces. Use
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### 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

9 changes: 5 additions & 4 deletions docs/docs/cli/keto-namespace-migrate-down.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## keto namespace migrate down

Migrate a namespace down

### Synopsis

Migrate a namespace down. Pass 0 steps to fully migrate down.
Migrate a namespace down.
Pass 0 steps to fully migrate down.

```
keto namespace migrate down <namespace-name> <steps> [flags]
Expand All @@ -36,9 +36,10 @@ keto namespace migrate down <namespace-name> <steps> [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace
* [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace

13 changes: 6 additions & 7 deletions docs/docs/cli/keto-namespace-migrate-status.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
---
id: keto-namespace-migrate-status
title: keto namespace migrate status
description:
keto namespace migrate status Get the current namespace migration status
description: keto namespace migrate status Get the current namespace migration status
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## keto namespace migrate status

Get the current namespace migration status

### Synopsis

Get the current migration status of one specific namespace. Does not apply any
changes.
Get the current migration status of one specific namespace.
Does not apply any changes.

```
keto namespace migrate status &lt;namespace-name&gt; [flags]
Expand All @@ -35,9 +33,10 @@ keto namespace migrate status &lt;namespace-name&gt; [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace
* [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace

6 changes: 3 additions & 3 deletions docs/docs/cli/keto-namespace-migrate-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 up

Migrate a namespace up
Expand All @@ -36,9 +35,10 @@ keto namespace migrate up &lt;namespace-name&gt; [flags]
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace
* [keto namespace migrate](keto-namespace-migrate) - Migrate a namespace

15 changes: 6 additions & 9 deletions docs/docs/cli/keto-namespace-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -23,15 +22,13 @@ Migrate a namespace
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto namespace](keto-namespace) - Read and manipulate namespaces
- [keto namespace migrate down](keto-namespace-migrate-down) - Migrate a
namespace down
- [keto namespace migrate status](keto-namespace-migrate-status) - Get the
current namespace migration status
- [keto namespace migrate up](keto-namespace-migrate-up) - Migrate a namespace
up
* [keto namespace](keto-namespace) - Read and manipulate namespaces
* [keto namespace migrate down](keto-namespace-migrate-down) - Migrate a namespace down
* [keto namespace migrate status](keto-namespace-migrate-status) - Get the current namespace migration status
* [keto namespace migrate up](keto-namespace-migrate-up) - Migrate a namespace up

9 changes: 4 additions & 5 deletions docs/docs/cli/keto-namespace-validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## keto namespace validate

Validate namespace files

### Synopsis

Validate one or more namespace yaml files and get human readable errors. Useful
for debugging.
Validate one or more namespace yaml files and get human readable errors. Useful for debugging.

```
keto namespace validate &lt;namespace.yml&gt; [&lt;namespace2.yml&gt; ...] [flags]
Expand All @@ -32,9 +30,10 @@ keto namespace validate &lt;namespace.yml&gt; [&lt;namespace2.yml&gt; ...] [flag
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto namespace](keto-namespace) - Read and manipulate namespaces
* [keto namespace](keto-namespace) - Read and manipulate namespaces

10 changes: 5 additions & 5 deletions docs/docs/cli/keto-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -23,11 +22,12 @@ Read and manipulate namespaces
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### 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 files
* [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 files

13 changes: 6 additions & 7 deletions docs/docs/cli/keto-relation-tuple-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -37,10 +36,10 @@ keto relation-tuple create &lt;relation-tuple.json&gt; [&lt;relation-tuple-dir&g
### Options inherited from parent commands

```
-c, --config strings Config files to load, overwriting in the order specified. (default [/home/circleci/keto.yml])
-c, --config strings Config files to load, overwriting in the order specified. (default [/Users/foobar/keto.yml])
```

### SEE ALSO

- [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation
tuples
* [keto relation-tuple](keto-relation-tuple) - Read and manipulate relation tuples

0 comments on commit ef12b4e

Please sign in to comment.