Extend content.get() to support includes param

Author: cgraham-rs

integration/tests/posit/connect/test_content.py

@@ -25,6 +25,14 @@ def test_count(self):
     def test_get(self):
         assert self.client.content.get(self.content["guid"]) == self.content
 
+    def test_get_with_include_string(self):
+        assert  self.client.content.get(self.content["guid"], include="owner")
+
+    def test_get_with_include_list(self):
+        assert self.client.content.get(
+            self.content["guid"], include=["owner", "tags", "vanity_url"]
+        )
+
     def test_find(self):
         assert self.client.content.find()
 

src/posit/connect/content.py

@@ -983,16 +983,34 @@ def find_one(self, **conditions) -> Optional[ContentItem]:
         items = self.find(**conditions)
         return next(iter(items), None)
 
-    def get(self, guid: str) -> ContentItem:
+    def get(
+        self,
+        guid: str,
+        *,
+        include: Optional[
+            Literal["owner", "tags", "vanity_url"] | list[Literal["owner", "tags", "vanity_url"]]
+        ] = None,
+    ) -> ContentItem:
         """Get a content item.
 
         Parameters
         ----------
         guid : str
+            The unique identifier of the content item.
+        include : str or list of str, optional
+            Additional details to include in the response.
+            Allowed values: 'owner', 'tags', 'vanity_url'.
 
         Returns
         -------
         ContentItem
         """
-        response = self._ctx.client.get(f"v1/content/{guid}")
+        params = {}
+        if include is not None:
+            if isinstance(include, list):
+                params["include"] = ",".join(include)
+            else:
+                params["include"] = include
+
+        response = self._ctx.client.get(f"v1/content/{guid}", params=params)
         return ContentItem(self._ctx, **response.json())

tests/posit/connect/test_content.py

@@ -169,7 +169,7 @@ def test(self):
         assert content[2]["name"] == "My-Streamlit-app"
 
     @responses.activate
-    def test_params_include(self):
+    def test_params_include_string(self):
         # behavior
         mock_get = responses.get(
             "https://connect.example/__api__/v1/content",
@@ -204,24 +204,6 @@ def test_params_include_list(self):
         #  assert
         assert mock_get.call_count == 1
 
-    @responses.activate
-    def test_params_include_none(self):
-        # behavior
-        mock_get = responses.get(
-            "https://connect.example/__api__/v1/content",
-            json=load_mock("v1/content.json"),
-            match=[matchers.query_param_matcher({})],
-        )
-
-        # setup
-        client = Client("https://connect.example", "12345")
-
-        # invoke
-        client.content.find(include=None)
-
-        #  assert
-        assert mock_get.call_count == 1
-
 
 class TestContentsFindBy:
     @responses.activate
@@ -373,6 +355,38 @@ def test(self):
         get_one = con.content.get("f2f37341-e21d-3d80-c698-a935ad614066")
         assert get_one["name"] == "Performance-Data-1671216053560"
 
+    @responses.activate
+    def test_get_with_include_string(self):
+        guid = "f2f37341-e21d-3d80-c698-a935ad614066"
+        mock_get = responses.get(
+            f"https://connect.example/__api__/v1/content/{guid}",
+            json=load_mock(f"v1/content/{guid}.json"),
+            match=[matchers.query_param_matcher({"include": "owner"})],
+        )
+
+        con = Client("https://connect.example", "12345")
+        content = con.content.get(guid, include="owner")
+        assert content["guid"] == guid
+
+        #  assert
+        assert mock_get.call_count == 1
+
+
+    @responses.activate
+    def test_get_with_include_list(self):
+        guid = "f2f37341-e21d-3d80-c698-a935ad614066"
+        mock_get = responses.get(
+            f"https://connect.example/__api__/v1/content/{guid}",
+            json=load_mock(f"v1/content/{guid}.json"),
+            match=[matchers.query_param_matcher({"include": "owner,tags,vanity_url"})],
+        )
+
+        con = Client("https://connect.example", "12345")
+        content = con.content.get(guid, include=["owner", "tags", "vanity_url"])
+        assert content["guid"] == guid
+
+        #  assert
+        assert mock_get.call_count == 1
 
 class TestContentsCount:
     @responses.activate