cowbird.api.swagger

Submodules

• cowbird.api.swagger.views

Functions

api_schema(→ cowbird.typedefs.JSON)	Return JSON Swagger specifications of Cowbird REST API.
api_swagger(→ cowbird.typedefs.JSON)	Swagger UI route to display the Cowbird 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(→ None)

Package Contents

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

Return JSON Swagger specifications of Cowbird REST API.

cowbird.api.swagger.api_swagger(request: pyramid.request.Request) → cowbird.typedefs.JSON

Swagger UI route to display the Cowbird REST API schemas.

cowbird.api.swagger.get_logger(name: str, level: int | None = None, force_stdout: bool = None, message_format: str | None = None, datetime_format: 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.

cowbird.api.swagger.includeme(config: pyramid.config.Configurator) → None