Update flag description (#477)

* Update flag description * Update docs
stackitcloud · Sep 12, 2024 · 425a9a2 · 425a9a2
1 parent fd82981
commit 425a9a2
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/stackit_config_set.md b/docs/stackit_config_set.md
@@ -55,7 +55,7 @@ stackit config set [flags]
       --session-time-limit string                                  Maximum time before authentication is required again. After this time, you will be prompted to login again to execute commands that require authentication. Can't be larger than 24h. Requires authentication after being set to take effect. Examples: 3h, 5h30m40s (BETA: currently values greater than 2h have no effect)
       --ske-custom-endpoint string                                 SKE API base URL, used in calls to this API
       --sqlserverflex-custom-endpoint string                       SQLServer Flex API base URL, used in calls to this API
-      --token-custom-endpoint string                               Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
+      --token-custom-endpoint string                               Custom token endpoint of the Service Account API, which is used to request access tokens when the service account authentication is activated. Not relevant for user authentication.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/stackit_config_unset.md b/docs/stackit_config_unset.md
@@ -55,7 +55,7 @@ stackit config unset [flags]
       --session-time-limit                                  Maximum time before authentication is required again. If unset, defaults to 2h
       --ske-custom-endpoint                                 SKE API base URL. If unset, uses the default base URL
       --sqlserverflex-custom-endpoint                       SQLServer Flex API base URL. If unset, uses the default base URL
-      --token-custom-endpoint                               Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
+      --token-custom-endpoint                               Custom token endpoint of the Service Account API, which is used to request access tokens when the service account authentication is activated. Not relevant for user authentication.
       --verbosity                                           Verbosity of the CLI
 ```
 

diff --git a/internal/cmd/config/set/set.go b/internal/cmd/config/set/set.go
@@ -155,7 +155,7 @@ func configureFlags(cmd *cobra.Command) {
 	cmd.Flags().String(skeCustomEndpointFlag, "", "SKE API base URL, used in calls to this API")
 	cmd.Flags().String(sqlServerFlexCustomEndpointFlag, "", "SQLServer Flex API base URL, used in calls to this API")
 	cmd.Flags().String(iaasCustomEndpointFlag, "", "IaaS API base URL, used in calls to this API")
-	cmd.Flags().String(tokenCustomEndpointFlag, "", "Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated")
+	cmd.Flags().String(tokenCustomEndpointFlag, "", "Custom token endpoint of the Service Account API, which is used to request access tokens when the service account authentication is activated. Not relevant for user authentication.")
 
 	err := viper.BindPFlag(config.SessionTimeLimitKey, cmd.Flags().Lookup(sessionTimeLimitFlag))
 	cobra.CheckErr(err)

diff --git a/internal/cmd/config/unset/unset.go b/internal/cmd/config/unset/unset.go
@@ -240,7 +240,7 @@ func configureFlags(cmd *cobra.Command) {
 	cmd.Flags().Bool(skeCustomEndpointFlag, false, "SKE API base URL. If unset, uses the default base URL")
 	cmd.Flags().Bool(sqlServerFlexCustomEndpointFlag, false, "SQLServer Flex API base URL. If unset, uses the default base URL")
 	cmd.Flags().Bool(iaasCustomEndpointFlag, false, "IaaS API base URL. If unset, uses the default base URL")
-	cmd.Flags().Bool(tokenCustomEndpointFlag, false, "Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated")
+	cmd.Flags().Bool(tokenCustomEndpointFlag, false, "Custom token endpoint of the Service Account API, which is used to request access tokens when the service account authentication is activated. Not relevant for user authentication.")
 }
 
 func parseInput(p *print.Printer, cmd *cobra.Command) *inputModel {