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

0 commit comments

Comments
 (0)