magpie.api.management.service.service_views
===========================================

.. py:module:: magpie.api.management.service.service_views


Functions
---------

.. autoapisummary::

   magpie.api.management.service.service_views.get_service_types_view
   magpie.api.management.service.service_views.get_services_by_type_view
   magpie.api.management.service.service_views.get_services_view
   magpie.api.management.service.service_views.get_services_runner
   magpie.api.management.service.service_views.register_service_view
   magpie.api.management.service.service_views.update_service_view
   magpie.api.management.service.service_views.get_service_view
   magpie.api.management.service.service_views.unregister_service_view
   magpie.api.management.service.service_views.get_service_permissions_view
   magpie.api.management.service.service_views.get_service_resource_view
   magpie.api.management.service.service_views.delete_service_resource_view
   magpie.api.management.service.service_views.get_service_resources_view
   magpie.api.management.service.service_views.create_service_resource_view
   magpie.api.management.service.service_views.get_service_type_resources_view
   magpie.api.management.service.service_views.get_service_type_resource_types_view


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

.. py:function:: get_service_types_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all available service types.


.. py:function:: get_services_by_type_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all registered services from a specific type.


.. py:function:: get_services_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all registered services.


.. py:function:: get_services_runner(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Generates services response format from request conditions.

   Obtains the full or filtered list of services categorized by type, or listed as flat list according to request path
   and query parameters.


.. py:function:: register_service_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Registers a new service.


.. py:function:: update_service_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Update service information.


.. py:function:: get_service_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Get service information.


.. py:function:: unregister_service_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Unregister a service.


.. py:function:: get_service_permissions_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all applicable permissions for a service.


.. py:function:: get_service_resource_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Get resource information under a service.


.. py:function:: delete_service_resource_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Unregister a resource.


.. py:function:: get_service_resources_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all resources registered under a service.


.. py:function:: create_service_resource_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   Register a new resource directly under a service or under one of its children resources.


.. py:function:: get_service_type_resources_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List details of resource types supported under a specific service type.


.. py:function:: get_service_type_resource_types_view(request: pyramid.request.Request) -> magpie.typedefs.AnyResponseType

   List all resource types supported under a specific service type.