fix: Have participants() method use http_list()

JohnVillalovos · nejch · commit d065275f2fe2 · 2024-07-08T14:11:58.000+02:00
Previously it was using `http_get()` but the `participants` API returns a list of participants. Also by using this then we will warn if only a subset of the participants are returned. Closes: python-gitlab#2913
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -911,7 +911,9 @@ class ParticipantsMixin(_RestObjectBase):
 
     @cli.register_custom_action(cls_names=("ProjectMergeRequest", "ProjectIssue"))
     @exc.on_http_error(exc.GitlabListError)
-    def participants(self, **kwargs: Any) -> Dict[str, Any]:
+    def participants(
+        self, **kwargs: Any
+    ) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]:
         """List the participants.
 
         Args:
@@ -929,7 +931,7 @@ def participants(self, **kwargs: Any) -> Dict[str, Any]:
         """
 
         path = f"{self.manager.path}/{self.encoded_id}/participants"
-        result = self.manager.gitlab.http_get(path, **kwargs)
+        result = self.manager.gitlab.http_list(path, **kwargs)
         if TYPE_CHECKING:
             assert not isinstance(result, requests.Response)
         return result
diff --git a/tests/functional/api/test_issues.py b/tests/functional/api/test_issues.py
@@ -18,7 +18,9 @@ def test_create_issue(project):
     assert issue in project.issues.list(state="opened")
     assert issue2 in project.issues.list(state="closed")
 
-    assert issue.participants()
+    participants = issue.participants()
+    assert participants
+    assert isinstance(participants, list)
     assert type(issue.closed_by()) == list
     assert type(issue.related_merge_requests()) == list
 
diff --git a/tests/functional/api/test_merge_requests.py b/tests/functional/api/test_merge_requests.py
@@ -104,7 +104,9 @@ def test_merge_request_basic(project):
     # basic testing: only make sure that the methods exist
     mr.commits()
     mr.changes()
-    assert mr.participants()
+    participants = mr.participants()
+    assert participants
+    assert isinstance(participants, list)
 
 
 def test_merge_request_rebase(project):
