magpie.api.swagger.views

Attributes

MAGPIE_MODULE_DIR

Functions

get_magpie_url(→ magpie.typedefs.Str)	Obtains the configured Magpie URL entrypoint based on the various combinations of supported configuration settings.
api_swagger(request)	Swagger UI route to display the Magpie REST API schemas.
api_schema(→ magpie.typedefs.JSON)	Return JSON Swagger specifications of Magpie REST API.

Module Contents

magpie.api.swagger.views.MAGPIE_MODULE_DIR

magpie.api.swagger.views.get_magpie_url(container: magpie.typedefs.AnySettingsContainer | None = None) → magpie.typedefs.Str

Obtains the configured Magpie URL entrypoint based on the various combinations of supported configuration settings.

See also

Documentation section Application Settings for available setting combinations.

Parameters:

container – container that provides access to application settings.

Returns:

resolved Magpie URL

magpie.api.swagger.views.api_swagger(request)

Swagger UI route to display the Magpie REST API schemas.

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

Return JSON Swagger specifications of Magpie REST API.