styles: format code

ory · Mar 7, 2021 · 88bd548 · 88bd548
1 parent 84e4fe6
commit 88bd548
Show file tree

Hide file tree

Showing 35 changed files with 527 additions and 197 deletions.
diff --git a/docs/docs/cli/hydra-clients-create.md b/docs/docs/cli/hydra-clients-create.md
@@ -9,24 +9,25 @@ 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.
-
-ORY Hydra implements the OpenID Connect Dynamic Client registration specification. Most flags are supported by this command
-as well.
+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.
 
-Example:
- hydra clients create -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar
+ORY Hydra implements the OpenID Connect Dynamic Client registration
+specification. Most flags are supported by this command as well.
 
-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
+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
 
 ```
 hydra clients create [flags]
@@ -74,5 +75,4 @@ hydra clients create [flags]
 
 ### SEE ALSO
 
-* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
-
+- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
diff --git a/docs/docs/cli/hydra-clients-delete.md b/docs/docs/cli/hydra-clients-delete.md
@@ -9,6 +9,7 @@ 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
@@ -17,8 +18,7 @@ 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]
@@ -42,5 +42,4 @@ 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
diff --git a/docs/docs/cli/hydra-clients-get.md b/docs/docs/cli/hydra-clients-get.md
@@ -9,6 +9,7 @@ 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
@@ -17,8 +18,7 @@ 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]
@@ -42,5 +42,4 @@ 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
diff --git a/docs/docs/cli/hydra-clients-import.md b/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
-}
-
-Please be aware that this command does not update existing clients. If the client exists already, this command will fail.
+{ "client_id": "...", "client_secret": "...", // ... all other fields of the
+OAuth 2.0 Client model are allowed here }
 
-Example:
- hydra clients import client-1.json
+Please be aware that this command does not update existing clients. If the
+client exists already, this command will fail.
 
-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
+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
 
 ```
 hydra clients import <path/to/file.json> [<path/to/other/file.json>...] [flags]
@@ -59,5 +59,4 @@ 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
diff --git a/docs/docs/cli/hydra-clients-list.md b/docs/docs/cli/hydra-clients-list.md
@@ -9,6 +9,7 @@ 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
@@ -17,8 +18,7 @@ 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]
@@ -44,5 +44,4 @@ hydra clients list [flags]
 
 ### SEE ALSO
 
-* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
-
+- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
diff --git a/docs/docs/cli/hydra-clients-update.md b/docs/docs/cli/hydra-clients-update.md
@@ -9,6 +9,7 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
+
 ## hydra clients update
 
 Update an entire OAuth 2.0 Client
@@ -17,15 +18,17 @@ Update an entire OAuth 2.0 Client
 
 This command replaces an OAuth 2.0 Client by its ID.
 
-Please be aware that this command replaces the entire client.
-To update only the name, a full client should be provided, for example:
- hydra clients update client-1 -n "my updated app" -c http://localhost/cb -g authorization_code -r code -a core,foobar
-
-If only the name flag (-n "my updated app") is provided, the all other fields are updated to their default values.
+Please be aware that this command replaces the entire client. To update only the
+name, a full client should be provided, for example: hydra clients update
+client-1 -n "my updated 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 update client-1 -n "my updated app" -g client_credentials -r token -a core,foobar --keybase keybase_username
+If only the name flag (-n "my updated app") is provided, the all other fields
+are updated to their default values.
 
+To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or
+"--keybase" flag, for example: hydra clients update client-1 -n "my updated app"
+-g client_credentials -r token -a core,foobar --keybase keybase_username
 
 ```
 hydra clients update <id> [flags]
@@ -72,5 +75,4 @@ hydra clients update <id> [flags]
 
 ### SEE ALSO
 
-* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
-
+- [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients
diff --git a/docs/docs/cli/hydra-clients.md b/docs/docs/cli/hydra-clients.md
@@ -9,6 +9,7 @@ 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
@@ -30,11 +31,12 @@ 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 clients update](hydra-clients-update) - Update an entire OAuth 2.0 Client
-
+- [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 clients update](hydra-clients-update) - Update an entire OAuth 2.0
+ Client
diff --git a/docs/docs/cli/hydra-keys-create.md b/docs/docs/cli/hydra-keys-create.md
@@ -9,6 +9,7 @@ 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
@@ -41,5 +42,4 @@ hydra keys create <set> <key> [flags]
 
 ### SEE ALSO
 
-* [hydra keys](hydra-keys) - Manage JSON Web Keys
-
+- [hydra keys](hydra-keys) - Manage JSON Web Keys
diff --git a/docs/docs/cli/hydra-keys-delete.md b/docs/docs/cli/hydra-keys-delete.md
@@ -9,6 +9,7 @@ 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
@@ -39,5 +40,4 @@ hydra keys delete <set> [flags]
 
 ### SEE ALSO
 
-* [hydra keys](hydra-keys) - Manage JSON Web Keys
-
+- [hydra keys](hydra-keys) - Manage JSON Web Keys
diff --git a/docs/docs/cli/hydra-keys-get.md b/docs/docs/cli/hydra-keys-get.md
@@ -9,6 +9,7 @@ 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
@@ -39,5 +40,4 @@ hydra keys get <set> [flags]
 
 ### SEE ALSO
 
-* [hydra keys](hydra-keys) - Manage JSON Web Keys
-
+- [hydra keys](hydra-keys) - Manage JSON Web Keys
diff --git a/docs/docs/cli/hydra-keys-import.md b/docs/docs/cli/hydra-keys-import.md
@@ -1,14 +1,17 @@
 ---
 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
@@ -17,15 +20,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.
-
-Please be aware that importing a private key does not automatically import its public key as well.
+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.
 
-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
+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
 
 ```
 hydra keys import <set> <file-1> [<file-2> [<file-3 [<...>]]] [flags]
@@ -50,5 +53,4 @@ 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
diff --git a/docs/docs/cli/hydra-keys.md b/docs/docs/cli/hydra-keys.md
@@ -9,6 +9,7 @@ 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
@@ -30,9 +31,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