Add links to API

Author: schloerke

src/posit/connect/groups.py

@@ -108,6 +108,10 @@ def add(self, *args: User, user_guid: Optional[str] = None) -> None:
         # Add a user to the group by GUID
         group.members.add(user_guid="USER_GUID_HERE")
         ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/groups/-group_guid-/members
         """
         if len(args) > 0:
             from .users import User
@@ -168,6 +172,9 @@ def delete(self, *args: User, user_guid: Optional[str] = None) -> None:
         group.members.delete(user_guid="USER_GUID_HERE")
         ```
 
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#delete-/v1/groups/-group_guid-/members/-user_guid-
         """
         if len(args) > 0:
             from .users import User
@@ -212,6 +219,10 @@ def find(self) -> list[User]:
         # Find all users in the group
         group_users = group.members.find()
         ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members
         """
         # Avoid circular import
         from .users import User
@@ -244,6 +255,10 @@ def count(self) -> int:
         # Get count of group members
         group_user_count = group.members.count()
         ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members
         """
         path = f"v1/groups/{self._group_guid}/members"
         url = self._ctx.url + path
@@ -271,6 +286,10 @@ def create(self, *, name: str, unique_id: str | None) -> Group:
         Returns
         -------
         Group
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/groups
         """
 
     @overload
@@ -320,6 +339,10 @@ def find(self, **kwargs):
         Returns
         -------
         List[Group]
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups
         """
         path = "v1/groups"
         url = self._ctx.url + path
@@ -354,6 +377,10 @@ def find_one(self, **kwargs) -> Group | None:
         Returns
         -------
         Group | None
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups
         """
         path = "v1/groups"
         url = self._ctx.url + path
@@ -379,6 +406,10 @@ def get(self, guid: str) -> Group:
         Returns
         -------
         Group
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups
         """
         url = self._ctx.url + f"v1/groups/{guid}"
         response = self._ctx.session.get(url)
@@ -393,6 +424,10 @@ def count(self) -> int:
         Returns
         -------
         int
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups
         """
         path = "v1/groups"
         url = self._ctx.url + path

src/posit/connect/users.py

@@ -50,6 +50,10 @@ def lock(self, *, force: bool = False):
         Attempt to lock your own account (will raise `RuntimeError` unless `force` is set to `True`):
 
         >>> user.lock(force=True)
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/users/-guid-/lock
         """
         _me = me.get(self._ctx)
         if _me["guid"] == self["guid"] and not force:
@@ -76,6 +80,10 @@ def unlock(self):
         Unlock a user's account:
 
         >>> user.unlock()
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/users/-guid-/lock
         """
         url = self._ctx.url + f"v1/users/{self['guid']}/lock"
         body = {"locked": False}
@@ -124,6 +132,10 @@ def update(
         Update the user's first and last name:
 
         >>> user.update(first_name="Jane", last_name="Smith")
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#put-/v1/users/-guid-
         """
         url = self._ctx.url + f"v1/users/{self['guid']}"
         response = self._ctx.session.put(url, json=kwargs)
@@ -204,6 +216,10 @@ def add(
         # Add the user to a group by GUID
         user.groups.add(group_guid="GROUP_GUID_HERE")
         ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/groups/-group_guid-/members
         """
         if len(args) > 0:
             from .groups import Group
@@ -272,6 +288,10 @@ def delete(
         # Remove the user from a group by GUID
         user.groups.delete(group_guid="GROUP_GUID_HERE")
         ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#delete-/v1/groups/-group_guid-/members/-user_guid-
         """
         if len(args) > 0:
             from .groups import Group
@@ -307,9 +327,18 @@ def find(self) -> List[Group]:
 
         Examples
         --------
-        Retrieve the groups to which the user belongs:
+        ```python
+        from posit.connect import Client
+
+        client = Client("https://posit.example.com", "API_KEY")
 
-        >>> groups = user.groups()
+        user = client.users.get("USER_GUID_HERE")
+        groups = user.groups.find()
+        ```
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members
         """
         self_groups: list[Group] = []
         for group in self._ctx.client.groups.find():
@@ -396,6 +425,10 @@ def create(self, **attributes: Unpack[CreateUser]) -> User:
         ...     user_must_set_password=True,
         ...     user_role="viewer",
         ... )
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#post-/v1/users
         """
         # todo - use the 'context' module to inspect the 'authentication' object and route to POST (local) or PUT (remote).
         url = self._ctx.url + "v1/users"
@@ -440,6 +473,10 @@ def find(self, **conditions: Unpack[FindUser]) -> List[User]:
         Find all users who are locked or licensed:
 
         >>> users = client.find(account_status="locked|licensed")
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/users
         """
         url = self._ctx.url + "v1/users"
         paginator = Paginator(self._ctx.session, url, params={**conditions})
@@ -483,6 +520,10 @@ def find_one(self, **conditions: Unpack[FindUser]) -> User | None:
         Find a user who is locked or licensed:
 
         >>> user = client.find_one(account_status="locked|licensed")
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/users
         """
         url = self._ctx.url + "v1/users"
         paginator = Paginator(self._ctx.session, url, params={**conditions})
@@ -513,6 +554,10 @@ def get(self, uid: str) -> User:
         Examples
         --------
         >>> user = client.get("123e4567-e89b-12d3-a456-426614174000")
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/users
         """
         url = self._ctx.url + f"v1/users/{uid}"
         response = self._ctx.session.get(url)
@@ -528,6 +573,10 @@ def count(self) -> int:
         Returns
         -------
         int
+
+        See Also
+        --------
+        * https://docs.posit.co/connect/api/#get-/v1/users
         """
         url = self._ctx.url + "v1/users"
         response = self._ctx.session.get(url, params={"page_size": 1})