Skip to content

Commit 7bc579d

Browse files
DOCSP-11648 update for simplified output by default (#183)
* DOCSP-11648 update for simplified output by default * DOCSP-11648 updates for copy review feedback * DOCSP-11648 updates for tech review feedback DOCSP-11648 self-review
1 parent e525234 commit 7bc579d

File tree

144 files changed

+415
-392
lines changed

Some content is hidden

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

144 files changed

+415
-392
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
The command prints the following fields in |json| format to the terminal if
1+
The command prints the following fields in the specified format to the terminal if
22
the command succeeds. If the command prints an error, see
33
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.

source/includes/extracts-basic-options.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ref: fact-basic-options-output
22
content: |
3-
Command output format. Value must be ``json``. If omitted, defaults to
4-
``json``.
3+
Command output format. Specify ``json`` for output in |json| format. If
4+
omitted, each command returns output in the default format.
55
---
66
ref: fact-basic-options-profile
77
content: |

source/reference/atlas/alerts-ack.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ forever.
100100
--projectId {PROJECT-ID} \
101101
--forever
102102

103-
The previous command returns the following fields in |json| format to
103+
The previous command returns the following fields in the specified format to
104104
the terminal. To learn more about these fields, see
105105
:ref:`atlas-alerts-ack-output`.
106106

source/reference/atlas/alerts-describe.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Syntax
2525
.. code-block:: text
2626

2727
mongocli atlas alert|alerts describe <alertID>
28-
[ --output|-o json ]
28+
[ --output|-o <output-format> ]
2929
[ --profile|-P <profile-name> ]
3030
[ --projectId <id-of-project> ]
3131

@@ -43,7 +43,7 @@ Options
4343
Output
4444
------
4545

46-
The command prints the following fields in |json| format
46+
The command prints the following fields in the specified format
4747
to the terminal if the command succeeds. If the command returns
4848
errors, see :ref:`Troubleshooting <troubleshooting>` for
4949
recommended solutions.
@@ -59,10 +59,10 @@ the {+default-profile+} to access |service|.
5959

6060
.. code-block:: text
6161

62-
mongocli atlas alerts describe 5df914cf105eef21d36f8d01 \
62+
mongocli atlas alerts describe 5df914cf105eef21d36f8d01 -o json \
6363
--projectId 5df90590f10fab5e33de2305
6464

65-
The previous command prints the following fields in |json| format to
65+
The previous command prints the following fields in the specified format to
6666
the terminal. To learn more about these fields, see
6767
:ref:`atlas-alerts-describe-output`.
6868

source/reference/atlas/alerts-list.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Syntax
2626

2727
mongocli atlas alert|alerts list|ls
2828
[ --limit <number-of-items-per-page> ]
29-
[ --output|-o json ]
29+
[ --output|-o <output-format> ]
3030
[ --page <page-number> ]
3131
[ --profile|-P <profile-name> ]
3232
[ --projectId <id-of-project> ]
@@ -46,7 +46,7 @@ Options
4646
Output
4747
------
4848

49-
For each alert, the command prints the following fields in |json| format
49+
For each alert, the command prints the following fields in the specified format
5050
to the terminal if the command succeeds. If the command returns
5151
errors, see :ref:`Troubleshooting <troubleshooting>` for
5252
recommended solutions.
@@ -63,9 +63,9 @@ the profile named ``myprofile`` for accessing |service|.
6363
.. code-block:: text
6464

6565
mongocli atlas alerts list --projectId 5df90590f10fab5e33de2305 \
66-
--profile myprofile
66+
-o json --profile myprofile
6767

68-
The previous command prints the following fields in |json| format to
68+
The previous command prints the following fields in the specified format to
6969
the terminal. To learn more about these fields, see
7070
:ref:`atlas-alerts-list-output`.
7171

source/reference/atlas/alerts-settings-create.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Syntax
3232
[ --matcherOperator <operator> ]
3333
[ --matcherValue <value> ]
3434
[ --notification* (notification flags) ]
35-
[ --output|-o json ]
35+
[ --output|-o <output-format> ]
3636
[ --projectId <id-of-project> ]
3737
[ --profile|-P <profile-name> ]
3838

@@ -285,7 +285,7 @@ Output
285285
------
286286

287287
If the command succeeds, it prints the subset of the following fields to
288-
the terminal in |json| format that describes the alert configuration.
288+
the terminal in the specified format that describes the alert configuration.
289289
If the command returns an error, see :ref:`Troubleshooting
290290
<troubleshooting>` for recommended solutions.
291291

@@ -305,9 +305,9 @@ project. It uses the {+default-profile+} to access the
305305
mongocli atlas alert settings create --event JOINED_GROUP --enabled \
306306
--notificationType USER --notificationEmailEnabled \
307307
--notificationUsername [email protected] \
308-
--projectId 5df90590f10fab5e33de2305
308+
-o json --projectId 5df90590f10fab5e33de2305
309309

310-
The above command prints the following fields in |json| format to
310+
The above command prints the following fields in the specified format to
311311
the terminal. To learn more about these fields, see
312312
:ref:`atlas-create-alerts-settings-output`.
313313

source/reference/atlas/alerts-settings-delete.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Syntax
3232

3333
mongocli atlas alerts settings|configs delete|rm|Delete|Remove <alert-id>
3434
[ --force ]
35-
[ --output|-o json ]
35+
[ --output|-o <output-format> ]
3636
[ --profile|-p <profile-name> ]
3737
[ --projectId <project-ID> ]
3838

source/reference/atlas/alerts-settings-fields-type.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Syntax
2828
.. code-block:: text
2929

3030
mongocli atlas alert|alerts settings|config fields type|types
31-
[ --output|-o json ]
31+
[ --output|-o <output-format> ]
3232
[ --profile|-P <profile-name> ]
3333

3434
.. include:: /includes/fact-command-line-help.rst
@@ -104,9 +104,9 @@ create or update an alert configuration. It uses the profile named
104104

105105
.. code-block:: text
106106

107-
mongocli atlas alerts settings fields type --profile myprofile
107+
mongocli atlas alerts settings fields type --profile myprofile -o json
108108

109-
The previous command prints the following fields in |json| format to
109+
The previous command prints the following fields in the specified format to
110110
the terminal. To learn more about these fields, see
111111
:ref:`atlas-alerts-settings-fields-type-output`.
112112

source/reference/atlas/alerts-settings-update.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Syntax
3232
[ --matcherOperator <operator> ]
3333
[ --matcherValue <value> ]
3434
[ --notification* (notification flags) ]
35-
[ --output|-o json ]
35+
[ --output|-o <output-format> ]
3636
[ --projectId <id-of-project> ]
3737
[ --profile|-P <profile-name> ]
3838

@@ -289,9 +289,9 @@ Options
289289
Output
290290
------
291291

292-
If the command succeeds, it prints the subset of the following fields to
293-
the terminal in |json| format that describes the alert configuration.
294-
If the command returns an error, see :ref:`Troubleshooting
292+
If the command succeeds, it prints the subset of the following fields,
293+
which describes the alert configuration, to the terminal in the specified
294+
format. If the command returns an error, see :ref:`Troubleshooting
295295
<troubleshooting>` for recommended solutions.
296296

297297
.. include:: /includes/list-table-alert-settings-response-atlas.rst
@@ -310,9 +310,9 @@ project. It uses the {+default-profile+} to access the
310310
mongocli atlas alert settings update 5eaafc90da10757c5fc51e70 \
311311
--event JOINED_GROUP --enabled --notificationType USER \
312312
--notificationEmailEnabled --notificationUsername [email protected] \
313-
--projectId 5df90590f10fab5e33de2305
313+
--output json --projectId 5df90590f10fab5e33de2305
314314

315-
The above command prints the following fields in |json| format to
315+
The above command prints the following fields in the specified format to
316316
the terminal. To learn more about these fields, see
317317
:ref:`atlas-update-alerts-settings-output`.
318318

source/reference/atlas/alerts-unack.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Syntax
2626
mongocli atlas alert|alerts unacknowledge|unack <alertID>
2727
[ --until <unacknowledgement time> ]
2828
[ --comment <optional comment> ]
29-
[ --output|-o json ]
29+
[ --output|-o <output-format> ]
3030
[ --profile|-P <profile-name> ]
3131
[ --projectId <id-of-project> ]
3232

@@ -65,7 +65,7 @@ one month.
6565

6666
mongocli atlas alerts unacknowledge {ALERT-ID} \
6767
--projectId {PROJECT-ID} \
68-
--until 2020-06-04T20:24:26Z
68+
--until 2020-06-04T20:24:26Z --output json
6969

7070
The previous command returns the following |json| document. To learn
7171
more about the fields in the document, see

source/reference/atlas/backup-restore-list.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Syntax
2929
mongocli atlas backup|backups restore|restores list|ls
3030
<cluster-name>
3131
[ --limit <items-per-page>]
32-
[ --output|-o json ]
32+
[ --output|-o <output-format> ]
3333
[ --page <page-num> ]
3434
[ --profile|-P <profile-name> ]
3535
[ --projectId <project-ID> ]
@@ -91,7 +91,7 @@ Options
9191
Output
9292
------
9393

94-
The command prints the following fields in |json| format to the terminal
94+
The command prints the following fields in the specified format to the terminal
9595
if the command succeeds. If the command returns an error, see
9696
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
9797

@@ -147,7 +147,7 @@ command to retrieve the Coninuous Backup restore jobs for the cluster
147147

148148
.. code-block:: json
149149

150-
mongocli atlas backup restore list Cluster0
150+
mongocli atlas backup restore list Cluster0 --output json
151151

152152
The previous command prints the following fields to the terminal. To
153153
learn more about these fields, see

source/reference/atlas/backup-restore-start.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Syntax
2929

3030
mongocli atlas backup restore start <restore-job-type>
3131
--clusterName <cluster-name>
32-
[ --output|-o json ]
32+
[ --output|-o <output-format> ]
3333
[ --oplogInc <oplog-Inc> ]
3434
[ --oplogTs <oplog-timestamp> ]
3535
[ --pointInTimeUTCMillis <pointInTime-UTC-ms> ]
@@ -262,7 +262,7 @@ of restore job:
262262
Output
263263
------
264264

265-
The command prints the following fields in |json| format to the terminal
265+
The command prints the following fields in the specified format to the terminal
266266
if the command succeeds. If the command returns an error, see
267267
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
268268

@@ -504,7 +504,8 @@ Example
504504
--clusterName myDemo \
505505
--snapshotId 5e7e00128f8ce03996a47179 \
506506
--targetClusterId 5e2f56937a3e5a26326a5ee8 \
507-
--targetProjectId 1a2345b67c8e9a12f3456de7
507+
--targetProjectId 1a2345b67c8e9a12f3456de7 \
508+
--output json
508509

509510
The previous command prints the following fields to the terminal.
510511
To learn more about these fields, see
@@ -557,7 +558,8 @@ Example
557558
--clusterName myDemo \
558559
--pointInTimeUTCMillis 1588523147 \
559560
--targetClusterId 5e2f56937a3e5a26326a5ee8 \
560-
--targetProjectId 1a2345b67c8e9a12f3456de7
561+
--targetProjectId 1a2345b67c8e9a12f3456de7 \
562+
--output json
561563

562564
The previous command prints the following fields to the terminal.
563565
To learn more about these fields, see
@@ -608,7 +610,8 @@ Example
608610

609611
mongocli atlas backup restore start download \
610612
--clusterName myDemo \
611-
--snapshotId 5e7e00128f8ce03996a47179
613+
--snapshotId 5e7e00128f8ce03996a47179 \
614+
--output json
612615

613616
The previous command prints the following fields to the
614617
terminal. To learn more about these fields, see

source/reference/atlas/backup-snapshots-list.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Syntax
2828
.. code-block:: text
2929

3030
mongocli atlas backup snapshots list|ls <cluster-name>
31-
[ --output|-o json ]
31+
[ --output|-o <output-format> ]
3232
[ --profile|-P <profile-name> ]
3333
[ --projectId <project-ID> ]
3434

@@ -77,7 +77,7 @@ Options
7777
Output
7878
------
7979

80-
The command prints the following fields in |json| format to the terminal if
80+
The command prints the following fields in the specified format to the terminal if
8181
the command succeeds. If the command returns an error, see
8282
:ref:`Troubleshooting <troubleshooting>` for recommended solutions.
8383

@@ -96,10 +96,9 @@ command uses the {+default-profile+}, where the project ID and the
9696
.. code-block:: json
9797
:copyable: false
9898

99-
mongocli atlas backups snapshots list myDemo
99+
mongocli atlas backups snapshots list myDemo --output json
100100

101-
The command prints the following fields to the terminal. To learn more about these
102-
fields, see :ref:`mcli-atlas-backup-snapshots-list-output`.
101+
The command prints the following fields to the terminal. To learn more about these fields, see :ref:`mcli-atlas-backup-snapshots-list-output`.
103102

104103
.. code-block:: json
105104
:copyable: false

source/reference/atlas/cluster-create.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Syntax
3434
[ --file|-f <path-to-cluster-config-file> ]
3535
[ --mdbVersion <mongodb-version> ]
3636
[ --members|-m <number-of-members> ]
37-
[ --output|-o json ]
37+
[ --output|-o <output-format> ]
3838
[ --profile|-P <profile-name> ]
3939
[ --projectId <project-ID> ]
4040
--provider AWS|GCP|AZURE
@@ -258,7 +258,7 @@ which contains the public and private keys for accessing |service|.
258258
.. code-block:: sh
259259
:copyable: false
260260

261-
mongocli atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M2 --mdbVersion {+mdbVersion+} --diskSizeGB 10
261+
mongocli atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M2 --mdbVersion {+mdbVersion+} --diskSizeGB 10 --output json
262262

263263
The command returns the following to the terminal. To learn more about
264264
these fields, see :ref:`Output <atlas-cluster-create-output-fields>`.
@@ -338,8 +338,9 @@ and private keys for accessing |service|.
338338

339339
mongocli atlas cluster create myCluster \
340340
--file cluster-config.json \
341+
--output json \
341342
--projectId 5e2211c17a3e5a48f5497de3 \
342-
--profile egAtlasProfile
343+
--profile egAtlasProfile
343344

344345
The cluster configuration file contains the following settings:
345346

@@ -465,7 +466,8 @@ keys for accessing |service|, as well as a default project ID.
465466
--members 3 \
466467
--tier M10 \
467468
--mdbVersion {+mdbVersion+} \
468-
--diskSizeGB 10
469+
--diskSizeGB 10 \
470+
--output json
469471

470472
The command returns the following to the terminal. To learn more about
471473
these fields, see :ref:`Output <atlas-cluster-create-output-fields>`.

source/reference/atlas/cluster-delete.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Syntax
3737

3838
mongocli atlas cluster delete <cluster-name>
3939
[ --force ]
40-
[ --output|-o json ]
40+
[ --output|-o <output-format> ]
4141
[ --profile|-P <profile-name> ]
4242
--projectId <project-ID>
4343

source/reference/atlas/cluster-describe.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Syntax
2727
:copyable: false
2828

2929
mongocli atlas cluster describe <cluster-name>
30-
[ --output|-o json ]
30+
[ --output|-o <output-format> ]
3131
[ --profile|-P <profile-name> ]
3232
[ --projectId <project-ID> ]
3333

@@ -77,7 +77,7 @@ Options
7777
Output
7878
------
7979

80-
The command prints the following fields in |json| format to the
80+
The command prints the following fields in the specified format to the
8181
terminal if the command succeeds. If the command returns errors,
8282
see :ref:`Troubleshooting <troubleshooting>` for recommended solutions.
8383

@@ -96,7 +96,7 @@ that contains the cluster.
9696
.. code-block:: text
9797
:copyable: false
9898

99-
mongocli atlas cluster describe myCluster --projectId 5e2211c17a3e5a48f5497de3
99+
mongocli atlas cluster describe myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json
100100

101101
The example command prints the following fields to the terminal. To learn
102102
more about these fields, see :ref:`Output <cluster-describe-output>`.

0 commit comments

Comments
 (0)