Merge pull request atlassian-api#289 from SLRover/master

Added: get issue security schemes methods, docs icon

Author: gonchik

README.rst

@@ -1,14 +1,14 @@
 ============================
 Atlassian Python API wrapper
 ============================
-|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge|
+|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge| |Docs|
 
 Documentation
 -------------
 
-`Documentation (beta)`_
+`Documentation`_
 
-.. _Documentation (beta): https://atlassian-python-api.readthedocs.io/en/latest/index.html
+.. _Documentation: https://atlassian-python-api.readthedocs.io/en/latest/index.html
 
 Examples
 --------
@@ -109,6 +109,9 @@ See the `Contribution guidelines for this project`_ for details on how to make c
    :alt: Codacy Badge
 .. |PyPI - Downloads| image:: https://pepy.tech/badge/atlassian-python-api/month
    :alt: PyPI - Downloads
+.. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest
+   :target: https://atlassian-python-api.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
 
 
 Credits

atlassian/jira.py

@@ -1315,6 +1315,53 @@ def set_permissionscheme_grant(self, permission_id, new_permission):
 
         return self.post(url, data=new_permission)
 
+    def get_issue_security_schemes(self):
+        """
+        Returns all issue security schemes that are defined
+        Administrator permission required
+
+        :return: list
+        """
+        url = 'rest/api/2/issuesecurityschemes'
+
+        return self.get(url).get('issueSecuritySchemes')
+
+    def get_issue_security_scheme(self, scheme_id, only_levels=False):
+        """
+        Returns the issue security scheme along with that are defined
+
+        Returned if the user has the administrator permission or if the scheme is used in a project in which the
+        user has the administrative permission
+
+        :param scheme_id: int
+        :param only_levels: bool
+        :return: list
+        """
+        url = 'rest/api/2/issuesecurityschemes/{}'.format(scheme_id)
+
+        if only_levels is True:
+            return self.get(url).get('levels')
+        else:
+            return self.get(url)
+
+    def get_project_issue_security_scheme(self, project_id_or_key, only_levels=False):
+        """
+        Returns the issue security scheme for project
+
+        Returned if the user has the administrator permission or if the scheme is used in a project in which the
+        user has the administrative permission
+
+        :param project_id_or_key: int
+        :param only_levels: bool
+        :return: list
+        """
+        url = 'rest/api/2/project/{}/issuesecuritylevelscheme'.format(project_id_or_key)
+
+        if only_levels is True:
+            return self.get(url).get('levels')
+        else:
+            return self.get(url)
+
     """
     #######################################################################
     #                   Tempo Account REST API implements                 #

docs/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '1.11.7'
+release = '1.13.23'
 
 # -- General configuration ---------------------------------------------------
 

docs/index.rst

@@ -5,7 +5,7 @@
 
 Welcome to Atlassian Python API's documentation!
 ================================================
-|Build Status| |PyPI version| |License| |Codacy Badge|
+|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge| |Docs|
 
 Getting started
 ---------------
@@ -88,4 +88,9 @@ Alternatively OAuth can be used:
    :alt: License
 .. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c822908f507544fe98ae37b25518ae3d
    :target: https://www.codacy.com/project/gonchik/atlassian-python-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AstroMatt/atlassian-python-api&utm_campaign=Badge_Grade_Dashboard
-   :alt: Codacy Badge
+   :alt: Codacy Badge
+.. |PyPI - Downloads| image:: https://pepy.tech/badge/atlassian-python-api/month
+   :alt: PyPI - Downloads
+.. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest
+   :target: https://atlassian-python-api.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status

docs/jira.rst

@@ -125,6 +125,13 @@ Manage projects
     # Use 'expand' to get details (default is None)
     jira.get_project_permission_scheme(project_id_or_key, expand='permissions,user,group,projectRole,field,all')
 
+    # Get the issue security scheme for project.
+    # Returned if the user has the administrator permission or if the scheme is used in a project in which the
+    # user has the administrative permission.
+    # Use only_levels=True for get the only levels entries
+    jira.get_project_issue_security_scheme(project_id_or_key, only_levels=False)
+
+
 Manage issues
 -------------
 
@@ -251,3 +258,17 @@ Issue link types
     # Update issue link type
     jira.update_issue_link_type(issue_link_type_id, data):
 
+Issue security schemes
+----------------------
+.. code-block:: python
+
+    # Get all security schemes.
+    # Returned if the user has the administrator permission or if the scheme is used in a project in which the
+    # user has the administrative permission.
+    jira.get_issue_security_schemes()
+
+    # Get issue security scheme.
+    # Returned if the user has the administrator permission or if the scheme is used in a project in which the
+    # user has the administrative permission.
+    # Use only_levels=True for get the only levels entries
+    jira.get_issue_security_scheme(scheme_id, only_levels=False)