Ports DOCSP-42991 to OM 6.0 (#397)

sarahsimpers · kyuan-mongodb · web-flow · commit 61658fb95153 · 2024-09-25T14:39:35.000-04:00
- [DOCSP](https://jira.mongodb.org/browse/DOCSP-43016) Ports https://github.com/10gen/docs-cloud-manager/commit/9706e27bc91686428e643891b89e3a6caec5cec1 to OM 6.0 Co-authored-by: kyuan-mongodb <78768401+kyuan-mongodb@users.noreply.github.com>
diff --git a/source/includes/api/list-tables/restore-job-request-documents.rst b/source/includes/api/list-tables/restore-job-request-documents.rst
@@ -15,12 +15,12 @@
        that represents the point in time to which your data will be
        restored.
 
-       .. note:: Conditions
+       Conditions:
 
-          - Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
-          - Run Sharded Clusters using |fcv-link| of 4.0 or earlier.
-          - Can't set ``oplogInc``, ``oplogTs``, or
-            ``pointInTimeUTCMillis``.
+       - Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
+       - Run Sharded Clusters using |fcv-link| of 4.0 or earlier.
+       - Can't set ``oplogInc``, ``oplogTs``, or
+         ``pointInTimeUTCMillis``.
 
        If you provide this setting, this endpoint restores all data up
        to this :opsmgr:`checkpoint  </reference/glossary/#std-term-checkpoint>` to the database you
@@ -67,17 +67,15 @@
        - ``AUTOMATED_RESTORE``
        - ``HTTP``
 
-       .. note::
+       If you set ``"delivery.methodName" : "AUTOMATED_RESTORE"``,
+       you must also set:
 
-          If you set ``"delivery.methodName" : "AUTOMATED_RESTORE"``,
-          you must also set:
+       - ``delivery.targetGroupId`` and
+       - ``delivery.targetClusterId``
 
-          - ``delivery.targetGroupId`` and
-          - ``delivery.targetClusterId``
-
-          In addition, the response shows the ``delivery.methodName``
-          as ``HTTP``. An automated restore uses the ``HTTP`` method
-          to deliver the restore job to the target host.
+       In addition, the response shows the ``delivery.methodName``
+       as ``HTTP``. An automated restore uses the ``HTTP`` method
+       to deliver the restore job to the target host.
 
        .. include:: /includes/note-scp-removed.rst
 
@@ -93,14 +91,12 @@
 
        ``delivery.methodName" : "AUTOMATED_RESTORE"``.
 
-       .. note::
-
-          If backup is not enabled on the target cluster, the
-          :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
-          endpoint returns an empty ``results`` array without
-          ``clusterId`` elements, and the
-          :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
-          endpoint also does not return a ``clusterId`` element.
+       If backup is not enabled on the target cluster, the
+       :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
+       endpoint returns an empty ``results`` array without
+       ``clusterId`` elements, and the
+       :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
+       endpoint also does not return a ``clusterId`` element.
 
    * - | ``delivery``
        | ``.targetGroupId``
@@ -124,12 +120,10 @@
        ``"delivery.methodName" : "AUTOMATED_RESTORE"``
        *for Replica Sets Only.*
 
-       .. note::
-
-          If you set ``oplogTs``, you:
+       If you set ``oplogTs``, you:
 
-          - Must set ``oplogInc``.
-          - Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
+       - Must set ``oplogInc``.
+       - Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
 
        If you provide this setting, this endpoint restores all data up
        to *and including* this Oplog timestamp to the database you
@@ -146,12 +140,10 @@
        ``"delivery.methodName" : "AUTOMATED_RESTORE"``
        *for Replica Sets Only.*
 
-       .. note::
+       If you set ``oplogInc``, you:
 
-          If you set ``oplogInc``, you:
-
-          - Must set ``oplogTs``.
-          - Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
+       - Must set ``oplogTs``.
+       - Cannot set ``checkpointId`` or ``pointInTimeUTCMillis``.
 
        If you provide this setting, this endpoint restores all data up
        to *and including* this Oplog timestamp to the database you
@@ -171,13 +163,10 @@
        ``"delivery.methodName" : "AUTOMATED_RESTORE"``
        *for Replica Sets Only.*
 
-       .. note::
-
-          If you set ``pointInTimeUTCMillis``, you cannot set
-          ``oplogInc``, ``oplogTs``, or ``checkpointId``.
+       If you set ``pointInTimeUTCMillis``, you cannot set
+       ``oplogInc``, ``oplogTs``, or ``checkpointId``.
 
    * - ``snapshotId``
      - string
      - Conditional
      - Unique identifier of the :manual:`snapshot </reference/glossary/#std-term-snapshot>` to restore.
-
diff --git a/source/includes/api/list-tables/restore-jobs/body-parameters/checkpoint.rst b/source/includes/api/list-tables/restore-jobs/body-parameters/checkpoint.rst
@@ -32,11 +32,9 @@
      - Means by which |mms| delivers the data. Set to
        ``AUTOMATED_RESTORE``.
 
-       .. note::
-
-          The response shows the ``"delivery.methodName" : "HTTP"``. An
-          automated restore uses the ``HTTP`` method to deliver the
-          restore job to the target host.
+       The response shows the ``"delivery.methodName" : "HTTP"``. An
+       automated restore uses the ``HTTP`` method to deliver the
+       restore job to the target host.
 
    * - | ``delivery``
        | ``.targetClusterId``
@@ -48,14 +46,12 @@
        and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
        endpoints.
 
-       .. note::
-
-          If backup is not enabled on the target cluster, the
-          :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
-          endpoint returns an empty ``results`` array without
-          ``clusterId`` elements, and the
-          :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
-          endpoint also does not return a ``clusterId`` element.
+       If backup is not enabled on the target cluster, the
+       :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
+       endpoint returns an empty ``results`` array without
+       ``clusterId`` elements, and the
+       :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
+       endpoint also does not return a ``clusterId`` element.
 
    * - | ``delivery``
        | ``.targetGroupId``
diff --git a/source/includes/api/list-tables/restore-jobs/body-parameters/http.rst b/source/includes/api/list-tables/restore-jobs/body-parameters/http.rst
@@ -20,10 +20,8 @@
      - Conditional
      - |iso8601-time| after which the |url| is no longer available.
 
-       .. note:: Condition
-
-          If you set ``delivery.expires``, you can't set
-          ``delivery.expirationHours``.
+       If you set ``delivery.expires``, you can't set
+       ``delivery.expirationHours``.
 
    * - | ``delivery``
        | ``.expirationHours``
@@ -32,10 +30,8 @@
      - Number of hours the download |url| is valid once the restore
        job is complete.
 
-       .. note:: Condition
-
-          If you set ``delivery.expirationHours``, you can't set
-          ``delivery.expires``.
+       If you set ``delivery.expirationHours``, you can't set
+       ``delivery.expires``.
 
    * - | ``delivery``
        | ``.maxDownloads``
diff --git a/source/includes/api/list-tables/restore-jobs/body-parameters/oplog.rst b/source/includes/api/list-tables/restore-jobs/body-parameters/oplog.rst
@@ -21,11 +21,9 @@
      - Means by which |mms| delivers the data. Set to
        ``AUTOMATED_RESTORE``.
 
-       .. note::
-
-          The response shows the ``"delivery.methodName" : "HTTP"``. An
-          automated restore uses the ``HTTP`` method to deliver the
-          restore job to the target host.
+       The response shows the ``"delivery.methodName" : "HTTP"``. An
+       automated restore uses the ``HTTP`` method to deliver the
+       restore job to the target host.
 
        .. include:: /includes/note-scp-removed.rst
 
@@ -39,14 +37,12 @@
        and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
        endpoints.
 
-       .. note::
-
-          If backup is not enabled on the target cluster, the
-          :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
-          endpoint returns an empty ``results`` array without
-          ``clusterId`` elements, and the
-          :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
-          endpoint also does not return a ``clusterId`` element.
+       If backup is not enabled on the target cluster, the
+       :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
+       endpoint returns an empty ``results`` array without
+       ``clusterId`` elements, and the
+       :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
+       endpoint also does not return a ``clusterId`` element.
 
    * - | ``delivery``
        | ``.targetGroupId``
diff --git a/source/includes/api/list-tables/restore-jobs/body-parameters/pit.rst b/source/includes/api/list-tables/restore-jobs/body-parameters/pit.rst
@@ -21,11 +21,9 @@
      - Means by which |mms| delivers the data. Set to
        ``AUTOMATED_RESTORE``.
 
-       .. note::
-
-          The response shows the ``"delivery.methodName" : "HTTP"``. An
-          automated restore uses the ``HTTP`` method to deliver the
-          restore job to the target host.
+       The response shows the ``"delivery.methodName" : "HTTP"``. An
+       automated restore uses the ``HTTP`` method to deliver the
+       restore job to the target host.
 
        .. include:: /includes/note-scp-removed.rst
 
@@ -39,14 +37,12 @@
        and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
        endpoints.
 
-       .. note::
-
-          If backup is not enabled on the target cluster, the
-          :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
-          endpoint returns an empty ``results`` array without
-          ``clusterId`` elements, and the
-          :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
-          endpoint also does not return a ``clusterId`` element.
+       If backup is not enabled on the target cluster, the
+       :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
+       endpoint returns an empty ``results`` array without
+       ``clusterId`` elements, and the
+       :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
+       endpoint also does not return a ``clusterId`` element.
 
    * - | ``delivery``
        | ``.targetGroupId``
diff --git a/source/includes/api/list-tables/restore-jobs/body-parameters/snapshot.rst b/source/includes/api/list-tables/restore-jobs/body-parameters/snapshot.rst
@@ -21,11 +21,9 @@
      - Means by which |mms| delivers the data. Set to
        ``AUTOMATED_RESTORE``.
 
-       .. note::
-
-          The response shows the ``"delivery.methodName" : "HTTP"``. An
-          automated restore uses the ``HTTP`` method to deliver the
-          restore job to the target host.
+       The response shows the ``"delivery.methodName" : "HTTP"``. An
+       automated restore uses the ``HTTP`` method to deliver the
+       restore job to the target host.
 
        .. include:: /includes/note-scp-removed.rst
 
@@ -39,14 +37,12 @@
        and :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
        endpoints.
 
-       .. note::
-
-          If backup is not enabled on the target cluster, the
-          :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
-          endpoint returns an empty ``results`` array without
-          ``clusterId`` elements, and the
-          :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
-          endpoint also does not return a ``clusterId`` element.
+       If backup is not enabled on the target cluster, the
+       :doc:`Get All Snapshots </reference/api/snapshots/get-all-snapshots-for-one-cluster/>`
+       endpoint returns an empty ``results`` array without
+       ``clusterId`` elements, and the
+       :doc:`Get a Snapshot </reference/api/snapshots/get-all-snapshots-for-one-cluster>`
+       endpoint also does not return a ``clusterId`` element.
 
    * - | ``delivery``
        | ``.targetGroupId``
diff --git a/source/includes/extracts-restore-job-response.yaml b/source/includes/extracts-restore-job-response.yaml
@@ -104,10 +104,8 @@ content: |
          a hashed checksum. This array is present *only after* the
          file is downloaded.
 
-         .. note::
-
-            For an ``HTTP`` restore, this array only contains a single
-            object that represents the hash of the ``.tar.gz`` file.
+         For an ``HTTP`` restore, this array contains only a single
+         object that represents the hash of the ``.tar.gz`` file.
 
      * - hashes.fileName
        - string
@@ -264,10 +262,8 @@ content: |
          a hashed checksum. This array is present *only after* the
          file is downloaded.
 
-         .. note::
-         
-            For an ``HTTP`` restore, this array only contains a single
-            object that represents the hash of the ``.tar.gz`` file.
+         For an ``HTTP`` restore, this array contains only a single
+         object that represents the hash of the ``.tar.gz`` file.
 
      * - hashes.fileName
        - string
diff --git a/source/reference/api/organizations/organization-get-all-projects.txt b/source/reference/api/organizations/organization-get-all-projects.txt
@@ -83,11 +83,9 @@ The following query parameters are optional:
       a case-insensitive search for a project within the organization
       which exactly matches the specified ``name``.
 
-      .. example::
-
-         If you specify a ``name`` query parameter of ``project1``,
-         |mms| returns the project named ``project1``, but would
-         not return a project named ``project123``.
+      For example, if you specify a ``name`` query parameter of
+      ``project1``, |mms| returns the project named ``project1``, but
+      would not return a project named ``project123``.
     - None
 
 Request Body Parameters
diff --git a/source/reference/api/organizations/organization-get-all-users.txt b/source/reference/api/organizations/organization-get-all-users.txt
@@ -145,9 +145,7 @@ An array of documents, each representing one Organization user.
 
        - Project Roles
 
-         .. note::
-
-            Groups and projects are synonymous terms.
+         Groups and projects are synonymous terms.
 
          - ``GROUP_OWNER``
          - ``GROUP_READ_ONLY``
diff --git a/source/reference/api/organizations/organization-get-all.txt b/source/reference/api/organizations/organization-get-all.txt
@@ -68,11 +68,9 @@ The following query parameters are optional:
       a case-insensitive search for organizations which exactly match
       the specified ``name``.
 
-      .. example::
-
-        If you specify a ``name`` query parameter of ``org1``,
-        |mms| returns organizations named ``org1`` and ``Org1``,
-        but would not return an organization named ``org123``.
+      For example, if you specify a ``name`` query parameter of
+      ``org1``, |mms| returns organizations named ``org1`` and ``Org1``,
+      but would not return an organization named ``org123``.
     - None
 
   * - ``includeDeletedOrgs``
diff --git a/source/reference/api/performance-advisor/get-slow-queries.txt b/source/reference/api/performance-advisor/get-slow-queries.txt
@@ -93,9 +93,12 @@ All parameters are optional.
        using an ampersand (``&``) as a delimiter, once for each
        namespace.
 
-       .. example::
+       For example:
+       
+       .. code-block::
 
           ?namespaces=data.stocks&namespaces=data.zips&pretty=true
+
      - all
 
    * - nLogs
diff --git a/source/reference/api/performance-advisor/get-suggested-indexes.txt b/source/reference/api/performance-advisor/get-suggested-indexes.txt
@@ -85,9 +85,12 @@ All parameters are optional.
        using an ampersand (``&``) as a delimiter, once for each
        namespace.
 
-       .. example::
+       For example:
+       
+       .. code-block::
 
           ?namespaces=data.stocks&namespaces=data.zips&pretty=true
+
      - all
 
    * - nIndexes
@@ -197,11 +200,9 @@ Response
      - List of unique identifers which correspond the query
        shapes in this response which pertain to this suggested index.
 
-       .. note::
-
-          This field does not correspond to :guilabel:`Impact` in the
-          :ref:`Performance Advisor <performance-advisor>` user
-          interface.
+       This field does not correspond to :guilabel:`Impact` in the
+       :ref:`Performance Advisor <performance-advisor>` user
+       interface.
 
    * - ``suggestedIndexes[n].index``
      - array of documents
