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.

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

docs: Add basic document on matching rules support for header fields #819

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/keto/cli/keto-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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
Expand Down Expand Up @@ -40,5 +41,4 @@ keto check <subject> <relation> <namespace> <object> [flags]

### SEE ALSO

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

- [keto](keto) - Global and consistent permission and authorization server
4 changes: 2 additions & 2 deletions docs/keto/cli/keto-expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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 Down Expand Up @@ -40,5 +41,4 @@ keto expand <relation> <namespace> <object> [flags]

### SEE ALSO

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

- [keto](keto) - Global and consistent permission and authorization server
7 changes: 3 additions & 4 deletions docs/keto/cli/keto-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 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 <steps> [flags]
Expand All @@ -39,5 +39,4 @@ keto migrate down <steps> [flags]

### SEE ALSO

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

- [keto migrate](keto-migrate) - Commands to migrate the database
7 changes: 3 additions & 4 deletions docs/keto/cli/keto-migrate-status.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 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 @@ -38,5 +38,4 @@ keto migrate status [flags]

### SEE ALSO

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

- [keto migrate](keto-migrate) - Commands to migrate the database
11 changes: 5 additions & 6 deletions docs/keto/cli/keto-migrate-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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
Expand All @@ -17,14 +18,13 @@ Migrate the database up

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]
```
Expand All @@ -46,5 +46,4 @@ keto migrate up [flags]

### SEE ALSO

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

- [keto migrate](keto-migrate) - Commands to migrate the database
13 changes: 6 additions & 7 deletions docs/keto/cli/keto-migrate.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 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 @@ -32,8 +32,7 @@ This does not affect namespaces. Use `keto namespace migrate` for migrating name

### 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
11 changes: 5 additions & 6 deletions docs/keto/cli/keto-namespace-migrate-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 [<namespace-name>] [flags]
Expand All @@ -44,5 +44,4 @@ keto namespace migrate legacy [<namespace-name>] [flags]

### 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/keto/cli/keto-namespace-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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 @@ -27,6 +28,5 @@ 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.
10 changes: 4 additions & 6 deletions docs/keto/cli/keto-namespace-validate.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 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 <namespace.yml> [<namespace2.yml> ...] | validate -c <config.yaml> [flags]
Expand All @@ -38,5 +37,4 @@ keto namespace validate <namespace.yml> [<namespace2.yml> ...] | validate -c <co

### SEE ALSO

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

- [keto namespace](keto-namespace) - Read and manipulate namespaces
8 changes: 4 additions & 4 deletions docs/keto/cli/keto-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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 @@ -27,7 +28,6 @@ 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
9 changes: 4 additions & 5 deletions docs/keto/cli/keto-relation-tuple-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +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 <relation-tuple.json> [<relation-tuple-dir>] [flags]
Expand All @@ -41,5 +41,4 @@ keto relation-tuple create <relation-tuple.json> [<relation-tuple-dir>] [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
8 changes: 4 additions & 4 deletions docs/keto/cli/keto-relation-tuple-delete-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ 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]
Expand Down Expand Up @@ -46,5 +47,4 @@ 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
7 changes: 3 additions & 4 deletions docs/keto/cli/keto-relation-tuple-delete.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 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.
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.

```
Expand All @@ -41,5 +41,4 @@ keto relation-tuple delete <relation-tuple.json> [<relation-tuple-dir>] [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
7 changes: 3 additions & 4 deletions docs/keto/cli/keto-relation-tuple-get.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 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]
Expand Down Expand Up @@ -47,5 +47,4 @@ 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
9 changes: 4 additions & 5 deletions docs/keto/cli/keto-relation-tuple-parse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This file is auto-generated.

To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## keto relation-tuple parse

Parse human readable relation tuples

### Synopsis

Parse human readable relation tuples as used in the documentation.
Supports various output formats. Especially useful for piping into other commands by using `--format json`.
Ignores comments (starting with `//`) and blank lines.
Parse human readable relation tuples as used in the documentation. Supports various output formats. Especially useful for piping
into other commands by using `--format json`. Ignores comments (starting with `//`) and blank lines.

```
keto relation-tuple parse [flags]
Expand All @@ -39,5 +39,4 @@ keto relation-tuple parse [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
14 changes: 7 additions & 7 deletions docs/keto/cli/keto-relation-tuple.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This file is auto-generated.

To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## keto relation-tuple

Read and manipulate relation tuples
Expand All @@ -27,10 +28,9 @@ Read and manipulate relation tuples

### SEE ALSO

* [keto](keto) - Global and consistent permission and authorization server
* [keto relation-tuple create](keto-relation-tuple-create) - Create relation tuples from JSON files
* [keto relation-tuple delete](keto-relation-tuple-delete) - Delete relation tuples defined in JSON files
* [keto relation-tuple delete-all](keto-relation-tuple-delete-all) - Delete ALL relation tuples matching the relation query.
* [keto relation-tuple get](keto-relation-tuple-get) - Get relation tuples
* [keto relation-tuple parse](keto-relation-tuple-parse) - Parse human readable relation tuples

- [keto](keto) - Global and consistent permission and authorization server
- [keto relation-tuple create](keto-relation-tuple-create) - Create relation tuples from JSON files
- [keto relation-tuple delete](keto-relation-tuple-delete) - Delete relation tuples defined in JSON files
- [keto relation-tuple delete-all](keto-relation-tuple-delete-all) - Delete ALL relation tuples matching the relation query.
- [keto relation-tuple get](keto-relation-tuple-get) - Get relation tuples
- [keto relation-tuple parse](keto-relation-tuple-parse) - Parse human readable relation tuples
Loading