:py:mod:`k8s_client.views.roles`
================================

.. py:module:: k8s_client.views.roles


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   k8s_client.views.roles.get_roles



.. py:function:: get_roles(name=None)

   Get roles list

   Parameters
   ----------
   ``"name"``: `string` (optional)
       The name of the role to search. 

   Returns
   -------
   - JSON containing the full list of roles if ``name`` is `None`
   - JSON containing the details of the specified role if ``name`` is a `<valid name>`
   - Error message with return code `404` if ``name`` is **NOT** a `<valid name>`