update describe examples

DiogoFerrao · DiogoFerrao · commit be45bb5bf405 · 2024-05-06T17:38:31.000+01:00
diff --git a/internal/cmd/argus/grafana/describe/describe.go b/internal/cmd/argus/grafana/describe/describe.go
@@ -44,12 +44,12 @@ func NewCmd(p *print.Printer) *cobra.Command {
 			examples.NewExample(
 				`Get details of the Grafana configuration of an Argus instance with ID "xxx"`,
 				"$ stackit argus credentials describe xxx"),
-			examples.NewExample(
-				`Get details of the Grafana configuration of an Argus instance with ID "xxx" in a table format`,
-				"$ stackit argus credentials describe xxx --output-format pretty"),
 			examples.NewExample(
 				`Get details of the Grafana configuration of an Argus instance with ID "xxx" and show the initial admin password`,
-				"$ stackit argus credentials describe xxx --output-format pretty --show-password"),
+				"$ stackit argus credentials describe xxx --show-password"),
+			examples.NewExample(
+				`Get details of the Grafana configuration of an Argus instance with ID "xxx" in JSON format`,
+				"$ stackit argus credentials describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/argus/instance/describe/describe.go b/internal/cmd/argus/instance/describe/describe.go
@@ -38,8 +38,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of an Argus instance with ID "xxx"`,
 				"$ stackit argus instance describe xxx"),
 			examples.NewExample(
-				`Get details of an Argus instance with ID "xxx" in a table format`,
-				"$ stackit argus instance describe xxx --output-format pretty"),
+				`Get details of an Argus instance with ID "xxx" in JSON format`,
+				"$ stackit argus instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/argus/scrape-config/describe/describe.go b/internal/cmd/argus/scrape-config/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a scrape configuration with name "my-config" from Argus instance "xxx"`,
 				"$ stackit argus scrape-config describe my-config --instance-id xxx"),
 			examples.NewExample(
-				`Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in a table format`,
-				"$ stackit argus scrape-config describe my-config --output-format pretty"),
+				`Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in JSON format`,
+				"$ stackit argus scrape-config describe my-config --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/dns/record-set/describe/describe.go b/internal/cmd/dns/record-set/describe/describe.go
@@ -43,8 +43,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of DNS record set with ID "xxx" in zone with ID "yyy"`,
 				"$ stackit dns record-set describe xxx --zone-id yyy"),
 			examples.NewExample(
-				`Get details of DNS record set with ID "xxx" in zone with ID "yyy" in a table format`,
-				"$ stackit dns record-set describe xxx --zone-id yyy --output-format pretty"),
+				`Get details of DNS record set with ID "xxx" in zone with ID "yyy" in JSON format`,
+				"$ stackit dns record-set describe xxx --zone-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/dns/zone/describe/describe.go b/internal/cmd/dns/zone/describe/describe.go
@@ -38,8 +38,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a DNS zone with ID "xxx"`,
 				"$ stackit dns zone describe xxx"),
 			examples.NewExample(
-				`Get details of a DNS zone with ID "xxx" in a table format`,
-				"$ stackit dns zone describe xxx --output-format pretty"),
+				`Get details of a DNS zone with ID "xxx" in JSON format`,
+				"$ stackit dns zone describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/logme/credentials/describe/describe.go b/internal/cmd/logme/credentials/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of credentials with ID "xxx" from instance with ID "yyy"`,
 				"$ stackit logme credentials describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format`,
-				"$ stackit logme credentials describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format`,
+				"$ stackit logme credentials describe xxx --instance-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/logme/instance/describe/describe.go b/internal/cmd/logme/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a LogMe instance with ID "xxx"`,
 				"$ stackit logme instance describe xxx"),
 			examples.NewExample(
-				`Get details of a LogMe instance with ID "xxx" in a table format`,
-				"$ stackit logme instance describe xxx --output-format pretty"),
+				`Get details of a LogMe instance with ID "xxx" in JSON format`,
+				"$ stackit logme instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/mariadb/credentials/describe/describe.go b/internal/cmd/mariadb/credentials/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of credentials with ID "xxx" from instance with ID "yyy"`,
 				"$ stackit mariadb credentials describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format`,
-				"$ stackit mariadb credentials describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format`,
+				"$ stackit mariadb credentials describe xxx --instance-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/mariadb/instance/describe/describe.go b/internal/cmd/mariadb/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a MariaDB instance with ID "xxx"`,
 				"$ stackit mariadb instance describe xxx"),
 			examples.NewExample(
-				`Get details of a MariaDB instance with ID "xxx" in a table format`,
-				"$ stackit mariadb instance describe xxx --output-format pretty"),
+				`Get details of a MariaDB instance with ID "xxx" in JSON format`,
+				"$ stackit mariadb instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/mongodbflex/instance/describe/describe.go b/internal/cmd/mongodbflex/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a MongoDB Flex instance with ID "xxx"`,
 				"$ stackit mongodbflex instance describe xxx"),
 			examples.NewExample(
-				`Get details of a MongoDB Flex instance with ID "xxx" in a table format`,
-				"$ stackit mongodbflex instance describe xxx --output-format pretty"),
+				`Get details of a MongoDB Flex instance with ID "xxx" in JSON format`,
+				"$ stackit mongodbflex instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/mongodbflex/user/describe/describe.go b/internal/cmd/mongodbflex/user/describe/describe.go
@@ -46,8 +46,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a MongoDB Flex user with ID "xxx" of instance with ID "yyy"`,
 				"$ stackit mongodbflex user list xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of a MongoDB Flex user with ID "xxx" of instance with ID "yyy" in table format`,
-				"$ stackit mongodbflex user list xxx --instance-id yyy --output-format pretty"),
+				`Get details of a MongoDB Flex user with ID "xxx" of instance with ID "yyy" in JSON format`,
+				"$ stackit mongodbflex user list xxx --instance-id yyy --output-format json"),
 		),
 		Args: args.SingleArg(userIdArg, utils.ValidateUUID),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/object-storage/bucket/describe/describe.go b/internal/cmd/object-storage/bucket/describe/describe.go
@@ -37,8 +37,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of an Object Storage bucket with name "my-bucket"`,
 				"$ stackit object-storage bucket describe my-bucket"),
 			examples.NewExample(
-				`Get details of an Object Storage bucket with name "my-bucket" in a table format`,
-				"$ stackit object-storage bucket describe my-bucket --output-format pretty"),
+				`Get details of an Object Storage bucket with name "my-bucket" in JSON format`,
+				"$ stackit object-storage bucket describe my-bucket --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/opensearch/credentials/describe/describe.go b/internal/cmd/opensearch/credentials/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of credentials with ID "xxx" from instance with ID "yyy"`,
 				"$ stackit opensearch credentials describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format`,
-				"$ stackit opensearch credentials describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format`,
+				"$ stackit opensearch credentials describe xxx --instance-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/opensearch/instance/describe/describe.go b/internal/cmd/opensearch/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of an OpenSearch instance with ID "xxx"`,
 				"$ stackit opensearch instance describe xxx"),
 			examples.NewExample(
-				`Get details of an OpenSearch instance with ID "xxx" in a table format`,
-				"$ stackit opensearch instance describe xxx --output-format pretty"),
+				`Get details of an OpenSearch instance with ID "xxx" in JSON format`,
+				"$ stackit opensearch instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/postgresflex/backup/describe/describe.go b/internal/cmd/postgresflex/backup/describe/describe.go
@@ -47,8 +47,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a backup with ID "xxx" for a PostgreSQL Flex instance with ID "yyy"`,
 				"$ stackit postgresflex backup describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of a backup with ID "xxx" for a PostgreSQL Flex instance with ID "yyy" in a table format`,
-				"$ stackit postgresflex backup describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of a backup with ID "xxx" for a PostgreSQL Flex instance with ID "yyy" in JSON format`,
+				"$ stackit postgresflex backup describe xxx --instance-id yyy --output-format json"),
 		),
 		Args: args.SingleArg(backupIdArg, nil),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/postgresflex/instance/describe/describe.go b/internal/cmd/postgresflex/instance/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a PostgreSQL Flex instance with ID "xxx"`,
 				"$ stackit postgresflex instance describe xxx"),
 			examples.NewExample(
-				`Get details of a PostgreSQL Flex instance with ID "xxx" in a table format`,
-				"$ stackit postgresflex instance describe xxx --output-format pretty"),
+				`Get details of a PostgreSQL Flex instance with ID "xxx" in JSON format`,
+				"$ stackit postgresflex instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/postgresflex/user/describe/describe.go b/internal/cmd/postgresflex/user/describe/describe.go
@@ -45,8 +45,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a PostgreSQL Flex user with ID "xxx" of instance with ID "yyy"`,
 				"$ stackit postgresflex user list xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of a PostgreSQL Flex user with ID "xxx" of instance with ID "yyy" in table format`,
-				"$ stackit postgresflex user list xxx --instance-id yyy --output-format pretty"),
+				`Get details of a PostgreSQL Flex user with ID "xxx" of instance with ID "yyy" in JSON format`,
+				"$ stackit postgresflex user list xxx --instance-id yyy --output-format json"),
 		),
 		Args: args.SingleArg(userIdArg, nil),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/rabbitmq/credentials/describe/describe.go b/internal/cmd/rabbitmq/credentials/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of credentials with ID "xxx" from instance with ID "yyy"`,
 				"$ stackit rabbitmq credentials describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format`,
-				"$ stackit rabbitmq credentials describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format`,
+				"$ stackit rabbitmq credentials describe xxx --instance-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/rabbitmq/instance/describe/describe.go b/internal/cmd/rabbitmq/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a RabbitMQ instance with ID "xxx"`,
 				"$ stackit rabbitmq instance describe xxx"),
 			examples.NewExample(
-				`Get details of a RabbitMQ instance with ID "xxx" in a table format`,
-				"$ stackit rabbitmq instance describe xxx --output-format pretty"),
+				`Get details of a RabbitMQ instance with ID "xxx" in JSON format`,
+				"$ stackit rabbitmq instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/redis/credentials/describe/describe.go b/internal/cmd/redis/credentials/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of credentials with ID "xxx" from instance with ID "yyy"`,
 				"$ stackit redis credentials describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format`,
-				"$ stackit redis credentials describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format`,
+				"$ stackit redis credentials describe xxx --instance-id yyy --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/redis/instance/describe/describe.go b/internal/cmd/redis/instance/describe/describe.go
@@ -40,8 +40,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a Redis instance with ID "xxx"`,
 				"$ stackit redis instance describe xxx"),
 			examples.NewExample(
-				`Get details of a Redis instance with ID "xxx" in a table format`,
-				"$ stackit redis instance describe xxx --output-format pretty"),
+				`Get details of a Redis instance with ID "xxx" in JSON format`,
+				"$ stackit redis instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/secrets-manager/instance/describe/describe.go b/internal/cmd/secrets-manager/instance/describe/describe.go
@@ -39,8 +39,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a Secrets Manager instance with ID "xxx"`,
 				"$ stackit secrets-manager instance describe xxx"),
 			examples.NewExample(
-				`Get details of a Secrets Manager instance with ID "xxx" in a table format`,
-				"$ stackit secrets-manager instance describe xxx --output-format pretty"),
+				`Get details of a Secrets Manager instance with ID "xxx" in JSON format`,
+				"$ stackit secrets-manager instance describe xxx --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/secrets-manager/user/describe/describe.go b/internal/cmd/secrets-manager/user/describe/describe.go
@@ -42,8 +42,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of a Secrets Manager user with ID "xxx" of instance with ID "yyy"`,
 				"$ stackit secrets-manager user describe xxx --instance-id yyy"),
 			examples.NewExample(
-				`Get details of a Secrets Manager user with ID "xxx" of instance with ID "yyy" in table format`,
-				"$ stackit secrets-manager user describe xxx --instance-id yyy --output-format pretty"),
+				`Get details of a Secrets Manager user with ID "xxx" of instance with ID "yyy" in JSON format`,
+				"$ stackit secrets-manager user describe xxx --instance-id yyy --output-format json"),
 		),
 		Args: args.SingleArg(userIdArg, utils.ValidateUUID),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/ske/cluster/describe/describe.go b/internal/cmd/ske/cluster/describe/describe.go
@@ -37,8 +37,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of an SKE cluster with name "my-cluster"`,
 				"$ stackit ske cluster describe my-cluster"),
 			examples.NewExample(
-				`Get details of an SKE cluster with name "my-cluster" in a table format`,
-				"$ stackit ske cluster describe my-cluster --output-format pretty"),
+				`Get details of an SKE cluster with name "my-cluster" in JSON format`,
+				"$ stackit ske cluster describe my-cluster --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
diff --git a/internal/cmd/ske/credentials/describe/describe.go b/internal/cmd/ske/credentials/describe/describe.go
@@ -44,8 +44,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				`Get details of the credentials associated to the SKE cluster with name "my-cluster"`,
 				"$ stackit ske credentials describe my-cluster"),
 			examples.NewExample(
-				`Get details of the credentials associated to the SKE cluster with name "my-cluster" in a table format`,
-				"$ stackit ske credentials describe my-cluster --output-format pretty"),
+				`Get details of the credentials associated to the SKE cluster with name "my-cluster" in JSON format`,
+				"$ stackit ske credentials describe my-cluster --output-format json"),
 		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
