Skip to content

Commit

Permalink
autogen(docs): generate cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 14, 2020
1 parent f01ac17 commit 2b44614
Show file tree
Hide file tree
Showing 25 changed files with 174 additions and 207 deletions.
22 changes: 11 additions & 11 deletions docs/docs/cli/hydra-clients-create.md
Expand Up @@ -9,25 +9,24 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## hydra clients create

Create a new OAuth 2.0 Client

### Synopsis

This command creates an OAuth 2.0 Client which can be used to perform various
OAuth 2.0 Flows like the Authorize Code, Implicit, Refresh flow.
This command creates an OAuth 2.0 Client which can be used to perform various OAuth 2.0 Flows like
the Authorize Code, Implicit, Refresh flow.

ORY Hydra implements the OpenID Connect Dynamic Client registration specification. Most flags are supported by this command
as well.

ORY Hydra implements the OpenID Connect Dynamic Client registration
specification. Most flags are supported by this command as well.
Example:
hydra clients create -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar

Example: hydra clients create -n "my app" -c http://localhost/cb -g
authorization_code -r code -a core,foobar
To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example:
hydra clients create -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username

To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or
"--keybase" flag, for example: hydra clients create -n "my app" -g
client_credentials -r token -a core,foobar --keybase keybase_username

```
hydra clients create [flags]
Expand Down Expand Up @@ -72,4 +71,5 @@ hydra clients create [flags]

### SEE ALSO

- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients

7 changes: 4 additions & 3 deletions docs/docs/cli/hydra-clients-delete.md
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.
-->

## hydra clients delete

Delete an OAuth 2.0 Client
Expand All @@ -18,7 +17,8 @@ Delete an OAuth 2.0 Client

This command deletes one or more OAuth 2.0 Clients by their respective IDs.

Example: hydra clients delete client-1 client-2 client-3
Example:
hydra clients delete client-1 client-2 client-3

```
hydra clients delete <id> [<id>...] [flags]
Expand All @@ -43,4 +43,5 @@ hydra clients delete <id> [<id>...] [flags]

### SEE ALSO

- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients

7 changes: 4 additions & 3 deletions docs/docs/cli/hydra-clients-get.md
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.
-->

## hydra clients get

Get an OAuth 2.0 Client
Expand All @@ -18,7 +17,8 @@ Get an OAuth 2.0 Client

This command retrieves an OAuth 2.0 Clients by its ID.

Example: hydra clients get client-1
Example:
hydra clients get client-1

```
hydra clients get <id> [flags]
Expand All @@ -43,4 +43,5 @@ hydra clients get <id> [flags]

### SEE ALSO

- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients

29 changes: 15 additions & 14 deletions docs/docs/cli/hydra-clients-import.md
@@ -1,38 +1,38 @@
---
id: hydra-clients-import
title: hydra clients import
description:
hydra clients import Import OAuth 2.0 Clients from one or more JSON files
description: hydra clients import Import OAuth 2.0 Clients from one or more JSON files
---

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

## hydra clients import

Import OAuth 2.0 Clients from one or more JSON files

### Synopsis

This command reads in each listed JSON file and imports their contents as OAuth
2.0 Clients.
This command reads in each listed JSON file and imports their contents as OAuth 2.0 Clients.

The format for the JSON file is:

{ "client_id": "...", "client_secret": "...", // ... all other fields of the
OAuth 2.0 Client model are allowed here }
{
"client_id": "...",
"client_secret": "...",
// ... all other fields of the OAuth 2.0 Client model are allowed here
}

Please be aware that this command does not update existing clients. If the client exists already, this command will fail.

Please be aware that this command does not update existing clients. If the
client exists already, this command will fail.
Example:
hydra clients import client-1.json

Example: hydra clients import client-1.json
To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example:
hydra clients import client-1.json --keybase keybase_username

To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or
"--keybase" flag, for example: hydra clients import client-1.json --keybase
keybase_username

```
hydra clients import <path/to/file.json> [<path/to/other/file.json>...] [flags]
Expand Down Expand Up @@ -60,4 +60,5 @@ hydra clients import <path/to/file.json> [<path/to/other/file.json>...] [flags]

### SEE ALSO

- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients

7 changes: 4 additions & 3 deletions docs/docs/cli/hydra-clients-list.md
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.
-->

## hydra clients list

List OAuth 2.0 Clients
Expand All @@ -18,7 +17,8 @@ List OAuth 2.0 Clients

This command list an OAuth 2.0 Clients.

Example: hydra clients list
Example:
hydra clients list

```
hydra clients list [flags]
Expand All @@ -45,4 +45,5 @@ hydra clients list [flags]

### SEE ALSO

- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients

15 changes: 7 additions & 8 deletions docs/docs/cli/hydra-clients.md
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.
-->

## hydra clients

Manage OAuth 2.0 Clients
Expand Down Expand Up @@ -37,10 +36,10 @@ Manage OAuth 2.0 Clients

### SEE ALSO

- [hydra](hydra) - Run and manage ORY Hydra
- [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client
- [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client
- [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client
- [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from
one or more JSON files
- [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients
* [hydra](hydra) - Run and manage ORY Hydra
* [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client
* [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client
* [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client
* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
* [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients

4 changes: 2 additions & 2 deletions docs/docs/cli/hydra-keys-create.md
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.
-->

## hydra keys create

Create a new JSON Web Key Set
Expand Down Expand Up @@ -43,4 +42,5 @@ hydra keys create <set> <key> [flags]

### SEE ALSO

- [hydra keys](hydra-keys) - Manage JSON Web Keys
* [hydra keys](hydra-keys) - Manage JSON Web Keys

4 changes: 2 additions & 2 deletions docs/docs/cli/hydra-keys-delete.md
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.
-->

## hydra keys delete

Delete a new JSON Web Key Set
Expand Down Expand Up @@ -41,4 +40,5 @@ hydra keys delete <set> [flags]

### SEE ALSO

- [hydra keys](hydra-keys) - Manage JSON Web Keys
* [hydra keys](hydra-keys) - Manage JSON Web Keys

4 changes: 2 additions & 2 deletions docs/docs/cli/hydra-keys-get.md
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.
-->

## hydra keys get

Get a new JSON Web Key Set
Expand Down Expand Up @@ -41,4 +40,5 @@ hydra keys get <set> [flags]

### SEE ALSO

- [hydra keys](hydra-keys) - Manage JSON Web Keys
* [hydra keys](hydra-keys) - Manage JSON Web Keys

22 changes: 10 additions & 12 deletions docs/docs/cli/hydra-keys-import.md
@@ -1,17 +1,14 @@
---
id: hydra-keys-import
title: hydra keys import
description:
hydra keys import Imports cryptographic keys of any format to the JSON Web Key
Store
description: hydra keys import Imports cryptographic keys of any format to the JSON Web Key Store
---

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

## hydra keys import

Imports cryptographic keys of any format to the JSON Web Key Store
Expand All @@ -20,15 +17,15 @@ Imports cryptographic keys of any format to the JSON Web Key Store

This command allows you to import cryptographic keys to the JSON Web Key Store.

Currently supported formats are raw JSON Web Keys or PEM/DER encoded data. If
the JSON Web Key Set exists already, the imported keys will be added to that
set. Otherwise, a new set will be created.
Currently supported formats are raw JSON Web Keys or PEM/DER encoded data. If the JSON Web Key Set exists already,
the imported keys will be added to that set. Otherwise, a new set will be created.

Please be aware that importing a private key does not automatically import its public key as well.

Please be aware that importing a private key does not automatically import its
public key as well.
Examples:
hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json
hydra keys import my-set ./path/to/rsa.key ./path/to/rsa.pub

Examples: hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json hydra
keys import my-set ./path/to/rsa.key ./path/to/rsa.pub

```
hydra keys import <set> <file-1> [<file-2> [<file-3 [<...>]]] [flags]
Expand All @@ -54,4 +51,5 @@ hydra keys import <set> <file-1> [<file-2> [<file-3 [<...>]]] [flags]

### SEE ALSO

- [hydra keys](hydra-keys) - Manage JSON Web Keys
* [hydra keys](hydra-keys) - Manage JSON Web Keys

13 changes: 6 additions & 7 deletions docs/docs/cli/hydra-keys.md
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.
-->

## hydra keys

Manage JSON Web Keys
Expand Down Expand Up @@ -37,9 +36,9 @@ Manage JSON Web Keys

### SEE ALSO

- [hydra](hydra) - Run and manage ORY Hydra
- [hydra keys create](hydra-keys-create) - Create a new JSON Web Key Set
- [hydra keys delete](hydra-keys-delete) - Delete a new JSON Web Key Set
- [hydra keys get](hydra-keys-get) - Get a new JSON Web Key Set
- [hydra keys import](hydra-keys-import) - Imports cryptographic keys of any
format to the JSON Web Key Store
* [hydra](hydra) - Run and manage ORY Hydra
* [hydra keys create](hydra-keys-create) - Create a new JSON Web Key Set
* [hydra keys delete](hydra-keys-delete) - Delete a new JSON Web Key Set
* [hydra keys get](hydra-keys-get) - Get a new JSON Web Key Set
* [hydra keys import](hydra-keys-import) - Imports cryptographic keys of any format to the JSON Web Key Store

22 changes: 11 additions & 11 deletions docs/docs/cli/hydra-migrate-sql.md
Expand Up @@ -9,28 +9,27 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## hydra migrate sql

Create SQL schemas and apply migration plans

### Synopsis

Run this command on a fresh SQL installation and when you upgrade Hydra to a new
minor version. For example, upgrading Hydra 0.7.0 to 0.8.0 requires running this
command.
Run this command on a fresh SQL installation and when you upgrade Hydra to a new minor version. For example,
upgrading Hydra 0.7.0 to 0.8.0 requires running this command.

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.

You can read in the database URL using the -e flag, for example: export DSN=...
hydra migrate sql -e
You can read in the database URL using the -e flag, for example:
export DSN=...
hydra migrate sql -e

### WARNING
### WARNING ###

Before running this command on an existing database, create a back up!


```
hydra migrate sql <database-url> [flags]
```
Expand All @@ -52,4 +51,5 @@ hydra migrate sql <database-url> [flags]

### SEE ALSO

- [hydra migrate](hydra-migrate) - Various migration helpers
* [hydra migrate](hydra-migrate) - Various migration helpers

7 changes: 3 additions & 4 deletions docs/docs/cli/hydra-migrate.md
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.
-->

## hydra migrate

Various migration helpers
Expand All @@ -33,6 +32,6 @@ Various migration helpers

### SEE ALSO

- [hydra](hydra) - Run and manage ORY Hydra
- [hydra migrate sql](hydra-migrate-sql) - Create SQL schemas and apply
migration plans
* [hydra](hydra) - Run and manage ORY Hydra
* [hydra migrate sql](hydra-migrate-sql) - Create SQL schemas and apply migration plans

0 comments on commit 2b44614

Please sign in to comment.