From b38d2c44f79a4cc4e98dfe32cbaaf797613e3781 Mon Sep 17 00:00:00 2001 From: "makabe.t" Date: Thu, 21 Sep 2023 04:51:00 +0000 Subject: [PATCH] =?UTF-8?q?Merged=20PR=20428:=20API=20IF=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## 概要 [Task2714: API IF修正](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2714) - 以下のAPIのIFを修正しました。 - テンプレートファイル一覧取得API - テンプレートファイルアップロード完了API ## レビューポイント - 想定通りの修正となっているか。 ## UIの変更 - なし ## 動作確認状況 - ローカルで確認 --- dictation_server/src/api/odms/openapi.json | 25 ++++++++++--------- .../src/features/files/files.controller.ts | 5 ++-- .../src/features/files/types/types.ts | 7 +++--- .../src/features/templates/types/types.ts | 4 +-- 4 files changed, 22 insertions(+), 19 deletions(-) diff --git a/dictation_server/src/api/odms/openapi.json b/dictation_server/src/api/odms/openapi.json index d91cfc5..caf1c85 100644 --- a/dictation_server/src/api/odms/openapi.json +++ b/dictation_server/src/api/odms/openapi.json @@ -3792,7 +3792,7 @@ "properties": { "url": { "type": "string" } }, "required": ["url"] }, - "TemplateFile": { + "TemplateUploadFinishedRequest": { "type": "object", "properties": { "name": { @@ -3801,21 +3801,11 @@ }, "url": { "type": "string", - "description": "テンプレートファイルのURL" + "description": "テンプレートファイルのアップロード先URL" } }, "required": ["name", "url"] }, - "TemplateUploadFinishedRequest": { - "type": "object", - "properties": { - "templateFile": { - "description": "テンプレートファイルのファイル情報", - "allOf": [{ "$ref": "#/components/schemas/TemplateFile" }] - } - }, - "required": ["templateFile"] - }, "TemplateUploadFinishedReqponse": { "type": "object", "properties": {} }, "Assignee": { "type": "object", @@ -4023,6 +4013,17 @@ "required": ["poNumber"] }, "CancelOrderResponse": { "type": "object", "properties": {} }, + "TemplateFile": { + "type": "object", + "properties": { + "id": { "type": "number", "description": "テンプレートファイルのID" }, + "name": { + "type": "string", + "description": "テンプレートファイルのファイル名" + } + }, + "required": ["id", "name"] + }, "GetTemplatesResponse": { "type": "object", "properties": { diff --git a/dictation_server/src/features/files/files.controller.ts b/dictation_server/src/features/files/files.controller.ts index eb0d311..8a89dc4 100644 --- a/dictation_server/src/features/files/files.controller.ts +++ b/dictation_server/src/features/files/files.controller.ts @@ -331,13 +331,14 @@ export class FilesController { @Req() req: Request, @Body() body: TemplateUploadFinishedRequest, ): Promise { - const { templateFile } = body; + const { name, url } = body; const token = retrieveAuthorizationToken(req); const accessToken = jwt.decode(token, { json: true }) as AccessToken; const context = makeContext(accessToken.userId); console.log(context.trackingId); - console.log(templateFile); + console.log(name); + console.log(url); return {}; } diff --git a/dictation_server/src/features/files/types/types.ts b/dictation_server/src/features/files/types/types.ts index ed38f54..2de8a4a 100644 --- a/dictation_server/src/features/files/types/types.ts +++ b/dictation_server/src/features/files/types/types.ts @@ -1,5 +1,4 @@ import { ApiProperty } from '@nestjs/swagger'; -import { TemplateFile } from '../../templates/types/types'; export class AudioUploadLocationRequest {} @@ -95,8 +94,10 @@ export class AudioUploadFinishedResponse { } export class TemplateUploadFinishedRequest { - @ApiProperty({ description: 'テンプレートファイルのファイル情報' }) - templateFile: TemplateFile; + @ApiProperty({ description: 'テンプレートファイルのファイル名' }) + name: string; + @ApiProperty({ description: 'テンプレートファイルのアップロード先URL' }) + url: string; } export class TemplateUploadFinishedReqponse {} diff --git a/dictation_server/src/features/templates/types/types.ts b/dictation_server/src/features/templates/types/types.ts index a331ad8..243298d 100644 --- a/dictation_server/src/features/templates/types/types.ts +++ b/dictation_server/src/features/templates/types/types.ts @@ -1,10 +1,10 @@ import { ApiProperty } from '@nestjs/swagger'; export class TemplateFile { + @ApiProperty({ description: 'テンプレートファイルのID' }) + id: number; @ApiProperty({ description: 'テンプレートファイルのファイル名' }) name: string; - @ApiProperty({ description: 'テンプレートファイルのURL' }) - url: string; } export class GetTemplatesResponse {