Skip to content

Commit 9162a43

Browse files
1 parent 87a6574 commit 9162a43

File tree

12 files changed

+88
-125
lines changed

12 files changed

+88
-125
lines changed

source/includes/api/list-tables/restore-job-request-documents.rst

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515
that represents the point in time to which your data will be
1616
restored.
1717

18-
.. note:: Conditions
18+
Conditions:
1919

20-
- Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
21-
- Run Sharded Clusters using |fcv-link| of 4.0 or earlier.
22-
- Can't set ``oplogInc``, ``oplogTs``, or
23-
``pointInTimeUTCMillis``.
20+
- Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
21+
- Run Sharded Clusters using |fcv-link| of 4.0 or earlier.
22+
- Can't set ``oplogInc``, ``oplogTs``, or
23+
``pointInTimeUTCMillis``.
2424

2525
If you provide this setting, this endpoint restores all data up
2626
to this :opsmgr:`checkpoint </reference/glossary/#std-term-checkpoint>` to the database you
@@ -67,17 +67,15 @@
6767
- ``AUTOMATED_RESTORE``
6868
- ``HTTP``
6969

70-
.. note::
70+
If you set ``"delivery.methodName" : "AUTOMATED_RESTORE"``,
71+
you must also set:
7172

72-
If you set ``"delivery.methodName" : "AUTOMATED_RESTORE"``,
73-
you must also set:
73+
- ``delivery.targetGroupId`` and
74+
- ``delivery.targetClusterId``
7475

75-
- ``delivery.targetGroupId`` and
76-
- ``delivery.targetClusterId``
77-
78-
In addition, the response shows the ``delivery.methodName``
79-
as ``HTTP``. An automated restore uses the ``HTTP`` method
80-
to deliver the restore job to the target host.
76+
In addition, the response shows the ``delivery.methodName``
77+
as ``HTTP``. An automated restore uses the ``HTTP`` method
78+
to deliver the restore job to the target host.
8179

8280
.. include:: /includes/note-scp-removed.rst
8381

@@ -93,14 +91,12 @@
9391

9492
``delivery.methodName" : "AUTOMATED_RESTORE"``.
9593

96-
.. note::
97-
98-
If backup is not enabled on the target cluster, the
99-
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
100-
endpoint returns an empty ``results`` array without
101-
``clusterId`` elements, and the
102-
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
103-
endpoint also does not return a ``clusterId`` element.
94+
If backup is not enabled on the target cluster, the
95+
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
96+
endpoint returns an empty ``results`` array without
97+
``clusterId`` elements, and the
98+
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
99+
endpoint also does not return a ``clusterId`` element.
104100

105101
* - | ``delivery``
106102
| ``.targetGroupId``
@@ -124,12 +120,10 @@
124120
``"delivery.methodName" : "AUTOMATED_RESTORE"``
125121
*for Replica Sets Only.*
126122

127-
.. note::
128-
129-
If you set ``oplogTs``, you:
123+
If you set ``oplogTs``, you:
130124

131-
- Must set ``oplogInc``.
132-
- Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
125+
- Must set ``oplogInc``.
126+
- Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
133127

134128
If you provide this setting, this endpoint restores all data up
135129
to *and including* this Oplog timestamp to the database you
@@ -146,12 +140,10 @@
146140
``"delivery.methodName" : "AUTOMATED_RESTORE"``
147141
*for Replica Sets Only.*
148142

149-
.. note::
143+
If you set ``oplogInc``, you:
150144

151-
If you set ``oplogInc``, you:
152-
153-
- Must set ``oplogTs``.
154-
- Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
145+
- Must set ``oplogTs``.
146+
- Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
155147

156148
If you provide this setting, this endpoint restores all data up
157149
to *and including* this Oplog timestamp to the database you
@@ -171,13 +163,10 @@
171163
``"delivery.methodName" : "AUTOMATED_RESTORE"``
172164
*for Replica Sets Only.*
173165

174-
.. note::
175-
176-
If you set ``pointInTimeUTCMillis``, you cannot set
177-
``oplogInc``, ``oplogTs``, or ``checkpointId``.
166+
If you set ``pointInTimeUTCMillis``, you cannot set
167+
``oplogInc``, ``oplogTs``, or ``checkpointId``.
178168

179169
* - ``snapshotId``
180170
- string
181171
- Conditional
182172
- Unique identifier of the :manual:`snapshot </reference/glossary/#std-term-snapshot>` to restore.
183-

source/includes/api/list-tables/restore-jobs/body-parameters/checkpoint.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,9 @@
3232
- Means by which |mms| delivers the data. Set to
3333
``AUTOMATED_RESTORE``.
3434

35-
.. note::
36-
37-
The response shows the ``"delivery.methodName" : "HTTP"``. An
38-
automated restore uses the ``HTTP`` method to deliver the
39-
restore job to the target host.
35+
The response shows the ``"delivery.methodName" : "HTTP"``. An
36+
automated restore uses the ``HTTP`` method to deliver the
37+
restore job to the target host.
4038

4139
* - | ``delivery``
4240
| ``.targetClusterId``
@@ -48,14 +46,12 @@
4846
and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
4947
endpoints.
5048

51-
.. note::
52-
53-
If backup is not enabled on the target cluster, the
54-
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
55-
endpoint returns an empty ``results`` array without
56-
``clusterId`` elements, and the
57-
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
58-
endpoint also does not return a ``clusterId`` element.
49+
If backup is not enabled on the target cluster, the
50+
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
51+
endpoint returns an empty ``results`` array without
52+
``clusterId`` elements, and the
53+
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
54+
endpoint also does not return a ``clusterId`` element.
5955

6056
* - | ``delivery``
6157
| ``.targetGroupId``

source/includes/api/list-tables/restore-jobs/body-parameters/http.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@
2020
- Conditional
2121
- |iso8601-time| after which the |url| is no longer available.
2222

23-
.. note:: Condition
24-
25-
If you set ``delivery.expires``, you can't set
26-
``delivery.expirationHours``.
23+
If you set ``delivery.expires``, you can't set
24+
``delivery.expirationHours``.
2725

2826
* - | ``delivery``
2927
| ``.expirationHours``
@@ -32,10 +30,8 @@
3230
- Number of hours the download |url| is valid once the restore
3331
job is complete.
3432

35-
.. note:: Condition
36-
37-
If you set ``delivery.expirationHours``, you can't set
38-
``delivery.expires``.
33+
If you set ``delivery.expirationHours``, you can't set
34+
``delivery.expires``.
3935

4036
* - | ``delivery``
4137
| ``.maxDownloads``

source/includes/api/list-tables/restore-jobs/body-parameters/oplog.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@
2121
- Means by which |mms| delivers the data. Set to
2222
``AUTOMATED_RESTORE``.
2323

24-
.. note::
25-
26-
The response shows the ``"delivery.methodName" : "HTTP"``. An
27-
automated restore uses the ``HTTP`` method to deliver the
28-
restore job to the target host.
24+
The response shows the ``"delivery.methodName" : "HTTP"``. An
25+
automated restore uses the ``HTTP`` method to deliver the
26+
restore job to the target host.
2927

3028
.. include:: /includes/note-scp-removed.rst
3129

@@ -39,14 +37,12 @@
3937
and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
4038
endpoints.
4139

42-
.. note::
43-
44-
If backup is not enabled on the target cluster, the
45-
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
46-
endpoint returns an empty ``results`` array without
47-
``clusterId`` elements, and the
48-
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
49-
endpoint also does not return a ``clusterId`` element.
40+
If backup is not enabled on the target cluster, the
41+
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
42+
endpoint returns an empty ``results`` array without
43+
``clusterId`` elements, and the
44+
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
45+
endpoint also does not return a ``clusterId`` element.
5046

5147
* - | ``delivery``
5248
| ``.targetGroupId``

source/includes/api/list-tables/restore-jobs/body-parameters/pit.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@
2121
- Means by which |mms| delivers the data. Set to
2222
``AUTOMATED_RESTORE``.
2323

24-
.. note::
25-
26-
The response shows the ``"delivery.methodName" : "HTTP"``. An
27-
automated restore uses the ``HTTP`` method to deliver the
28-
restore job to the target host.
24+
The response shows the ``"delivery.methodName" : "HTTP"``. An
25+
automated restore uses the ``HTTP`` method to deliver the
26+
restore job to the target host.
2927

3028
.. include:: /includes/note-scp-removed.rst
3129

@@ -39,14 +37,12 @@
3937
and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
4038
endpoints.
4139

42-
.. note::
43-
44-
If backup is not enabled on the target cluster, the
45-
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
46-
endpoint returns an empty ``results`` array without
47-
``clusterId`` elements, and the
48-
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
49-
endpoint also does not return a ``clusterId`` element.
40+
If backup is not enabled on the target cluster, the
41+
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
42+
endpoint returns an empty ``results`` array without
43+
``clusterId`` elements, and the
44+
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
45+
endpoint also does not return a ``clusterId`` element.
5046

5147
* - | ``delivery``
5248
| ``.targetGroupId``

source/includes/api/list-tables/restore-jobs/body-parameters/snapshot.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@
2121
- Means by which |mms| delivers the data. Set to
2222
``AUTOMATED_RESTORE``.
2323

24-
.. note::
25-
26-
The response shows the ``"delivery.methodName" : "HTTP"``. An
27-
automated restore uses the ``HTTP`` method to deliver the
28-
restore job to the target host.
24+
The response shows the ``"delivery.methodName" : "HTTP"``. An
25+
automated restore uses the ``HTTP`` method to deliver the
26+
restore job to the target host.
2927

3028
.. include:: /includes/note-scp-removed.rst
3129

@@ -39,14 +37,12 @@
3937
and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
4038
endpoints.
4139

42-
.. note::
43-
44-
If backup is not enabled on the target cluster, the
45-
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
46-
endpoint returns an empty ``results`` array without
47-
``clusterId`` elements, and the
48-
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
49-
endpoint also does not return a ``clusterId`` element.
40+
If backup is not enabled on the target cluster, the
41+
:doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
42+
endpoint returns an empty ``results`` array without
43+
``clusterId`` elements, and the
44+
:doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
45+
endpoint also does not return a ``clusterId`` element.
5046

5147
* - | ``delivery``
5248
| ``.targetGroupId``

source/includes/extracts-restore-job-response.yaml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,8 @@ content: |
104104
a hashed checksum. This array is present *only after* the
105105
file is downloaded.
106106
107-
.. note::
108-
109-
For an ``HTTP`` restore, this array only contains a single
110-
object that represents the hash of the ``.tar.gz`` file.
107+
For an ``HTTP`` restore, this array contains only a single
108+
object that represents the hash of the ``.tar.gz`` file.
111109
112110
* - hashes.fileName
113111
- string
@@ -264,10 +262,8 @@ content: |
264262
a hashed checksum. This array is present *only after* the
265263
file is downloaded.
266264
267-
.. note::
268-
269-
For an ``HTTP`` restore, this array only contains a single
270-
object that represents the hash of the ``.tar.gz`` file.
265+
For an ``HTTP`` restore, this array contains only a single
266+
object that represents the hash of the ``.tar.gz`` file.
271267
272268
* - hashes.fileName
273269
- string

source/reference/api/organizations/organization-get-all-projects.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,9 @@ The following query parameters are optional:
8383
list. Performs a case-insensitive search for a project, which is
8484
prefixed by the specified ``name``, within the organization.
8585

86-
.. example::
87-
88-
If you specify a ``name`` query parameter of ``project1``,
89-
|mms| returns the project named ``project1``, but would
90-
not return a project named ``project123``.
86+
For example, if you specify a ``name`` query parameter of
87+
``project1``, |mms| returns the project named ``project1``, but
88+
would not return a project named ``project123``.
9189
- None
9290

9391
Request Body Parameters

source/reference/api/organizations/organization-get-all-users.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,7 @@ An array of documents, each representing one Organization user.
145145

146146
- Project Roles
147147

148-
.. note::
149-
150-
Groups and projects are synonymous terms.
148+
Groups and projects are synonymous terms.
151149

152150
- ``GROUP_OWNER``
153151
- ``GROUP_READ_ONLY``

source/reference/api/organizations/organization-get-all.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,9 @@ The following query parameters are optional:
6868
a case-insensitive search for organizations which exactly match
6969
the specified ``name``.
7070

71-
.. example::
72-
73-
If you specify a ``name`` query parameter of ``org1``,
74-
|mms| returns organizations named ``org1`` and ``Org1``,
75-
but would not return an organization named ``org123``.
71+
For example, if you specify a ``name`` query parameter of
72+
``org1``, |mms| returns organizations named ``org1`` and ``Org1``,
73+
but would not return an organization named ``org123``.
7674
- None
7775

7876
* - ``includeDeletedOrgs``

source/reference/api/performance-advisor/get-slow-queries.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,12 @@ All parameters are optional.
9393
using an ampersand (``&``) as a delimiter, once for each
9494
namespace.
9595

96-
.. example::
96+
For example:
97+
98+
.. code-block::
9799

98100
?namespaces=data.stocks&namespaces=data.zips&pretty=true
101+
99102
- all
100103

101104
* - nLogs

source/reference/api/performance-advisor/get-suggested-indexes.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,12 @@ All parameters are optional.
8585
using an ampersand (``&``) as a delimiter, once for each
8686
namespace.
8787

88-
.. example::
88+
For example:
89+
90+
.. code-block::
8991

9092
?namespaces=data.stocks&namespaces=data.zips&pretty=true
93+
9194
- all
9295

9396
* - nIndexes
@@ -201,11 +204,9 @@ Response
201204
- List of unique identifers which correspond the query
202205
shapes in this response which pertain to this suggested index.
203206

204-
.. note::
205-
206-
This field does not correspond to :guilabel:`Impact` in the
207-
:ref:`Performance Advisor <performance-advisor>` user
208-
interface.
207+
This field does not correspond to :guilabel:`Impact` in the
208+
:ref:`Performance Advisor <performance-advisor>` user
209+
interface.
209210

210211
* - ``suggestedIndexes[n].index``
211212
- array of documents

0 commit comments

Comments
 (0)