From 67dbf5f19a1aa2fd9f8f0baac5ab2ab48064a682 Mon Sep 17 00:00:00 2001
From: tarepan <tarepan5884@gmail.com>
Date: Tue, 14 May 2024 14:22:59 +0900
Subject: [PATCH] =?UTF-8?q?=E8=BF=BD=E5=8A=A0:=20=E3=82=A8=E3=83=B3?=
 =?UTF-8?q?=E3=82=B8=E3=83=B3=E6=83=85=E5=A0=B1=E5=8F=96=E5=BE=97=20API=20?=
 =?UTF-8?q?=E3=81=AB=E3=83=89=E3=82=AD=E3=83=A5=E3=83=A1=E3=83=B3=E3=83=88?=
 =?UTF-8?q?=E3=82=92=E8=BF=BD=E5=8A=A0=20(#1223)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

add: エンジン情報取得 API にドキュメントを追加
---
 ...\343\201\250\343\202\222\347\242\272\350\252\215.json" | 4 ++++
 voicevox_engine/app/routers/engine_info.py                | 8 +++++---
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git "a/test/e2e/__snapshots__/test_openapi/test_OpenAPI\343\201\256\345\275\242\343\201\214\345\244\211\343\202\217\343\201\243\343\201\246\343\201\204\343\201\252\343\201\204\343\201\223\343\201\250\343\202\222\347\242\272\350\252\215.json" "b/test/e2e/__snapshots__/test_openapi/test_OpenAPI\343\201\256\345\275\242\343\201\214\345\244\211\343\202\217\343\201\243\343\201\246\343\201\204\343\201\252\343\201\204\343\201\223\343\201\250\343\202\222\347\242\272\350\252\215.json"
index 64091444f..5f08bd4f9 100644
--- "a/test/e2e/__snapshots__/test_openapi/test_OpenAPI\343\201\256\345\275\242\343\201\214\345\244\211\343\202\217\343\201\243\343\201\246\343\201\204\343\201\252\343\201\204\343\201\223\343\201\250\343\202\222\347\242\272\350\252\215.json"
+++ "b/test/e2e/__snapshots__/test_openapi/test_OpenAPI\343\201\256\345\275\242\343\201\214\345\244\211\343\202\217\343\201\243\343\201\246\343\201\204\343\201\252\343\201\204\343\201\223\343\201\250\343\202\222\347\242\272\350\252\215.json"
@@ -1498,6 +1498,7 @@
     },
     "/core_versions": {
       "get": {
+        "description": "利用可能なコアのバージョン一覧を取得します。",
         "operationId": "core_versions_core_versions_get",
         "responses": {
           "200": {
@@ -1587,6 +1588,7 @@
     },
     "/engine_manifest": {
       "get": {
+        "description": "エンジンマニフェストを取得します。",
         "operationId": "engine_manifest_engine_manifest_get",
         "responses": {
           "200": {
@@ -2632,6 +2634,7 @@
     },
     "/supported_devices": {
       "get": {
+        "description": "対応デバイスの一覧を取得します。",
         "operationId": "supported_devices_supported_devices_get",
         "parameters": [
           {
@@ -3229,6 +3232,7 @@
     },
     "/version": {
       "get": {
+        "description": "エンジンのバージョンを取得します。",
         "operationId": "version_version_get",
         "responses": {
           "200": {
diff --git a/voicevox_engine/app/routers/engine_info.py b/voicevox_engine/app/routers/engine_info.py
index 441792e72..6ad6ce768 100644
--- a/voicevox_engine/app/routers/engine_info.py
+++ b/voicevox_engine/app/routers/engine_info.py
@@ -21,10 +21,12 @@ def generate_engine_info_router(
 
     @router.get("/version", tags=["その他"])
     async def version() -> str:
+        """エンジンのバージョンを取得します。"""
         return __version__
 
     @router.get("/core_versions", response_model=list[str], tags=["その他"])
     async def core_versions() -> Response:
+        """利用可能なコアのバージョン一覧を取得します。"""
         return Response(
             content=json.dumps(list(cores.keys())),
             media_type="application/json",
@@ -33,9 +35,8 @@ async def core_versions() -> Response:
     @router.get(
         "/supported_devices", response_model=SupportedDevicesInfo, tags=["その他"]
     )
-    def supported_devices(
-        core_version: str | None = None,
-    ) -> Response:
+    def supported_devices(core_version: str | None = None) -> Response:
+        """対応デバイスの一覧を取得します。"""
         supported_devices = get_core(core_version).supported_devices
         if supported_devices is None:
             raise HTTPException(status_code=422, detail="非対応の機能です。")
@@ -46,6 +47,7 @@ def supported_devices(
 
     @router.get("/engine_manifest", response_model=EngineManifest, tags=["その他"])
     async def engine_manifest() -> EngineManifest:
+        """エンジンマニフェストを取得します。"""
         return engine_manifest_data
 
     return router