[api] new method BugSystem.filter()

kiwitcms · Jan 13, 2019 · 1b6882c · 1b6882c
1 parent 6d918ca
commit 1b6882c
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 0 deletions.
diff --git a/docs/source/modules/tcms.xmlrpc.api.bugsystem.rst b/docs/source/modules/tcms.xmlrpc.api.bugsystem.rst
@@ -0,0 +1,7 @@
+tcms.xmlrpc.api.bugsystem module
+================================
+
+.. automodule:: tcms.xmlrpc.api.bugsystem
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/modules/tcms.xmlrpc.api.rst b/docs/source/modules/tcms.xmlrpc.api.rst
@@ -13,6 +13,7 @@ Submodules
 
    tcms.xmlrpc.api.auth
    tcms.xmlrpc.api.bug
+   tcms.xmlrpc.api.bugsystem
    tcms.xmlrpc.api.build
    tcms.xmlrpc.api.category
    tcms.xmlrpc.api.component

diff --git a/tcms/settings/common.py b/tcms/settings/common.py
@@ -298,6 +298,7 @@
     'tcms.xmlrpc.api.auth',
     'tcms.xmlrpc.api.bug',
     'tcms.xmlrpc.api.build',
+    'tcms.xmlrpc.api.bugsystem',
     'tcms.xmlrpc.api.category',
     'tcms.xmlrpc.api.component',
     'tcms.xmlrpc.api.plantype',

diff --git a/tcms/xmlrpc/api/bugsystem.py b/tcms/xmlrpc/api/bugsystem.py
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+from modernrpc.core import rpc_method
+
+from tcms.testcases.models import BugSystem
+
+
+__all__ = (
+    'filter',
+)
+
+
+@rpc_method(name='BugSystem.filter')
+def filter(query):  # pylint: disable=redefined-builtin
+    """
+    .. function:: XML-RPC BugSystem.filter(query)
+
+        Get list of bug systems.
+
+        :param query: Field lookups for :class:`tcms.testcases.models.BugSystem`
+        :type query: dict
+        :return: List of serialized :class:`tcms.testcases.models.BugSystem` objects.
+    """
+    return BugSystem.to_xmlrpc(query)