DXCDT-271: Fix generated docs

Makefile

@@ -74,7 +74,7 @@ $(GO_BIN)/auth0:
 .PHONY: docs docs-start docs-clean
 
 docs: docs-clean ## Build the documentation
-	@go run ./cmd/build_doc
+	@go run ./cmd/doc-gen
 	@mv ./docs/auth0.md ./docs/index.md
 
 docs-start: ## Start the doc site locally for testing purposes

cmd/build_doc/main.go → cmd/doc-gen/main.go

@@ -1,12 +1,13 @@
 package main
 
 import (
+	"log"
+
 	"github.com/auth0/auth0-cli/internal/cli"
 )
 
 func main() {
-	err := cli.BuildDoc()
-	if err != nil {
-		panic(err)
+	if err := cli.GenerateDocs(); err != nil {
+		log.Fatal(err)
 	}
 }

docs/auth0_actions.md

@@ -19,7 +19,6 @@ Manage resources for actions.
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_create.md

@@ -29,6 +29,7 @@ auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=val
   -c, --code string                 Code content for the action.
   -d, --dependency stringToString   Third party npm module, and it version, that the action depends on. (default [])
   -h, --help                        help for create
+      --json                        Output in json format.
   -n, --name string                 Name of the action.
   -s, --secret stringToString       Secret to be used in the action. (default [])
   -t, --trigger string              Trigger of the action. At this time, an action can only target a single trigger at a time.
@@ -38,7 +39,6 @@ auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=val
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_delete.md

@@ -31,7 +31,6 @@ auth0 actions delete <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_deploy.md

@@ -24,13 +24,13 @@ auth0 actions deploy <id>
 
 ```
   -h, --help   help for deploy
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_list.md

@@ -25,13 +25,13 @@ auth0 actions ls
 
 ```
   -h, --help   help for list
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_open.md

@@ -29,7 +29,6 @@ auth0 actions open <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_show.md

@@ -24,13 +24,13 @@ auth0 actions show <id>
 
 ```
   -h, --help   help for show
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_actions_update.md

@@ -29,6 +29,7 @@ auth0 actions update <id> -n myaction -t post-login -d "lodash=4.0.0" -s "API_KE
   -c, --code string                 Code content for the action.
   -d, --dependency stringToString   Third party npm module, and it version, that the action depends on. (default [])
   -h, --help                        help for update
+      --json                        Output in json format.
   -n, --name string                 Name of the action.
   -s, --secret stringToString       Secret to be used in the action. (default [])
   -t, --trigger string              Trigger of the action. At this time, an action can only target a single trigger at a time.
@@ -38,7 +39,6 @@ auth0 actions update <id> -n myaction -t post-login -d "lodash=4.0.0" -s "API_KE
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_api.md

@@ -43,7 +43,6 @@ cat data.json | auth0 api post clients
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis.md

@@ -19,7 +19,6 @@ Manage resources for APIs.
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_create.md

@@ -28,6 +28,7 @@ auth0 apis create -n myapi -e 6100 --offline-access=true
 ```
   -h, --help                 help for create
   -i, --identifier string    Identifier of the API. Cannot be changed once set.
+      --json                 Output in json format.
   -n, --name string          Name of the API.
   -o, --offline-access       Whether Refresh Tokens can be issued for this API (true) or not (false).
   -s, --scopes strings       Comma-separated list of scopes (permissions).
@@ -38,7 +39,6 @@ auth0 apis create -n myapi -e 6100 --offline-access=true
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_delete.md

@@ -31,7 +31,6 @@ auth0 apis delete <id|audience>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_list.md

@@ -26,14 +26,14 @@ auth0 apis ls -n 100
 
 ```
   -h, --help         help for list
+      --json         Output in json format.
   -n, --number int   Number of apps to retrieve (default 50)
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_open.md

@@ -30,7 +30,6 @@ auth0 apis open <id|audience>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_scopes.md

@@ -19,7 +19,6 @@ Manage resources for API scopes.
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_scopes_list.md

@@ -24,13 +24,13 @@ auth0 apis scopes ls <id|audience>
 
 ```
   -h, --help   help for list
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_show.md

@@ -24,13 +24,13 @@ auth0 apis show <id|audience>
 
 ```
   -h, --help   help for show
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apis_update.md

@@ -27,6 +27,7 @@ auth0 apis update -n myapi -e 6100 --offline-access=true
 
 ```
   -h, --help                 help for update
+      --json                 Output in json format.
   -n, --name string          Name of the API.
   -o, --offline-access       Whether Refresh Tokens can be issued for this API (true) or not (false).
   -s, --scopes strings       Comma-separated list of scopes (permissions).
@@ -37,7 +38,6 @@ auth0 apis update -n myapi -e 6100 --offline-access=true
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps.md

@@ -19,7 +19,6 @@ Manage resources for applications.
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_create.md

@@ -30,6 +30,7 @@ auth0 apps create -n myapp -t [native|spa|regular|m2m] --description <descriptio
   -d, --description string    Description of the application. Max character count is 140.
   -g, --grants strings        List of grant types supported for this application. Can include code, implicit, refresh-token, credentials, password, password-realm, mfa-oob, mfa-otp, mfa-recovery-code, and device-code.
   -h, --help                  help for create
+      --json                  Output in json format.
   -l, --logout-urls strings   Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains.
   -n, --name string           Name of the application.
   -o, --origins strings       Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs.
@@ -46,7 +47,6 @@ auth0 apps create -n myapp -t [native|spa|regular|m2m] --description <descriptio
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_delete.md

@@ -31,7 +31,6 @@ auth0 apps delete <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_list.md

@@ -26,6 +26,7 @@ auth0 apps ls -n 100
 
 ```
   -h, --help         help for list
+      --json         Output in json format.
   -n, --number int   Number of apps to retrieve (default 50)
   -r, --reveal       Display the Client Secret as part of the command output.
 ```
@@ -34,7 +35,6 @@ auth0 apps ls -n 100
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_open.md

@@ -29,7 +29,6 @@ auth0 apps open <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_show.md

@@ -24,14 +24,14 @@ auth0 apps show <id>
 
 ```
   -h, --help     help for show
+      --json     Output in json format.
   -r, --reveal   Display the Client Secret as part of the command output.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_update.md

@@ -29,6 +29,7 @@ auth0 apps update <id> -n myapp --type [native|spa|regular|m2m]
   -d, --description string    Description of the application. Max character count is 140.
   -g, --grants strings        List of grant types supported for this application. Can include code, implicit, refresh-token, credentials, password, password-realm, mfa-oob, mfa-otp, mfa-recovery-code, and device-code.
   -h, --help                  help for update
+      --json                  Output in json format.
   -l, --logout-urls strings   Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains.
   -n, --name string           Name of the application.
   -o, --origins strings       Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs.
@@ -45,7 +46,6 @@ auth0 apps update <id> -n myapp --type [native|spa|regular|m2m]
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_apps_use.md

@@ -30,7 +30,6 @@ auth0 apps use <client-id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_completion.md

@@ -63,7 +63,6 @@ auth0 completion
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_domains.md

@@ -19,7 +19,6 @@ Manage custom domains.
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_domains_create.md

@@ -26,6 +26,7 @@ auth0 domains create <id>
   -d, --domain string         Domain name.
   -h, --help                  help for create
   -i, --ip-header string      The HTTP header to fetch the client's IP address.
+      --json                  Output in json format.
   -p, --policy string         The TLS version policy. Can be either 'compatible' or 'recommended'.
   -t, --type string           Custom domain provisioning type. Must be 'auth0' for Auth0-managed certs or 'self' for self-managed certs.
   -v, --verification string   Custom domain verification method. Must be 'txt'.
@@ -35,7 +36,6 @@ auth0 domains create <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_domains_delete.md

@@ -31,7 +31,6 @@ auth0 domains delete <id>
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.

docs/auth0_domains_list.md

@@ -25,13 +25,13 @@ auth0 domains ls
 
 ```
   -h, --help   help for list
+      --json   Output in json format.
 ```
 
 ### Options inherited from parent commands
 
 ```
       --debug           Enable debug mode.
-      --json            Output in json format.
       --no-color        Disable colors.
       --no-input        Disable interactivity.
       --tenant string   Specific tenant to use.