DOCSP-27062 Adds Interlinks for mongosh Role Methods (#2275) (#2319)

kennethdyer · web-flow · commit f01b2b5fa675 · 2023-01-04T15:52:28.000-08:00
diff --git a/source/reference/command/createRole.txt b/source/reference/command/createRole.txt
@@ -21,6 +21,9 @@ Definition
    command returns a *duplicate role* error if the role already exists in
    the database.
 
+   .. |method| replace:: :method:`db.createRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`createRole` command uses the following syntax:
 
    .. code-block:: javascript
diff --git a/source/reference/command/dropAllRolesFromDatabase.txt b/source/reference/command/dropAllRolesFromDatabase.txt
@@ -23,9 +23,13 @@ Definition
       The :dbcommand:`dropAllRolesFromDatabase` removes *all*
       :ref:`user-defined <user-defined-roles>` roles from the database.
 
+   .. |method| replace:: :method:`db.dropAllRoles` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`dropAllRolesFromDatabase` command takes the following
    form:
 
+
    .. code-block:: javascript
 
       {
diff --git a/source/reference/command/dropRole.txt b/source/reference/command/dropRole.txt
@@ -18,6 +18,9 @@ Definition
    Deletes a :ref:`user-defined <user-defined-roles>` role from the
    database on which you run the command.
 
+   .. |method| replace:: :method:`db.dropRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`dropRole` command uses the following syntax:
 
    .. code-block:: javascript
diff --git a/source/reference/command/grantPrivilegesToRole.txt b/source/reference/command/grantPrivilegesToRole.txt
@@ -17,8 +17,12 @@ Definition
 
    Assigns additional :ref:`privileges <privileges>` to a :ref:`user-defined
    <user-defined-roles>` role defined on the database on which the
-   command is run. The :dbcommand:`grantPrivilegesToRole` command uses
-   the following syntax:
+   command is run. 
+   
+   .. |method| replace:: :method:`db.grantPrivilegesToRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+   The :dbcommand:`grantPrivilegesToRole` command uses the following syntax:
 
    .. code-block:: javascript
 
diff --git a/source/reference/command/grantRolesToRole.txt b/source/reference/command/grantRolesToRole.txt
@@ -17,6 +17,9 @@ Definition
 
    Grants roles to a :ref:`user-defined role <user-defined-roles>`.
 
+   .. |method| replace:: :method:`db.grantRolesToRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`grantRolesToRole` command affects roles on the
    database where the command runs. :dbcommand:`grantRolesToRole` has
    the following syntax:
diff --git a/source/reference/command/revokePrivilegesFromRole.txt b/source/reference/command/revokePrivilegesFromRole.txt
@@ -20,6 +20,9 @@ Definition
    command is run. The :dbcommand:`revokePrivilegesFromRole` command
    has the following syntax:
 
+   .. |method| replace:: :method:`db.revokePrivilegesFromRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. code-block:: javascript
 
       {
diff --git a/source/reference/command/revokeRolesFromRole.txt b/source/reference/command/revokeRolesFromRole.txt
@@ -18,6 +18,9 @@ Definition
    Removes the specified inherited roles from a role. The
    :dbcommand:`revokeRolesFromRole` command has the following syntax:
 
+   .. |method| replace:: :method:`db.revokeRolesFromRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. code-block:: javascript
 
       { revokeRolesFromRole: "<role>",
diff --git a/source/reference/command/updateRole.txt b/source/reference/command/updateRole.txt
@@ -18,6 +18,9 @@ Definition
    Updates a :ref:`user-defined role <user-defined-roles>`. The
    :dbcommand:`updateRole` command must run on the role's database.
 
+   .. |method| replace:: :method:`db.updateRole` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    An update to a field **completely replaces** the previous field's values.
    To grant or remove roles or :ref:`privileges <privileges>` without
    replacing all values, use one or more of the following commands:
diff --git a/source/reference/method/db.createRole.txt b/source/reference/method/db.createRole.txt
@@ -20,6 +20,9 @@ Definition
    inherit privileges from other roles or both. The role applies to
    the database on which you run the method.
 
+   .. |dbcommand| replace:: :dbcommand:`createRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.createRole()` method accepts the following arguments:
 
 
@@ -129,12 +132,6 @@ Definition
           
           .. include:: /includes/fact-auth-restrictions-role-desc.rst
           
-          
-   
-
-
-   The :method:`db.createRole()` method wraps the :dbcommand:`createRole`
-   command.
 
 Roles
 ~~~~~
diff --git a/source/reference/method/db.dropAllRoles.txt b/source/reference/method/db.dropAllRoles.txt
@@ -23,6 +23,9 @@ Definition
       The :method:`db.dropAllRoles()` method removes *all*
       :ref:`user-defined <user-defined-roles>` roles from the database.
 
+   .. |dbcommand| replace:: :dbcommand:`dropAllRolesFromDatabase` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.dropAllRoles()` method takes the following argument:
 
 
@@ -55,9 +58,6 @@ Definition
    :returns:
       The number of :ref:`user-defined <user-defined-roles>` roles dropped.
 
-   The :method:`db.dropAllRoles()` method wraps the
-   :dbcommand:`dropAllRolesFromDatabase` command.
-
    .. |local-cmd-name| replace:: :method:`db.dropAllRoles()`
 
 Behavior
diff --git a/source/reference/method/db.dropRole.txt b/source/reference/method/db.dropRole.txt
@@ -18,6 +18,9 @@ Definition
    Deletes a :ref:`user-defined <user-defined-roles>` role from the
    database on which you run the method.
 
+   .. |dbcommand| replace:: :dbcommand:`dropRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.dropRole()` method takes the following arguments:
 
 
@@ -52,9 +55,6 @@ Definition
    
 
 
-   The :method:`db.dropRole()` method wraps the :dbcommand:`dropRole`
-   command.
-
    .. |local-cmd-name| replace:: :method:`db.dropRole()`
 
 Behavior
diff --git a/source/reference/method/db.grantPrivilegesToRole.txt b/source/reference/method/db.grantPrivilegesToRole.txt
@@ -18,6 +18,9 @@ Definition
    Grants additional :ref:`privileges <privileges>` to a :ref:`user-defined
    <user-defined-roles>` role.
 
+   .. |dbcommand| replace:: :dbcommand:`grantPrivilegesToRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.grantPrivilegesToRole()` method uses the following syntax:
 
    .. code-block:: javascript
@@ -82,9 +85,6 @@ Definition
 
    .. |local-cmd-name| replace:: :method:`db.grantPrivilegesToRole()`
 
-   The :method:`db.grantPrivilegesToRole()` method wraps the
-   :dbcommand:`grantPrivilegesToRole` command.
-
 Behavior
 --------
 
diff --git a/source/reference/method/db.grantRolesToRole.txt b/source/reference/method/db.grantRolesToRole.txt
@@ -17,6 +17,9 @@ Definition
 
    Grants roles to a :ref:`user-defined role <user-defined-roles>`.
 
+   .. |dbcommand| replace:: :dbcommand:`grantRolesToRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.grantRolesToRole()` method uses the following syntax:
 
    .. code-block:: javascript
@@ -68,9 +71,6 @@ Definition
    .. |local-cmd-name| replace:: :method:`db.grantRolesToRole()`
    .. include:: /includes/fact-roles-array-contents.rst
 
-   The :method:`db.grantRolesToRole()` method wraps the
-   :dbcommand:`grantRolesToRole` command.
-
 Behavior
 --------
 
diff --git a/source/reference/method/db.revokePrivilegesFromRole.txt b/source/reference/method/db.revokePrivilegesFromRole.txt
@@ -16,8 +16,12 @@ Definition
 .. method:: db.revokePrivilegesFromRole(rolename, privileges, writeConcern)
 
    Removes the specified privileges from the :ref:`user-defined
-   <user-defined-roles>` role on the database where the method runs. The
-   :method:`db.revokePrivilegesFromRole` method has the following syntax:
+   <user-defined-roles>` role on the database where the method runs. 
+   
+   .. |dbcommand| replace:: :dbcommand:`revokePrivilegesFromRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
+   The :method:`db.revokePrivilegesFromRole` method has the following syntax:
 
    .. code-block:: javascript
 
@@ -74,8 +78,6 @@ Definition
    
 
 
-   The :method:`db.revokePrivilegesFromRole()` method wraps the
-   :dbcommand:`revokePrivilegesFromRole` command.
 
 Behavior
 --------
diff --git a/source/reference/method/db.revokeRolesFromRole.txt b/source/reference/method/db.revokeRolesFromRole.txt
@@ -17,6 +17,9 @@ Definition
 
    Removes the specified inherited roles from a role.
 
+   .. |dbcommand| replace:: :dbcommand:`revokeRolesFromRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.revokeRolesFromRole()` method uses the following syntax:
 
    .. code-block:: javascript
@@ -67,9 +70,6 @@ Definition
    .. |local-cmd-name| replace:: :method:`db.revokeRolesFromRole()`
    .. include:: /includes/fact-roles-array-contents.rst
 
-   The :method:`db.revokeRolesFromRole()` method wraps the
-   :dbcommand:`revokeRolesFromRole` command.
-
 Behavior
 --------
 
diff --git a/source/reference/method/db.updateRole.txt b/source/reference/method/db.updateRole.txt
@@ -18,6 +18,9 @@ Definition
    Updates a :ref:`user-defined role <user-defined-roles>`. The
    :method:`db.updateRole()` method must run on the role's database.
 
+   .. |dbcommand| replace:: :dbcommand:`updateRole` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    An update to a field **completely replaces** the previous field's values.
    To grant or remove roles or :ref:`privileges <privileges>` without
    replacing all values, use one or more of the following methods:

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,9 @@ Definition`
`20`	`20`	command is run. The :dbcommand:`revokePrivilegesFromRole` command
`21`	`21`	`has the following syntax:`
`22`	`22`
	`23`	+ .. \|method\| replace:: :method:`db.revokePrivilegesFromRole` helper method
	`24`	`+ .. include:: /includes/fact-dbcommand-tip`
	`25`	`+`
`23`	`26`	`.. code-block:: javascript`
`24`	`27`
`25`	`28`	`{`