magpie.api.management.service.service_utils

Module Contents

Functions

create_service(→ pyramid.httpexceptions.HTTPException)

Generates an instance to register a new service.

get_services_by_type(→ Iterable[magpie.models.Service])

Obtains all services that correspond to requested service-type.

add_service_getcapabilities_perms(service, db_session)

filter_service_types(→ Optional[List[magpie.typedefs.Str]])

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

Attributes

LOGGER

magpie.api.management.service.service_utils.LOGGER[source]
magpie.api.management.service.service_utils.create_service(service_name: magpie.typedefs.Str, service_type: magpie.typedefs.Str, service_url: magpie.typedefs.Str, service_push: bool, service_config: magpie.typedefs.JSON | None, db_session: sqlalchemy.orm.session.Session) → pyramid.httpexceptions.HTTPException[source]

Generates an instance to register a new service.

magpie.api.management.service.service_utils.get_services_by_type(service_type: magpie.typedefs.Str, db_session: sqlalchemy.orm.session.Session) → Iterable[magpie.models.Service][source]

Obtains all services that correspond to requested service-type.

magpie.api.management.service.service_utils.add_service_getcapabilities_perms(service, db_session, group_name=None)[source]
magpie.api.management.service.service_utils.filter_service_types(service_query: magpie.typedefs.Str | None, default_services: bool = False) → List[magpie.typedefs.Str] | None[source]

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

Parameters:

  • service_query – query string or service type(s) comma-separated to parse.

  • 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.