mirror of
https://github.com/arcan1s/ahriman.git
synced 2026-04-01 06:03:39 +00:00
docs: update docstrings
This commit is contained in:
@@ -57,7 +57,7 @@ class DocsView(BaseView):
|
||||
@aiohttp_jinja2.template("api.jinja2")
|
||||
async def get(self) -> dict[str, Any]:
|
||||
"""
|
||||
return static docs html
|
||||
return static docs HTML
|
||||
|
||||
Returns:
|
||||
dict[str, Any]: parameters for jinja template
|
||||
|
||||
@@ -60,7 +60,7 @@ class SwaggerView(BaseView):
|
||||
get api specification
|
||||
|
||||
Returns:
|
||||
Response: 200 with json api specification
|
||||
Response: 200 with JSON api specification
|
||||
"""
|
||||
spec = self.request.app["swagger_dict"]
|
||||
is_body_parameter: Callable[[dict[str, str]], bool] = lambda p: p["in"] == "body" or p["in"] == "formData"
|
||||
|
||||
@@ -169,7 +169,7 @@ class BaseView(View, CorsViewMixin):
|
||||
filter and convert data and return :class:`aiohttp.web.Response` object
|
||||
|
||||
Args:
|
||||
data(dict[str, Any] | list[Any]): response in json format
|
||||
data(dict[str, Any] | list[Any]): response in JSON format
|
||||
**kwargs(Any): keyword arguments for :func:`aiohttp.web.json_response` function
|
||||
|
||||
Returns:
|
||||
|
||||
Reference in New Issue
Block a user