ahriman.web.apispec package

Submodules

ahriman.web.apispec.decorators module

apidocs(*, tags: list[str], summary: str, description: str, permission: UserAccess, response_code: type[HTTPException] | None = None, error_400_enabled: bool = False, error_404_description: str | None = None, schema: Mock | type[Mock] | None = None, match_schema: Mock | type[Mock] | None = None, query_schema: Mock | type[Mock] | None = None, body_schema: Mock | type[Mock] | None = None, body_location: str = 'json') → Callable[[...], Any]

wrapper around aiohttp_apispec to decorate HTTP methods

Parameters:

  • tags (list[str]) – list of tags for the endpoint

  • summary (str) – summary for the endpoint

  • description (str) – long description for the endpoint

  • permission (UserAccess) – permission to access endpoint

  • response_code (type[HTTPException] | None, optional) – code for the success response. If none set it will be defined automatically (Default value = None)

  • error_400_enabled (bool, optional) – include response for 404 codes (Default value = False)

  • error_404_description (str | None, optional) – description for 404 codes if available (Default value = None)

  • schema (Schema | type[Schema] | None) – response schema type, set None for empty responses (Default value = None)

  • match_schema (Schema | type[Schema] | None) – schema for uri matcher if used (Default value = None)

  • query_schema (Schema | type[Schema] | None) – query string schema type, set None if not applicable (Default value = None)

  • body_schema (Schema | type[Schema] | None) – body schema type, set None if not applicable (Default value = None)

  • body_location (str, optional) – body location name (Default value = “json”)

Returns:

decorated function

Return type:

Callable[…, Any]

ahriman.web.apispec.info module

setup_apispec(application: Application) → Any

setup swagger api specification

Parameters:

application (Application) – web application instance

Returns:

created specification instance if module is available

Return type:

Any

Module contents

Schema

alias of Mock