Skip to content

Commit b52cf4f

Browse files
ory-botory-bot
committed
autogen(docs): generate cli docs
1 parent 5c6fb3b commit b52cf4f

28 files changed

+191
-171
lines changed

‎docs/hydra/cli/hydra-clients-create.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,24 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients create
1413

1514
Create a new OAuth 2.0 Client
1615

1716
### Synopsis
1817

19-
This command creates an OAuth 2.0 Client which can be used to perform various OAuth 2.0 Flows like the Authorize Code, Implicit,
20-
Refresh flow.
18+
This command creates an OAuth 2.0 Client which can be used to perform various OAuth 2.0 Flows like
19+
the Authorize Code, Implicit, Refresh flow.
20+
21+
Ory Hydra implements the OpenID Connect Dynamic Client registration specification. Most flags are supported by this command
22+
as well.
2123

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

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

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

3031
```
3132
hydra clients create [flags]
@@ -73,4 +74,5 @@ hydra clients create [flags]
7374

7475
### SEE ALSO
7576

76-
- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
77+
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
78+

‎docs/hydra/cli/hydra-clients-delete.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients delete
1413

1514
Delete an OAuth 2.0 Client
@@ -18,7 +17,8 @@ Delete an OAuth 2.0 Client
1817

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

21-
Example: hydra clients delete client-1 client-2 client-3
20+
Example:
21+
hydra clients delete client-1 client-2 client-3
2222

2323
```
2424
hydra clients delete <id> [<id>...] [flags]
@@ -42,4 +42,5 @@ hydra clients delete <id> [<id>...] [flags]
4242

4343
### SEE ALSO
4444

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

‎docs/hydra/cli/hydra-clients-get.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients get
1413

1514
Get an OAuth 2.0 Client
@@ -18,7 +17,8 @@ Get an OAuth 2.0 Client
1817

1918
This command retrieves an OAuth 2.0 Clients by its ID.
2019

21-
Example: hydra clients get client-1
20+
Example:
21+
hydra clients get client-1
2222

2323
```
2424
hydra clients get <id> [flags]
@@ -42,4 +42,5 @@ hydra clients get <id> [flags]
4242

4343
### SEE ALSO
4444

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

‎docs/hydra/cli/hydra-clients-import.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients import
1413

1514
Imports OAuth 2.0 Clients from one or more JSON files to the JSON Web Key Store
@@ -18,13 +17,15 @@ Imports OAuth 2.0 Clients from one or more JSON files to the JSON Web Key Store
1817

1918
This command allows you to import OAuth 2.0 Clients from one or more JSON files to the JSON Web Key Store.
2019

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

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

26-
Examples: hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json hydra keys import my-set ./path/to/rsa.key
27-
./path/to/rsa.pub --default-key-id cae6b214-fb1e-4ebc-9019-95286a62eabc
25+
Examples:
26+
hydra keys import my-set ./path/to/jwk.json ./path/to/jwk-2.json
27+
hydra keys import my-set ./path/to/rsa.key ./path/to/rsa.pub --default-key-id cae6b214-fb1e-4ebc-9019-95286a62eabc
28+
2829

2930
```
3031
hydra clients import <set> <file-1> [<file-2> [<file-3 [<...>]]] [flags]
@@ -50,4 +51,5 @@ hydra clients import <set> <file-1> [<file-2> [<file-3 [<...>]]] [flags]
5051

5152
### SEE ALSO
5253

53-
- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
54+
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
55+

‎docs/hydra/cli/hydra-clients-list.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients list
1413

1514
List OAuth 2.0 Clients
@@ -18,7 +17,8 @@ List OAuth 2.0 Clients
1817

1918
This command list an OAuth 2.0 Clients.
2019

21-
Example: hydra clients list
20+
Example:
21+
hydra clients list
2222

2323
```
2424
hydra clients list [flags]
@@ -44,4 +44,5 @@ hydra clients list [flags]
4444

4545
### SEE ALSO
4646

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

‎docs/hydra/cli/hydra-clients-update.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients update
1413

1514
Update an entire OAuth 2.0 Client
@@ -18,15 +17,15 @@ Update an entire OAuth 2.0 Client
1817

1918
This command replaces an OAuth 2.0 Client by its ID.
2019

21-
Please be aware that this command replaces the entire client. To update only the name, a full client should be provided, for
22-
example: hydra clients update client-1 -n &#34;my updated app&#34; -c http://localhost/cb -g authorization_code -r code -a
23-
core,foobar
20+
Please be aware that this command replaces the entire client.
21+
To update only the name, a full client should be provided, for example:
22+
hydra clients update client-1 -n &#34;my updated app&#34; -c http://localhost/cb -g authorization_code -r code -a core,foobar
2423

2524
If only the name flag (-n &#34;my updated app&#34;) is provided, the all other fields are updated to their default values.
2625

27-
To encrypt auto generated client secret, use &#34;--pgp-key&#34;, &#34;--pgp-key-url&#34; or &#34;--keybase&#34; flag, for
28-
example: hydra clients update client-1 -n &#34;my updated app&#34; -g client_credentials -r token -a core,foobar --keybase
29-
keybase_username
26+
To encrypt auto generated client secret, use &#34;--pgp-key&#34;, &#34;--pgp-key-url&#34; or &#34;--keybase&#34; flag, for example:
27+
hydra clients update client-1 -n &#34;my updated app&#34; -g client_credentials -r token -a core,foobar --keybase keybase_username
28+
3029

3130
```
3231
hydra clients update <id> [flags]
@@ -73,4 +72,5 @@ hydra clients update <id> [flags]
7372

7473
### SEE ALSO
7574

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

‎docs/hydra/cli/hydra-clients.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra clients
1413

1514
Manage OAuth 2.0 Clients
@@ -27,13 +26,14 @@ Manage OAuth 2.0 Clients
2726

2827
### SEE ALSO
2928

30-
- [hydra](hydra) - Run and manage Ory Hydra
31-
- [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client
32-
- [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client
33-
- [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client
34-
- [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
35-
- [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
36-
- [hydra clients import](hydra-clients-import) - Imports OAuth 2.0 Clients from one or more JSON files to the JSON Web Key Store
37-
- [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
38-
- [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients
39-
- [hydra clients update](hydra-clients-update) - Update an entire OAuth 2.0 Client
29+
* [hydra](hydra) - Run and manage Ory Hydra
30+
* [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client
31+
* [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client
32+
* [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client
33+
* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
34+
* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
35+
* [hydra clients import](hydra-clients-import) - Imports OAuth 2.0 Clients from one or more JSON files to the JSON Web Key Store
36+
* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files
37+
* [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients
38+
* [hydra clients update](hydra-clients-update) - Update an entire OAuth 2.0 Client
39+

‎docs/hydra/cli/hydra-janitor.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,55 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra janitor
1413

1514
Clean the database of old tokens, login/consent requests and jwt grant issuers
1615

1716
### Synopsis
1817

19-
This command will cleanup any expired oauth2 tokens as well as login/consent requests. This will select records to delete with a
20-
limit and delete records in batch to ensure that no table locking issues arise in big production databases.
18+
This command will cleanup any expired oauth2 tokens as well as login/consent requests.
19+
This will select records to delete with a limit and delete records in batch to ensure that no table locking issues arise in big production databases.
2120

22-
### Warning
21+
### Warning ###
2322

2423
This command is in beta. Proceed with caution!
2524

26-
This is a destructive command and will purge data directly from the database. Please use this command with caution if you need to
27-
keep historic data for any reason.
25+
This is a destructive command and will purge data directly from the database.
26+
Please use this command with caution if you need to keep historic data for any reason.
2827

2928
###############
3029

3130
Janitor can be used in several ways.
3231

33-
1. By passing the database connection string (DSN) as an argument Pass the database url (dsn) as an argument to janitor. E.g.
34-
janitor &lt;database-url&gt;
35-
2. By passing the DSN as an environment variable
32+
1. By passing the database connection string (DSN) as an argument
33+
Pass the database url (dsn) as an argument to janitor. E.g. janitor &lt;database-url&gt;
34+
2. By passing the DSN as an environment variable
3635

37-
export DSN=...
38-
janitor -e
36+
export DSN=...
37+
janitor -e
3938

40-
3. By passing a configuration file containing the DSN janitor -c /path/to/conf.yml
41-
4. Extra _optional_ parameters can also be added such as
39+
3. By passing a configuration file containing the DSN
40+
janitor -c /path/to/conf.yml
41+
4. Extra *optional* parameters can also be added such as
4242

43-
janitor --keep-if-younger 23h --access-lifespan 1h --refresh-lifespan 40h --consent-request-lifespan 10m &lt;database-url&gt;
43+
janitor --keep-if-younger 23h --access-lifespan 1h --refresh-lifespan 40h --consent-request-lifespan 10m &lt;database-url&gt;
4444

45-
5. Running only a certain cleanup
45+
5. Running only a certain cleanup
4646

47-
janitor --tokens &lt;database-url&gt;
47+
janitor --tokens &lt;database-url&gt;
4848

49-
or
49+
or
5050

51-
janitor --requests &lt;database-url&gt;
51+
janitor --requests &lt;database-url&gt;
5252

5353
or
5454

55-
janitor --grants &lt;database-url&gt;
55+
janitor --grants &lt;database-url&gt;
5656

57-
or any combination of them
57+
or any combination of them
58+
59+
janitor --tokens --requests --grants &lt;database-url&gt;
5860

59-
janitor --tokens --requests --grants &lt;database-url&gt;
6061

6162
```
6263
hydra janitor [<database-url>] [flags]
@@ -81,4 +82,5 @@ hydra janitor [<database-url>] [flags]
8182

8283
### SEE ALSO
8384

84-
- [hydra](hydra) - Run and manage Ory Hydra
85+
* [hydra](hydra) - Run and manage Ory Hydra
86+

‎docs/hydra/cli/hydra-keys-create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra keys create
1413

1514
Create a new JSON Web Key Set
@@ -38,4 +37,5 @@ hydra keys create <set> <key> [flags]
3837

3938
### SEE ALSO
4039

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

‎docs/hydra/cli/hydra-keys-delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This file is auto-generated.
99
1010
To improve this file please make your change against the appropriate "./cmd/*.go" file.
1111
-->
12-
1312
## hydra keys delete
1413

1514
Delete a new JSON Web Key Set
@@ -36,4 +35,5 @@ hydra keys delete <set> [flags]
3635

3736
### SEE ALSO
3837

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

0 commit comments

Comments
 (0)