ahriman.web.views.api package

Submodules

ahriman.web.views.api.docs module

class DocsView(request: None)

Bases: BaseView

api docs view

GET_PERMISSION

(class attribute) get permissions of self

Type:

UserAccess

classmethod routes(configuration: Configuration) → list[str]

extract routes list for the view

Parameters:

configuration (Configuration) – configuration instance

Returns:

list of routes defined for the view. By default, it tries to read ROUTES option if set and returns empty list otherwise

Return type:

list[str]

async get() → dict[str, Any]

return static docs html

Returns:

parameters for jinja template

Return type:

dict[str, Any]

ahriman.web.views.api.swagger module

class SwaggerView(request: None)

Bases: BaseView

api docs specification view

GET_PERMISSION

(class attribute) get permissions of self

Type:

UserAccess

classmethod routes(configuration: Configuration) → list[str]

extract routes list for the view

Parameters:

configuration (Configuration) – configuration instance

Returns:

list of routes defined for the view. By default, it tries to read ROUTES option if set and returns empty list otherwise

Return type:

list[str]

async get() → Response

get api specification

Returns:

200 with json api specification

Return type:

Response

Module contents