autogen(docs): generate cli docs

ory · Oct 10, 2024 · 172cdc0 · 172cdc0
1 parent 4926ae4
commit 172cdc0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/hydra/cli/hydra-perform-authorization-code.md b/docs/hydra/cli/hydra-perform-authorization-code.md
@@ -1,7 +1,7 @@
 ---
 id: hydra-perform-authorization-code
 title: hydra perform authorization-code
-description: hydra perform authorization-code An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
+description: hydra perform authorization-code Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
 ---
 
 <!--
@@ -11,11 +11,11 @@ To improve this file please make your change against the appropriate "./cmd/*.go
 -->
 ## hydra perform authorization-code
 
-An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
+Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
 
 ### Synopsis
 
-Starts an exemplary web server that acts as an OAuth 2.0 Client performing the Authorize Code Flow.
+Starts an example web server that acts as an OAuth 2.0 Client performing the Authorize Code Flow.
 This command will help you to see if Ory Hydra has been configured properly.
 
 This command must not be used for anything else than manual testing or demo purposes. The server will terminate on error
@@ -40,13 +40,14 @@ hydra perform authorization-code --client-id ... --client-secret ...
       --client-secret string   Use the provided OAuth 2.0 Client Secret, defaults to environment variable OAUTH2_CLIENT_SECRET
   -h, --help                   help for authorization-code
       --https                  Sets up HTTPS for the endpoint using a self-signed certificate which is re-generated every time you start this command
-      --max-age int            Set the OpenID Connect max_age parameter
+      --max-age int            Set the OpenID Connect max_age parameter. -1 means no max_age parameter will be used. (default -1)
       --no-open                Do not open the browser window automatically
       --no-shutdown            Do not terminate on success/error. State and nonce will be regenerated when auth flow has completed (either due to an error or success).
   -p, --port int               The port on which the server should run (default 4446)
       --prompt strings         Set the OpenID Connect prompt parameter
       --redirect string        Force a redirect url
       --scope strings          Request OAuth2 scope (default [offline,openid])
+      --skip                   Skip login and/or consent steps if possible. Only effective if you have configured the Login and Consent UI URLs to point to this server.
       --state string           Force a state value (insecure)
       --token-url endpoint     Usually it is enough to specify the endpoint flag, but if you want to force the token url, use this flag
 ```

diff --git a/docs/hydra/cli/hydra-perform.md b/docs/hydra/cli/hydra-perform.md
@@ -27,6 +27,6 @@ Perform OAuth 2.0 Flows
 ### SEE ALSO
 
 * [hydra](hydra)	 - Run and manage Ory Hydra
-* [hydra perform authorization-code](hydra-perform-authorization-code)	 - An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
+* [hydra perform authorization-code](hydra-perform-authorization-code)	 - Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow
 * [hydra perform client-credentials](hydra-perform-client-credentials)	 - Perform the OAuth2 Client Credentials Flow