Add support for user_agent_detail (issues)

Gauvain Pocentek · Gauvain Pocentek · commit 397d67745f57 · 2017-11-11T15:11:12.000+01:00
https://docs.gitlab.com/ce/api/issues.html#get-user-agent-details
diff --git a/docs/gl_objects/issues.py b/docs/gl_objects/issues.py
@@ -85,3 +85,7 @@
 # project issue reset time spent
 issue.reset_time_spent()
 # end project issue reset time spent
+
+# project issue useragent
+detail = issue.user_agent_detail()
+# end project issue useragent
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
@@ -176,3 +176,8 @@ Reset spent time for an issue:
    :start-after: # project issue reset time spent
    :end-before: # end project issue reset time spent
 
+Get user agent detail for the issue (admin only):
+
+.. literalinclude:: issues.py
+   :start-after: # project issue useragent
+   :end-before: # end project issue useragent
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -1128,6 +1128,21 @@ class ProjectIssue(SubscribableMixin, TodoMixin, TimeTrackingMixin, SaveMixin,
     _id_attr = 'iid'
     _managers = (('notes', 'ProjectIssueNoteManager'), )
 
+    @cli.register_custom_action('ProjectIssue')
+    @exc.on_http_error(exc.GitlabUpdateError)
+    def user_agent_detail(self, **kwargs):
+        """Get user agent detail.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabGetError: If the detail could not be retrieved
+        """
+        path = '%s/%s/user_agent_detail' % (self.manager.path, self.get_id())
+        return self.manager.gitlab.http_get(path, **kwargs)
+
     @cli.register_custom_action('ProjectIssue', ('to_project_id',))
     @exc.on_http_error(exc.GitlabUpdateError)
     def move(self, to_project_id, **kwargs):
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -435,6 +435,7 @@
 assert(len(issue1.notes.list()) == 1)
 note.delete()
 assert(len(issue1.notes.list()) == 0)
+assert(isinstance(issue1.user_agent_detail(), dict))
 
 # tags
 tag1 = admin_project.tags.create({'tag_name': 'v1.0', 'ref': 'master'})
