DOCSP-32849-add-reference-to-restore-role (#737)

morales-mario-mdb · jeff-allen-mongo · web-flow · commit af2bdbeb04cb · 2025-04-28T10:38:19.000-06:00
* DOCSP-32849-add-reference-to-restore-role

* rephrasing

* use-include

* reorder

* Update source/includes/fact-permissions-body.rst

Co-authored-by: Jeff Allen &lt;jeffrey.allen@10gen.com&gt;

* apply-feedback

* modify-reference-text-capitalization

* modify-reference-text-capitalization

* fix-ref-link

* rename-file-and-rephrase

* fix-include-path

---------

Co-authored-by: Jeff Allen &lt;jeffrey.allen@10gen.com&gt;
diff --git a/source/includes/api/facts/reverse-sync-requirements.rst b/source/includes/api/facts/reverse-sync-requirements.rst
@@ -0,0 +1,3 @@
+To reverse sync, the user must be assigned the :authrole:`restore`
+role for both source and destination and the ``enableUserWriteBlocking``
+field must be set to ``sourceAndDestination``.
diff --git a/source/includes/fact-permissions-body.rst b/source/includes/fact-permissions-body.rst
@@ -1,5 +1,5 @@
 The user specified in the ``mongosync`` connection string must have the
-required permissions on the source and destination clusters. The
-permissions vary depending on your environment and if you want to 
-modify write-blocking settings or use reverse sync.
-
+required :ref:`user permissions <c2c-permissions-and-roles>` on the
+source and destination clusters. The permissions vary depending on your
+environment and if you want to modify write-blocking settings or use
+reverse sync.
diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt
@@ -141,10 +141,10 @@ Request Body Parameters
          cluster while migration is in progress, and unblocks writes right
          before ``canWrite`` is ``true``.
 
-       To reverse sync, the ``enableUserWriteBlocking`` field must be set
-       to ``"sourceAndDestination"``. To allow the source cluster 
-       to accept writes again, for example after running migration tests, 
-       run the following command: 
+       .. include:: /includes/api/facts/reverse-sync-requirements.rst
+       
+       To allow the source cluster to accept writes again, for example
+       after running migration tests, run the following command: 
 
        .. code-block:: shell 
           
@@ -175,9 +175,8 @@ Request Body Parameters
      - Optional
      - If set to ``true``, enables the sync operation to be
        reversed.
-
-       To reverse sync, the ``enableUserWriteBlocking`` field must be set
-       to ``sourceAndDestination``.
+       
+       .. include:: /includes/api/facts/reverse-sync-requirements.rst
 
        This option is not supported for the following configurations:
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+To reverse sync, the user must be assigned the :authrole:`restore`
	`2`	+role for both source and destination and the ``enableUserWriteBlocking``
	`3`	+field must be set to ``sourceAndDestination``.