api Package

api Package

app Module

class payload.api.app.VersionSelectorApplication

Bases: object

payload.api.app.app_factory(global_config, **local_conf)
payload.api.app.build_server()
payload.api.app.get_handler_cls()
payload.api.app.get_pecan_config()
payload.api.app.get_server_cls(host)

Return an appropriate WSGI server class base on provided host

Parameters:host – The listen host for the ceilometer API server.
payload.api.app.load_app()
payload.api.app.setup_app(pecan_config=None)

config Module

hooks Module

class payload.api.hooks.DBHook

Bases: pecan.hooks.PecanHook

before(state)
class payload.api.hooks.MiddlewareHook

Bases: pecan.hooks.PecanHook

before(state)

middleware Module

Middleware to replace the plain text message body of an error response with one formatted so the client can parse it.

Based on pecan.middleware.errordocument

class payload.api.middleware.ParsableErrorMiddleware(app)

Bases: object

Replace error body with something the client can parse.