Skip to content

Commit 758acb2

Browse files
authored
Make "pretty" the default output format for describe commands (#289)
* initial implementation * address PR comments * update describe examples * generate docs
1 parent 7f0388e commit 758acb2

File tree

51 files changed

+346
-350
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+346
-350
lines changed

docs/stackit_argus_grafana_describe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ stackit argus grafana describe INSTANCE_ID [flags]
1818
Get details of the Grafana configuration of an Argus instance with ID "xxx"
1919
$ stackit argus credentials describe xxx
2020
21-
Get details of the Grafana configuration of an Argus instance with ID "xxx" in a table format
22-
$ stackit argus credentials describe xxx --output-format pretty
23-
2421
Get details of the Grafana configuration of an Argus instance with ID "xxx" and show the initial admin password
25-
$ stackit argus credentials describe xxx --output-format pretty --show-password
22+
$ stackit argus credentials describe xxx --show-password
23+
24+
Get details of the Grafana configuration of an Argus instance with ID "xxx" in JSON format
25+
$ stackit argus credentials describe xxx --output-format json
2626
```
2727

2828
### Options

docs/stackit_argus_instance_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit argus instance describe INSTANCE_ID [flags]
1616
Get details of an Argus instance with ID "xxx"
1717
$ stackit argus instance describe xxx
1818
19-
Get details of an Argus instance with ID "xxx" in a table format
20-
$ stackit argus instance describe xxx --output-format pretty
19+
Get details of an Argus instance with ID "xxx" in JSON format
20+
$ stackit argus instance describe xxx --output-format json
2121
```
2222

2323
### Options

docs/stackit_argus_scrape-config_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit argus scrape-config describe JOB_NAME [flags]
1616
Get details of a scrape configuration with name "my-config" from Argus instance "xxx"
1717
$ stackit argus scrape-config describe my-config --instance-id xxx
1818
19-
Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in a table format
20-
$ stackit argus scrape-config describe my-config --output-format pretty
19+
Get details of a scrape configuration with name "my-config" from Argus instance "xxx" in JSON format
20+
$ stackit argus scrape-config describe my-config --output-format json
2121
```
2222

2323
### Options

docs/stackit_dns_record-set_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit dns record-set describe RECORD_SET_ID [flags]
1616
Get details of DNS record set with ID "xxx" in zone with ID "yyy"
1717
$ stackit dns record-set describe xxx --zone-id yyy
1818
19-
Get details of DNS record set with ID "xxx" in zone with ID "yyy" in a table format
20-
$ stackit dns record-set describe xxx --zone-id yyy --output-format pretty
19+
Get details of DNS record set with ID "xxx" in zone with ID "yyy" in JSON format
20+
$ stackit dns record-set describe xxx --zone-id yyy --output-format json
2121
```
2222

2323
### Options

docs/stackit_dns_zone_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit dns zone describe ZONE_ID [flags]
1616
Get details of a DNS zone with ID "xxx"
1717
$ stackit dns zone describe xxx
1818
19-
Get details of a DNS zone with ID "xxx" in a table format
20-
$ stackit dns zone describe xxx --output-format pretty
19+
Get details of a DNS zone with ID "xxx" in JSON format
20+
$ stackit dns zone describe xxx --output-format json
2121
```
2222

2323
### Options

docs/stackit_logme_credentials_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit logme credentials describe CREDENTIALS_ID [flags]
1616
Get details of credentials with ID "xxx" from instance with ID "yyy"
1717
$ stackit logme credentials describe xxx --instance-id yyy
1818
19-
Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format
20-
$ stackit logme credentials describe xxx --instance-id yyy --output-format pretty
19+
Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format
20+
$ stackit logme credentials describe xxx --instance-id yyy --output-format json
2121
```
2222

2323
### Options

docs/stackit_logme_instance_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit logme instance describe INSTANCE_ID [flags]
1616
Get details of a LogMe instance with ID "xxx"
1717
$ stackit logme instance describe xxx
1818
19-
Get details of a LogMe instance with ID "xxx" in a table format
20-
$ stackit logme instance describe xxx --output-format pretty
19+
Get details of a LogMe instance with ID "xxx" in JSON format
20+
$ stackit logme instance describe xxx --output-format json
2121
```
2222

2323
### Options

docs/stackit_mariadb_credentials_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit mariadb credentials describe CREDENTIALS_ID [flags]
1616
Get details of credentials with ID "xxx" from instance with ID "yyy"
1717
$ stackit mariadb credentials describe xxx --instance-id yyy
1818
19-
Get details of credentials with ID "xxx" from instance with ID "yyy" in a table format
20-
$ stackit mariadb credentials describe xxx --instance-id yyy --output-format pretty
19+
Get details of credentials with ID "xxx" from instance with ID "yyy" in JSON format
20+
$ stackit mariadb credentials describe xxx --instance-id yyy --output-format json
2121
```
2222

2323
### Options

docs/stackit_mariadb_instance_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit mariadb instance describe INSTANCE_ID [flags]
1616
Get details of a MariaDB instance with ID "xxx"
1717
$ stackit mariadb instance describe xxx
1818
19-
Get details of a MariaDB instance with ID "xxx" in a table format
20-
$ stackit mariadb instance describe xxx --output-format pretty
19+
Get details of a MariaDB instance with ID "xxx" in JSON format
20+
$ stackit mariadb instance describe xxx --output-format json
2121
```
2222

2323
### Options

docs/stackit_mongodbflex_instance_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ stackit mongodbflex instance describe INSTANCE_ID [flags]
1616
Get details of a MongoDB Flex instance with ID "xxx"
1717
$ stackit mongodbflex instance describe xxx
1818
19-
Get details of a MongoDB Flex instance with ID "xxx" in a table format
20-
$ stackit mongodbflex instance describe xxx --output-format pretty
19+
Get details of a MongoDB Flex instance with ID "xxx" in JSON format
20+
$ stackit mongodbflex instance describe xxx --output-format json
2121
```
2222

2323
### Options

0 commit comments

Comments
 (0)