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 18cb6aa20..a2955a4e6 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" @@ -1180,13 +1180,19 @@ }, "/add_preset": { "post": { - "description": "新しいプリセットを追加します\n\nParameters\n-------\npreset: Preset\n 新しいプリセット。\n プリセットIDが既存のものと重複している場合は、新規のプリセットIDが採番されます。\n\nReturns\n-------\nid: int\n 追加したプリセットのプリセットID", + "description": "新しいプリセットを追加します", "operationId": "add_preset_add_preset_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Preset" + "allOf": [ + { + "$ref": "#/components/schemas/Preset" + } + ], + "description": "新しいプリセット。プリセットIDが既存のものと重複している場合は、新規のプリセットIDが採番されます。", + "title": "Preset" } } }, @@ -1202,7 +1208,7 @@ } } }, - "description": "Successful Response" + "description": "追加したプリセットのプリセットID" }, "422": { "content": { @@ -1479,14 +1485,16 @@ }, "/delete_preset": { "post": { - "description": "既存のプリセットを削除します\n\nParameters\n-------\nid: int\n 削除するプリセットのプリセットID", + "description": "既存のプリセットを削除します", "operationId": "delete_preset_delete_preset_post", "parameters": [ { + "description": "削除するプリセットのプリセットID", "in": "query", "name": "id", "required": true, "schema": { + "description": "削除するプリセットのプリセットID", "title": "Id", "type": "integer" } @@ -1515,7 +1523,7 @@ }, "/downloadable_libraries": { "get": { - "description": "ダウンロード可能な音声ライブラリの情報を返します。\n\nReturns\n-------\nret_data: list[DownloadableLibrary]", + "description": "ダウンロード可能な音声ライブラリの情報を返します。", "operationId": "downloadable_libraries_downloadable_libraries_get", "responses": { "200": { @@ -1530,7 +1538,7 @@ } } }, - "description": "Successful Response" + "description": "ダウンロード可能な音声ライブラリの情報リスト" } }, "summary": "Downloadable Libraries", @@ -1735,14 +1743,16 @@ }, "/install_library/{library_uuid}": { "post": { - "description": "音声ライブラリをインストールします。\n音声ライブラリのZIPファイルをリクエストボディとして送信してください。\n\nParameters\n----------\nlibrary_uuid: str\n 音声ライブラリのID", + "description": "音声ライブラリをインストールします。\n音声ライブラリのZIPファイルをリクエストボディとして送信してください。", "operationId": "install_library_install_library__library_uuid__post", "parameters": [ { + "description": "音声ライブラリのID", "in": "path", "name": "library_uuid", "required": true, "schema": { + "description": "音声ライブラリのID", "title": "Library Uuid", "type": "string" } @@ -1771,7 +1781,7 @@ }, "/installed_libraries": { "get": { - "description": "インストールした音声ライブラリの情報を返します。\n\nReturns\n-------\nret_data: dict[str, InstalledLibrary]", + "description": "インストールした音声ライブラリの情報を返します。", "operationId": "installed_libraries_installed_libraries_get", "responses": { "200": { @@ -1786,7 +1796,7 @@ } } }, - "description": "Successful Response" + "description": "インストールした音声ライブラリの情報" } }, "summary": "Installed Libraries", @@ -2187,7 +2197,7 @@ }, "/presets": { "get": { - "description": "エンジンが保持しているプリセットの設定を返します\n\nReturns\n-------\npresets: list[Preset]\n プリセットのリスト", + "description": "エンジンが保持しているプリセットの設定を返します", "operationId": "get_presets_presets_get", "responses": { "200": { @@ -2202,7 +2212,7 @@ } } }, - "description": "Successful Response" + "description": "プリセットのリスト" } }, "summary": "Get Presets", @@ -2718,14 +2728,16 @@ }, "/uninstall_library/{library_uuid}": { "post": { - "description": "音声ライブラリをアンインストールします。\n\nParameters\n----------\nlibrary_uuid: str\n 音声ライブラリのID", + "description": "音声ライブラリをアンインストールします。", "operationId": "uninstall_library_uninstall_library__library_uuid__post", "parameters": [ { + "description": "音声ライブラリのID", "in": "path", "name": "library_uuid", "required": true, "schema": { + "description": "音声ライブラリのID", "title": "Library Uuid", "type": "string" } @@ -2754,13 +2766,19 @@ }, "/update_preset": { "post": { - "description": "既存のプリセットを更新します\n\nParameters\n-------\npreset: Preset\n 更新するプリセット。\n プリセットIDが更新対象と一致している必要があります。\n\nReturns\n-------\nid: int\n 更新したプリセットのプリセットID", + "description": "既存のプリセットを更新します", "operationId": "update_preset_update_preset_post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Preset" + "allOf": [ + { + "$ref": "#/components/schemas/Preset" + } + ], + "description": "更新するプリセット。プリセットIDが更新対象と一致している必要があります。", + "title": "Preset" } } }, @@ -2776,7 +2794,7 @@ } } }, - "description": "Successful Response" + "description": "更新したプリセットのプリセットID" }, "422": { "content": { @@ -2797,7 +2815,7 @@ }, "/user_dict": { "get": { - "description": "ユーザー辞書に登録されている単語の一覧を返します。\n単語の表層形(surface)は正規化済みの物を返します。\n\nReturns\n-------\ndict[str, UserDictWord]\n 単語のUUIDとその詳細", + "description": "ユーザー辞書に登録されている単語の一覧を返します。\n単語の表層形(surface)は正規化済みの物を返します。", "operationId": "get_user_dict_words_user_dict_get", "responses": { "200": { @@ -2812,7 +2830,7 @@ } } }, - "description": "Successful Response" + "description": "単語のUUIDとその詳細" } }, "summary": "Get User Dict Words", @@ -3052,14 +3070,16 @@ }, "/validate_kana": { "post": { - "description": "テキストがAquesTalk 風記法に従っているかどうかを判定します。\n従っていない場合はエラーが返ります。\n\nParameters\n----------\ntext: str\n 判定する対象の文字列", + "description": "テキストがAquesTalk 風記法に従っているかどうかを判定します。\n従っていない場合はエラーが返ります。", "operationId": "validate_kana_validate_kana_post", "parameters": [ { + "description": "判定する対象の文字列", "in": "query", "name": "text", "required": true, "schema": { + "description": "判定する対象の文字列", "title": "Text", "type": "string" }