feat: add healh-check like endpoint, support of healthcheck in docker compose

src/ahriman/web/schemas/__init__.py

@@ -24,6 +24,7 @@ from ahriman.web.schemas.changes_schema import ChangesSchema
 from ahriman.web.schemas.counters_schema import CountersSchema
 from ahriman.web.schemas.error_schema import ErrorSchema
 from ahriman.web.schemas.file_schema import FileSchema
+from ahriman.web.schemas.info_schema import InfoSchema
 from ahriman.web.schemas.internal_status_schema import InternalStatusSchema
 from ahriman.web.schemas.log_schema import LogSchema
 from ahriman.web.schemas.login_schema import LoginSchema

src/ahriman/web/schemas/info_schema.py

@@ -0,0 +1,40 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from marshmallow import Schema, fields
+
+from ahriman import __version__
+from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema
+
+
+class InfoSchema(Schema):
+    """
+    response service information schema
+    """
+
+    auth = fields.Boolean(dump_default=False, required=True, metadata={
+        "description": "Whether authentication is enabled or not",
+    })
+    repositories = fields.Nested(RepositoryIdSchema(many=True), required=True, metadata={
+        "description": "List of loaded repositories",
+    })
+    version = fields.String(required=True, metadata={
+        "description": "Service version",
+        "example": __version__,
+    })

src/ahriman/web/schemas/internal_status_schema.py

@@ -37,6 +37,6 @@ class InternalStatusSchema(RepositoryIdSchema):
         "description": "Repository status as stored by web service",
     })
     version = fields.String(required=True, metadata={
-        "description": "Repository version",
+        "description": "Service version",
         "example": __version__,
     })

src/ahriman/web/views/v1/status/info.py

@@ -0,0 +1,70 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+import aiohttp_apispec  # type: ignore[import-untyped]
+
+from aiohttp.web import Response, json_response
+
+from ahriman import __version__
+from ahriman.models.user_access import UserAccess
+from ahriman.web.schemas import AuthSchema, ErrorSchema, InfoSchema
+from ahriman.web.views.base import BaseView
+
+
+class InfoView(BaseView):
+    """
+    web service information view
+
+    Attributes:
+        GET_PERMISSION(UserAccess): (class attribute) get permissions of self
+    """
+
+    GET_PERMISSION = UserAccess.Unauthorized
+    ROUTES = ["/api/v1/info"]
+
+    @aiohttp_apispec.docs(
+        tags=["Status"],
+        summary="Service information",
+        description="Perform basic service health check and returns its information",
+        responses={
+            200: {"description": "Success response", "schema": InfoSchema},
+            401: {"description": "Authorization required", "schema": ErrorSchema},
+            403: {"description": "Access is forbidden", "schema": ErrorSchema},
+            500: {"description": "Internal server error", "schema": ErrorSchema},
+        },
+        security=[{"token": [GET_PERMISSION]}],
+    )
+    @aiohttp_apispec.cookies_schema(AuthSchema)
+    async def get(self) -> Response:
+        """
+        get service information
+
+        Returns:
+            Response: 200 with service information object
+        """
+        response = {
+            "auth": self.validator.enabled,
+            "repositories": [
+                repository_id.view()
+                for repository_id in sorted(self.services)
+            ],
+            "version": __version__,
+        }
+
+        return json_response(response)