magpie.api.management.resource.resource_views
=============================================

.. py:module:: magpie.api.management.resource.resource_views


Functions
---------

.. autoapisummary::

   magpie.api.management.resource.resource_views.get_resources_view
   magpie.api.management.resource.resource_views.get_resource_handler
   magpie.api.management.resource.resource_views.get_resource_view
   magpie.api.management.resource.resource_views.create_resource_view
   magpie.api.management.resource.resource_views.delete_resource_view
   magpie.api.management.resource.resource_views.update_resource
   magpie.api.management.resource.resource_views.get_resource_permissions_view
   magpie.api.management.resource.resource_views.get_resource_types_view
   magpie.api.management.resource.resource_views.update_permissions


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

.. py:function:: get_resources_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   List all registered resources.


.. py:function:: get_resource_handler(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Obtains the resource specified by the request with all applicable parameter validation and handling.


.. py:function:: get_resource_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Get resource information.


.. py:function:: create_resource_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Register a new resource.


.. py:function:: delete_resource_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Unregister a resource.


.. py:function:: update_resource(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Update a resource information.


.. py:function:: get_resource_permissions_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   List all applicable permissions for a resource.


.. py:function:: get_resource_types_view(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   List all applicable children resource types under another resource within a service hierarchy.


.. py:function:: update_permissions(request: magpie.typedefs.AnyRequestType) -> magpie.typedefs.AnyResponseType

   Update the requested permissions and create missing related resources if necessary.