cmd: specify that deployment delete command is ECE specific (#233)

elastic · Mar 26, 2020 · 477efc1 · 477efc1
1 parent 2bfa679
commit 477efc1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/cmd/deployment/delete.go b/cmd/deployment/delete.go
@@ -18,17 +18,18 @@
 package cmddeployment
 
 import (
-	"github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
+	sdkcmdutil "github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/deployment"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
 var deleteCmd = &cobra.Command{
 	Use:     "delete <deployment-id>",
-	Short:   "Deletes a previously stopped deployment from the platform",
-	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
+	Short:   cmdutil.AdminReqDescription("Deletes a previously shutdown deployment"),
+	PreRunE: sdkcmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		res, err := deployment.Delete(deployment.DeleteParams{
 			API:          ecctl.Get().API,

diff --git a/docs/ecctl_deployment.md b/docs/ecctl_deployment.md
@@ -43,7 +43,7 @@ ecctl deployment [flags]
 * [ecctl deployment apm](ecctl_deployment_apm.md)	 - Manages APM deployments
 * [ecctl deployment appsearch](ecctl_deployment_appsearch.md)	 - Manages AppSearch deployments
 * [ecctl deployment create](ecctl_deployment_create.md)	 - Creates a deployment
-* [ecctl deployment delete](ecctl_deployment_delete.md)	 - Deletes a previously stopped deployment from the platform
+* [ecctl deployment delete](ecctl_deployment_delete.md)	 - Deletes a previously shutdown deployment (Available for ECE only)
 * [ecctl deployment elasticsearch](ecctl_deployment_elasticsearch.md)	 - Manages Elasticsearch clusters
 * [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 * [ecctl deployment list](ecctl_deployment_list.md)	 - Lists the platform's deployments

diff --git a/docs/ecctl_deployment_delete.md b/docs/ecctl_deployment_delete.md
@@ -1,10 +1,10 @@
 ## ecctl deployment delete
 
-Deletes a previously stopped deployment from the platform
+Deletes a previously shutdown deployment (Available for ECE only)
 
 ### Synopsis
 
-Deletes a previously stopped deployment from the platform
+Deletes a previously shutdown deployment (Available for ECE only)
 
 ```
 ecctl deployment delete <deployment-id> [flags]