magpie.api.swagger

Submodules

• magpie.api.swagger.views

Attributes

LOGGER

Functions

api_schema(→ magpie.typedefs.JSON)	Return JSON Swagger specifications of Magpie REST API.
api_swagger(request)	Swagger UI route to display the Magpie REST API schemas.
get_logger(→ logging.Logger)	Immediately sets the logger level to avoid duplicate log outputs from the root logger and this logger when
includeme(config)

Package Contents

magpie.api.swagger.api_schema(request: pyramid.request.Request) → magpie.typedefs.JSON

Return JSON Swagger specifications of Magpie REST API.

magpie.api.swagger.api_swagger(request)

Swagger UI route to display the Magpie REST API schemas.

magpie.api.swagger.get_logger(name: magpie.typedefs.Str, level: int | None = None, force_stdout: bool = None, message_format: magpie.typedefs.Str | None = None, datetime_format: magpie.typedefs.Str | None = None) → logging.Logger

Immediately sets the logger level to avoid duplicate log outputs from the root logger and this logger when level is logging.NOTSET.

magpie.api.swagger.LOGGER

magpie.api.swagger.includeme(config)