magpie.api.management.service.service_utils
===========================================

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


Attributes
----------

.. autoapisummary::

   magpie.api.management.service.service_utils.LOGGER


Functions
---------

.. autoapisummary::

   magpie.api.management.service.service_utils.create_service
   magpie.api.management.service.service_utils.get_services_by_type
   magpie.api.management.service.service_utils.add_service_getcapabilities_perms
   magpie.api.management.service.service_utils.filter_service_types


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

.. py:data:: LOGGER

.. py:function:: create_service(service_name: magpie.typedefs.Str, service_type: magpie.typedefs.Str, service_url: magpie.typedefs.Str, service_push: bool, service_config: Optional[magpie.typedefs.JSON], db_session: sqlalchemy.orm.session.Session) -> pyramid.httpexceptions.HTTPException

   Generates an instance to register a new service.


.. py:function:: get_services_by_type(service_type: magpie.typedefs.Str, db_session: sqlalchemy.orm.session.Session) -> Iterable[magpie.models.Service]

   Obtains all services that correspond to requested service-type.


.. py:function:: add_service_getcapabilities_perms(service, db_session, group_name=None)

.. py:function:: filter_service_types(service_query: Optional[magpie.typedefs.Str], default_services: bool = False) -> Optional[List[magpie.typedefs.Str]]

   Obtains all valid case-insensitive service-type names from a filtered comma-separated list.

   :param service_query: query string or service type(s) comma-separated to parse.
   :param default_services: specify if the complete list of known service-types must be returned if no query to parse.
   :returns: parsed service-types if query was provided, or None by default, or all known service-types if requested.