From 3b125ce569ff365d51a035621ae78b0b8ee1012f Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 00:28:25 +0900 Subject: [PATCH 01/15] fix: signin -> signup --- .../docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 2c3e0e07..10f116d2 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -61,7 +61,7 @@ paths: $ref: '#/components/responses/InternalServer' '503': $ref: '#/components/responses/ServiceUnavailable' - /signin: + /signup: post: tags: - account @@ -524,7 +524,7 @@ components: type: string format: password description: パスワード - SigninRequest: + SignupRequest: type: object properties: email: @@ -619,7 +619,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/SigninRequest' + $ref: '#/components/schemas/SignupRequest' ReqPostBookingBody: required: true content: From fd68aa54f2c96dc08974406be76b5d0ebfe70d99 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 00:39:26 +0900 Subject: [PATCH 02/15] fix: trainer --- .../openapi.yaml" | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 10f116d2..584863c6 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -421,7 +421,7 @@ paths: responses: '200': description: 口コミ削除成功 - /trainer-register: + /trainer: post: tags: - provider @@ -431,13 +431,12 @@ paths: responses: '200': description: トレーナー登録成功 - /trainer-attributes: put: tags: - provider summary: API-021 トレーナー属性更新 requestBody: - $ref: '#/components/requestBodies/ReqPostTrainerAttributesBody' + $ref: '#/components/requestBodies/ReqPostTrainerBody' responses: '200': description: トレーナー属性更新成功 @@ -591,13 +590,6 @@ components: type: string age: type: integer - TrainerAttributes: - type: object - properties: - speciality: - type: string - experience: - type: integer TrainingMenu: type: object properties: @@ -656,12 +648,6 @@ components: application/json: schema: $ref: '#/components/schemas/Trainer' - ReqPostTrainerAttributesBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TrainerAttributes' ReqPostTrainingMenuBody: required: true content: From 9d716eacf42c24bf5440411066a2d00e02ea6f53 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 00:46:49 +0900 Subject: [PATCH 03/15] fix: operationId camel -> upper camel --- .../openapi.yaml" | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 584863c6..67d3944f 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -26,7 +26,7 @@ paths: tags: - account summary: API-001 ログイン - operationId: loginUser + operationId: LoginUser security: [] requestBody: $ref: '#/components/requestBodies/ReqPostLoginBody' @@ -44,7 +44,7 @@ paths: tags: - account summary: API-002 ログアウト - operationId: logoutUser + operationId: LogoutUser security: [] responses: '200': @@ -66,7 +66,7 @@ paths: tags: - account summary: API-003 会員登録 - operationId: registerUser + operationId: RegisterUser security: [] requestBody: $ref: '#/components/requestBodies/ReqPostSigninBody' @@ -84,7 +84,7 @@ paths: tags: - account summary: API-004 会員退会 - operationId: signoutUser + operationId: SignoutUser responses: '200': description: 会員退会に成功しました。 @@ -101,7 +101,7 @@ paths: tags: - profile summary: API-005 自分のプロフィール表示 - operationId: getUserProfile + operationId: GetUserProfile responses: '200': description: プロフィールの取得に成功しました。 @@ -116,7 +116,7 @@ paths: tags: - trainer summary: API-006 パーソナルトレーナー検索 - operationId: searchTrainers + operationId: SearchTrainers security: [] responses: '200': @@ -132,7 +132,7 @@ paths: tags: - trainer summary: API-007 トレーニングメニュー取得 - operationId: getTrainingMenu + operationId: GetTrainingMenu security: [] parameters: - name: trainer_id @@ -158,7 +158,7 @@ paths: tags: - trainer summary: API-008 トレーナープロフィール取得 - operationId: getTrainerProfile + operationId: GetTrainerProfile security: [] parameters: - name: trainer_id @@ -183,7 +183,7 @@ paths: tags: - trainer summary: API-009 トレーナー口コミ取得 - operationId: getTrainerReviews + operationId: GetTrainerReviews security: [] parameters: - name: trainer_id @@ -208,7 +208,7 @@ paths: tags: - trainer summary: API-010 トレーナースケジュール取得 - operationId: getTrainerSchedule + operationId: GetTrainerSchedule security: [] parameters: - name: trainer_id @@ -233,7 +233,7 @@ paths: tags: - booking summary: API-011 予約済みトレーニング取得 - operationId: getBookings + operationId: GetBookings responses: '200': description: ユーザーの予約情報を取得しました。 @@ -247,7 +247,7 @@ paths: tags: - booking summary: API-012 トレーニング予約（仮登録） - operationId: bookTraining + operationId: BookTraining requestBody: $ref: '#/components/requestBodies/ReqPostBookingBody' responses: @@ -270,7 +270,7 @@ paths: tags: - booking summary: API-013 トレーニング予約削除 - operationId: deleteBooking + operationId: DeleteBooking parameters: - name: booking_id in: path @@ -296,7 +296,7 @@ paths: tags: - booking summary: API-014 トレーニング予約（本登録） - operationId: confirmBooking + operationId: ConfirmBooking parameters: - name: booking_id in: path @@ -326,7 +326,7 @@ paths: tags: - booking summary: API-015 トレーニング受講ステータス変更 - operationId: updateTrainingStatus + operationId: UpdateTrainingStatus parameters: - name: booking_id in: path @@ -358,7 +358,7 @@ paths: tags: - payment summary: API-016 決済 - operationId: makePayment + operationId: MakePayment requestBody: $ref: '#/components/requestBodies/ReqPostPaymentBody' responses: From ac311b2dbfc7e12671a31d86748b164b185b3983 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 10:09:16 +0900 Subject: [PATCH 04/15] fix: add attribute to request and fix requestBody --- .../openapi.yaml" | 38 ++++++++++--------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 67d3944f..65e0d993 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -399,11 +399,7 @@ paths: schema: type: string requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Review' + $ref: '#/components/requestBodies/ReqPostReviewBody' responses: '200': description: 口コミ修正成功 @@ -463,11 +459,7 @@ paths: schema: type: integer requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TrainingMenu' + $ref: '#/components/requestBodies/ReqPostTrainingMenuBody' responses: '200': description: トレーニングメニュー更新成功 @@ -540,13 +532,20 @@ components: BookingRequest: type: object properties: - trainingId: + menu_id: type: string - description: トレーニングのID - date: + description: トレーニングメニューのID + trainee_id: + type: string + description: トレーニーID + training_start_at: + type: string + format: date + description: トレーニング開始日時 + training_end_at: type: string format: date - description: トレーニングの日付 + description: トレーニング終了日時 PaymentRequest: type: object properties: @@ -560,18 +559,21 @@ components: BookingConfirmationRequest: type: object properties: - bookingId: + booking_id: type: string description: 予約のID + booking_status_kbn: + type: string + description: 予約ステータス区分 TrainingStatusUpdateRequest: type: object properties: - trainingId: + booking_id: type: string description: トレーニングのID - status: + training_status_kbn: type: string - description: ステータス + description: トレーニングステータス区分 Review: type: object properties: From ad9c9cecd738295affe48850dbb17be8b0ddbc07 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 10:18:33 +0900 Subject: [PATCH 05/15] rm: requestBodies --- .../openapi.yaml" | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 65e0d993..46d40eb7 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -29,7 +29,11 @@ paths: operationId: LoginUser security: [] requestBody: - $ref: '#/components/requestBodies/ReqPostLoginBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LoginRequest' responses: '200': description: ログインに成功しました。 @@ -69,7 +73,11 @@ paths: operationId: RegisterUser security: [] requestBody: - $ref: '#/components/requestBodies/ReqPostSigninBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignupRequest' responses: '200': description: 会員登録に成功しました。 @@ -399,7 +407,11 @@ paths: schema: type: string requestBody: - $ref: '#/components/requestBodies/ReqPostReviewBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Review' responses: '200': description: 口コミ修正成功 @@ -602,18 +614,6 @@ components: description: type: string requestBodies: - ReqPostLoginBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/LoginRequest' - ReqPostSigninBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignupRequest' ReqPostBookingBody: required: true content: From a73c4d2c4efa33b387682274b1f087c2f9a0bb27 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Fri, 28 Jun 2024 10:22:10 +0900 Subject: [PATCH 06/15] rm: requestBodies --- .../openapi.yaml" | 97 +++++++++---------- 1 file changed, 45 insertions(+), 52 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 46d40eb7..a8b4ba7e 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -257,7 +257,11 @@ paths: summary: API-012 トレーニング予約（仮登録） operationId: BookTraining requestBody: - $ref: '#/components/requestBodies/ReqPostBookingBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BookingRequest' responses: '200': description: 予約が仮登録されました。 @@ -313,7 +317,11 @@ paths: schema: type: string requestBody: - $ref: '#/components/requestBodies/ReqPostBookingConfirmationBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BookingConfirmationRequest' responses: '200': description: 予約が本登録されました。 @@ -343,7 +351,11 @@ paths: schema: type: string requestBody: - $ref: '#/components/requestBodies/ReqPostTrainingStatusUpdateBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrainingStatusUpdateRequest' responses: '200': description: ステータスが更新されました。 @@ -368,7 +380,11 @@ paths: summary: API-016 決済 operationId: MakePayment requestBody: - $ref: '#/components/requestBodies/ReqPostPaymentBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRequest' responses: '200': description: 決済が完了しました。 @@ -390,7 +406,11 @@ paths: - review summary: API-017 口コミ登録 requestBody: - $ref: '#/components/requestBodies/ReqPostReviewBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Review' responses: '200': description: 口コミ登録成功 @@ -435,7 +455,11 @@ paths: - provider summary: API-020 トレーナー登録 requestBody: - $ref: '#/components/requestBodies/ReqPostTrainerBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Trainer' responses: '200': description: トレーナー登録成功 @@ -444,7 +468,11 @@ paths: - provider summary: API-021 トレーナー属性更新 requestBody: - $ref: '#/components/requestBodies/ReqPostTrainerBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Trainer' responses: '200': description: トレーナー属性更新成功 @@ -454,7 +482,11 @@ paths: - provider summary: API-022 トレーニングメニュー登録 requestBody: - $ref: '#/components/requestBodies/ReqPostTrainingMenuBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrainingMenu' responses: '200': description: トレーニングメニュー登録成功 @@ -471,7 +503,11 @@ paths: schema: type: integer requestBody: - $ref: '#/components/requestBodies/ReqPostTrainingMenuBody' + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrainingMenu' responses: '200': description: トレーニングメニュー更新成功 @@ -613,49 +649,6 @@ components: type: string description: type: string - requestBodies: - ReqPostBookingBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/BookingRequest' - ReqPostPaymentBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - ReqPostBookingConfirmationBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/BookingConfirmationRequest' - ReqPostTrainingStatusUpdateBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TrainingStatusUpdateRequest' - ReqPostReviewBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Review' - ReqPostTrainerBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Trainer' - ReqPostTrainingMenuBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TrainingMenu' responses: BadRequest: description: 400 Bad Request From 32cb8149b791584c8694c063662be5c98d7dc5b9 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 07:14:20 +0900 Subject: [PATCH 07/15] fix: operationId upper camel case to camel case --- .../openapi.yaml" | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index da8d6df2..74d0b14e 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -48,7 +48,7 @@ paths: tags: - account summary: API-002 ログアウト - operationId: Logout + operationId: logout security: [] responses: '200': @@ -70,7 +70,7 @@ paths: tags: - account summary: API-003 会員登録 - operationId: Signup + operationId: signup security: [] requestBody: required: true @@ -92,7 +92,7 @@ paths: tags: - account summary: API-004 会員退会 - operationId: DeleteAccount + operationId: deleteAccount responses: '200': description: 会員退会に成功しました。 @@ -109,7 +109,7 @@ paths: tags: - profile summary: API-005 自分のプロフィール表示 - operationId: GetUserProfile + operationId: getUserProfile responses: '200': description: プロフィールの取得に成功しました。 @@ -138,7 +138,7 @@ paths: tags: - trainer summary: API-007 パーソナルトレーナー検索 - operationId: SearchTrainers + operationId: searchTrainers security: [] responses: '200': @@ -154,7 +154,7 @@ paths: tags: - trainer summary: API-008 トレーニングメニュー取得 - operationId: GetTrainingMenu + operationId: getTrainingMenu security: [] parameters: - name: trainer_id @@ -180,7 +180,7 @@ paths: tags: - trainer summary: API-009 トレーナープロフィール取得 - operationId: GetTrainerProfile + operationId: getTrainerProfile security: [] parameters: - name: trainer_id @@ -205,7 +205,7 @@ paths: tags: - trainer summary: API-010 トレーナー口コミ取得 - operationId: GetTrainerReviews + operationId: getTrainerReviews security: [] parameters: - name: trainer_id @@ -230,7 +230,7 @@ paths: tags: - trainer summary: API-011 トレーナースケジュール取得 - operationId: GetTrainerSchedule + operationId: getTrainerSchedule security: [] parameters: - name: trainer_id @@ -255,7 +255,7 @@ paths: tags: - booking summary: API-012 予約済みトレーニング取得 - operationId: GetBookings + operationId: getBookings responses: '200': description: ユーザーの予約情報を取得しました。 @@ -269,7 +269,7 @@ paths: tags: - booking summary: API-013 トレーニング予約（仮登録） - operationId: BookTraining + operationId: bookTraining requestBody: required: true content: @@ -296,7 +296,7 @@ paths: tags: - booking summary: API-014 トレーニング予約削除 - operationId: DeleteBooking + operationId: deleteBooking parameters: - name: booking_id in: path @@ -322,7 +322,7 @@ paths: tags: - booking summary: API-015 トレーニング予約（本登録） - operationId: ConfirmBooking + operationId: confirmBooking parameters: - name: booking_id in: path @@ -356,7 +356,7 @@ paths: tags: - booking summary: API-016 トレーニング受講ステータス変更 - operationId: UpdateTrainingStatus + operationId: updateTrainingStatus parameters: - name: booking_id in: path @@ -392,7 +392,7 @@ paths: tags: - payment summary: API-017 決済 - operationId: MakePayment + operationId: makePayment requestBody: required: true content: From 2637aa84314cb6230b78b56749f5b0430f5fffbf Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 08:07:09 +0900 Subject: [PATCH 08/15] fix: response --- .../openapi.yaml" | 47 ++++++++++--------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 74d0b14e..b602c765 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -599,12 +599,28 @@ components: name: type: string description: 名前 + PaymentRequest: + type: object + properties: + amount: + type: number + format: double + description: 支払金額 + method: + type: string + description: 支払方法 BookingRequest: type: object properties: menu_id: type: string description: トレーニングメニューのID + booking_status_kbn: + type: string + enum: ["0"] + description: | + 予約ステータス区分 + 0: 仮登録 trainee_id: type: string description: トレーニーID @@ -616,39 +632,28 @@ components: type: string format: date description: トレーニング終了日時 - PaymentRequest: - type: object - properties: - amount: - type: number - format: double - description: 支払金額 - method: - type: string - description: 支払方法 BookingConfirmationRequest: type: object properties: - booking_id: - type: string - description: 予約のID booking_status_kbn: type: string - description: 予約ステータス区分 + enum: ["1"] + description: | + 予約ステータス区分 + 1: 本登録 TrainingStatusUpdateRequest: type: object properties: - booking_id: - type: string - description: トレーニングのID - training_status_kbn: + booking_status_kbn: type: string - description: トレーニングステータス区分 + enum: ["2", "3"] + description: | + 予約ステータス区分 + 2: 受講中 + 3: 受講済み Review: type: object properties: - id: - type: string title: type: string content: From 00fe08e8b8a99739fbe0156417a8e61f20115b50 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 08:45:02 +0900 Subject: [PATCH 09/15] fix: profile endpoint --- .../openapi.yaml" | 40 ++++++++++++++++++- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index b602c765..e42e6ff7 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -104,15 +104,19 @@ paths: $ref: '#/components/responses/InternalServer' '503': $ref: '#/components/responses/ServiceUnavailable' - /profile: + /profile/{trainee_id}: get: tags: - profile - summary: API-005 自分のプロフィール表示 + summary: API-005 プロフィール表示 operationId: getUserProfile responses: '200': description: プロフィールの取得に成功しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/Profile' '401': $ref: '#/components/responses/Unauthorized' '500': @@ -124,6 +128,19 @@ paths: - profile summary: API-006 プロフィール更新 operationId: putUserProfile + parameters: + - name: trainee_id + in: path + description: トレーニーID + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProfileRequest' responses: '200': description: プロフィールの更新に成功しました。 @@ -574,6 +591,16 @@ components: status: 400 # HTTP response status, appropriate for the problem type detail: Description of specific occurrence of the problem + Profile: + type: object + properties: + display_name: + type: string + description: 表示名 + self_introduction: + type: string + description: 自己紹介 + LoginRequest: type: object properties: @@ -599,6 +626,15 @@ components: name: type: string description: 名前 + ProfileRequest: + type: object + properties: + display_name: + type: string + description: 表示名 + self_introduction: + type: string + description: 自己紹介 PaymentRequest: type: object properties: From d2ea3e0cf5ca1d9161111234bdda92fdd87248fa Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 12:46:56 +0900 Subject: [PATCH 10/15] add: review table on ER Diagram --- .../future_muscle_partner/erd.a5er | 77 ++++++++++++++++--- 1 file changed, 66 insertions(+), 11 deletions(-) diff --git a/documents/forMarkdown/future_muscle_partner/erd.a5er b/documents/forMarkdown/future_muscle_partner/erd.a5er index 0f75bab0..379ef9a4 100644 --- a/documents/forMarkdown/future_muscle_partner/erd.a5er +++ b/documents/forMarkdown/future_muscle_partner/erd.a5er @@ -1,7 +1,7 @@ -# A5:ER FORMAT:18 +# A5:ER FORMAT:17 # A5:ER ENCODING:UTF8 # A5:ER Mk-1 Copyright © 2007 m.matsubara -# A5:SQL Mk-2 Version 2.19.0 Copyright © 1997 - 2024 m.matsubara +# A5:SQL Mk-2 Version 2.18.3 Copyright © 1997 - 2023 m.matsubara # https://a5m2.mmatsubara.com [Manager] @@ -42,7 +42,6 @@ BugFixEntityWidth=1 PName=trainee LName=トレーニー Comment= -TableInnerOption= TableOption= Page=MAIN Left=900 @@ -61,7 +60,6 @@ ZOrder=1 PName=booking LName=予約 Comment= -TableInnerOption= TableOption= Page=MAIN Left=1100 @@ -86,7 +84,6 @@ ZOrder=2 PName=menu LName=メニュー Comment= -TableInnerOption= TableOption= Page=MAIN Left=1300 @@ -109,7 +106,6 @@ ZOrder=3 PName=trainer LName=トレーナー Comment= -TableInnerOption= TableOption= Page=MAIN Left=1650 @@ -131,7 +127,6 @@ ZOrder=4 PName=calendar LName=カレンダー Comment= -TableInnerOption= TableOption= Page=MAIN Left=1650 @@ -197,7 +192,6 @@ ZOrder=5 PName=trainer_workspace LName=トレーナー勤務先 Comment= -TableInnerOption= TableOption= Page=MAIN Left=2200 @@ -217,18 +211,17 @@ ZOrder=6 PName=gym LName=ジム Comment= -TableInnerOption= TableOption= Page=MAIN Left=2350 -Top=250 +Top=200 Field="ジムID","gym_id","",,,"","",$FFFFFFFF,"" Field="ジム名","ジム名","",,,"","",$FFFFFFFF,"" EffectMode=None Color=$000000 BkColor=$FFFFFF ModifiedDateTime=20240419163332 -Position="MAIN",2350,250 +Position="MAIN",2350,200 ZOrder=7 [Relation] @@ -362,3 +355,65 @@ Bar3=285 TermPos1=R TermPos2=R ZOrder=13 + +[Entity] +PName=review +LName=レビュー +Comment= +TableOption= +Page=MAIN +Left=1650 +Top=100 +Field="レビューID","review_id","",,,"","",$FFFFFFFF,"" +Field="トレーナーID","trainer_id","",,,"","",$FFFFFFFF,"" +Field="トレーニーID","トレーニーID","",,,"","",$FFFFFFFF,"" +Field="コメント","comment","",,,"","",$FFFFFFFF,"" +Field="投稿日時","posted_at","",,,"","",$FFFFFFFF,"" +EffectMode=None +Color=$000000 +BkColor=$FFFFFF +ModifiedDateTime=20240711123631 +Position="MAIN",1650,100,132,141 +ZOrder=14 + +[Relation] +Entity1=trainee +Entity2=review +RelationType1=1 +RelationType2=3 +Fields1= +Fields2= +Cardinarity1= +Cardinarity2= +Position="MAIN",0,1183,1379,2885,R,R,"" +Dependence=1 +Caption= +PName= +LineMode=0 +Bar1=118 +Bar2=138 +Bar3=288 +TermPos1=R +TermPos2=R +ZOrder=17 + +[Relation] +Entity1=trainer +Entity2=review +RelationType1=1 +RelationType2=3 +Fields1= +Fields2= +Cardinarity1= +Cardinarity2= +Position="MAIN",0,6333,4889,5822,R,R,"" +Dependence=1 +Caption= +PName= +LineMode=0 +Bar1=633 +Bar2=489 +Bar3=582 +TermPos1=R +TermPos2=R +ZOrder=18 From a5e0e7b14de9cc71b66d2d1b7b210989a31077cd Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 22:53:46 +0900 Subject: [PATCH 11/15] add: response --- .../openapi.yaml" | 492 +++++++++++++++++- 1 file changed, 467 insertions(+), 25 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index e42e6ff7..d0960269 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -160,6 +160,10 @@ paths: responses: '200': description: トレーナーの検索結果を取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/Trainer' '400': $ref: '#/components/responses/BadRequest' '500': @@ -183,6 +187,10 @@ paths: responses: '200': description: トレーニングメニューを取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/TrainingMenu' '400': $ref: '#/components/responses/BadRequest' '404': @@ -209,6 +217,10 @@ paths: responses: '200': description: トレーナープロフィールを取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/Trainer' '400': $ref: '#/components/responses/BadRequest' '404': @@ -234,6 +246,10 @@ paths: responses: '200': description: トレーナーの口コミを取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' '400': $ref: '#/components/responses/BadRequest' '404': @@ -259,6 +275,10 @@ paths: responses: '200': description: トレーナーのスケジュールを取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/TrainerSchedule' '400': $ref: '#/components/responses/BadRequest' '404': @@ -442,7 +462,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Review' + $ref: '#/components/schemas/ReviewRequest' responses: '200': description: 口コミ登録成功 @@ -455,7 +475,7 @@ paths: parameters: - name: review_id in: path - description: 口コミID + description: レビューID required: true schema: type: string @@ -464,7 +484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Review' + $ref: '#/components/schemas/ReviewUpdateRequest' responses: '200': description: 口コミ修正成功 @@ -591,16 +611,6 @@ components: status: 400 # HTTP response status, appropriate for the problem type detail: Description of specific occurrence of the problem - Profile: - type: object - properties: - display_name: - type: string - description: 表示名 - self_introduction: - type: string - description: 自己紹介 - LoginRequest: type: object properties: @@ -651,7 +661,7 @@ components: menu_id: type: string description: トレーニングメニューのID - booking_status_kbn: + booking_status_typ: type: string enum: ["0"] description: | @@ -671,7 +681,7 @@ components: BookingConfirmationRequest: type: object properties: - booking_status_kbn: + booking_status_typ: type: string enum: ["1"] description: | @@ -680,38 +690,470 @@ components: TrainingStatusUpdateRequest: type: object properties: - booking_status_kbn: + booking_status_typ: type: string enum: ["2", "3"] description: | 予約ステータス区分 2: 受講中 3: 受講済み - Review: + ReviewRequest: type: object properties: - title: + trainer_id: type: string - content: + description: トレーナーID + trainee_id: + type: string + description: トレー二ーID + comment: + type: string + description: レビューコメント + ReviewUpdateRequest: + type: object + properties: + review_id: + type: string + description: レビューID + comment: + type: string + description: レビューコメント + Profile: + type: object + properties: + trainee_id: + type: string + description: トレーニーID + trainee_name: + type: string + description: トレーニー名 + display_name: type: string + description: 表示名 + self_introduction: + type: string + description: 自己紹介 Trainer: type: object properties: - id: + trainer_id: type: string - name: + description: トレーナーID + trainer_name: type: string - age: + description: トレーナー名 + unit_price: type: integer + description: 単価 + business_start_at: + type: string + format: date + description: 営業開始時間 + business_end_at: + type: string + format: date + description: 営業終了時間 + public_mail_addr: + type: string + format: email + description: 公開メールアドレス + public_tel: + type: string + description: 公開電話番号 + store_name: + type: string + description: 店舗名 + gym_name: + type: string + description: ジム名 + TrainerSchedule: + type: object + properties: + trainer_id: + type: string + description: トレーナーID + trainer_name: + type: string + description: トレーナー名 + date: + type: string + format: date + description: 日付け + booking_typ_0000: + type: string + enum: ["0", "1"] + description: | + 予約区分 00:00-00:30 + 0: 未予約 + 1: 予約済み + booking_typ_0030: + type: string + enum: ["0", "1"] + description: | + 予約区分 00:30-01:00 + 0: 未予約 + 1: 予約済み + booking_typ_0100: + type: string + enum: ["0", "1"] + description: | + 予約区分 01:00-01:30 + 0: 未予約 + 1: 予約済み + booking_typ_0130: + type: string + enum: ["0", "1"] + description: | + 予約区分 01:30-02:00 + 0: 未予約 + 1: 予約済み + booking_typ_0200: + type: string + enum: ["0", "1"] + description: | + 予約区分 02:00-02:30 + 0: 未予約 + 1: 予約済み + booking_typ_0230: + type: string + enum: ["0", "1"] + description: | + 予約区分 02:30-03:00 + 0: 未予約 + 1: 予約済み + booking_typ_0300: + type: string + description: | + 予約区分 03:00-03:30 + 0: 未予約 + 1: 予約済み + booking_typ_0330: + type: string + enum: ["0", "1"] + description: | + 予約区分 03:30-04:00 + 0: 未予約 + 1: 予約済み + booking_typ_0400: + type: string + enum: ["0", "1"] + description: | + 予約区分 04:00-04:30 + 0: 未予約 + 1: 予約済み + booking_typ_0430: + type: string + enum: ["0", "1"] + description: | + 予約区分 04:30-05:00 + 0: 未予約 + 1: 予約済み + booking_typ_0500: + type: string + enum: ["0", "1"] + description: | + 予約区分 05:00-05:30 + 0: 未予約 + 1: 予約済み + booking_typ_0530: + type: string + enum: ["0", "1"] + description: | + 予約区分 05:30-06:00 + 0: 未予約 + 1: 予約済み + booking_typ_0600: + type: string + description: | + 予約区分 06:00-06:30 + 0: 未予約 + 1: 予約済み + booking_typ_0630: + type: string + enum: ["0", "1"] + description: | + 予約区分 06:30-07:00 + 0: 未予約 + 1: 予約済み + booking_typ_0700: + type: string + enum: ["0", "1"] + description: | + 予約区分 07:00-07:30 + 0: 未予約 + 1: 予約済み + booking_typ_0730: + type: string + enum: ["0", "1"] + description: | + 予約区分 07:30-08:00 + 0: 未予約 + 1: 予約済み + booking_typ_0800: + type: string + enum: ["0", "1"] + description: | + 予約区分 08:00-08:30 + 0: 未予約 + 1: 予約済み + booking_typ_0830: + type: string + enum: ["0", "1"] + description: | + 予約区分 08:30-09:00 + 0: 未予約 + 1: 予約済み + booking_typ_0900: + type: string + enum: ["0", "1"] + description: | + 予約区分 09:00-09:30 + 0: 未予約 + 1: 予約済み + booking_typ_0930: + type: string + enum: ["0", "1"] + description: | + 予約区分 09:30-10:00 + 0: 未予約 + 1: 予約済み + booking_typ_1000: + type: string + enum: ["0", "1"] + description: | + 予約区分 10:00-10:30 + 0: 未予約 + 1: 予約済み + booking_typ_1030: + type: string + enum: ["0", "1"] + description: | + 予約区分 10:30-11:00 + 0: 未予約 + 1: 予約済み + booking_typ_1100: + type: string + enum: ["0", "1"] + description: | + 予約区分 11:00-11:30 + 0: 未予約 + 1: 予約済み + booking_typ_1130: + type: string + enum: ["0", "1"] + description: | + 予約区分 11:30-12:00 + 0: 未予約 + 1: 予約済み + booking_typ_1200: + type: string + enum: ["0", "1"] + description: | + 予約区分 12:00-12:30 + 0: 未予約 + 1: 予約済み + booking_typ_1230: + type: string + enum: ["0", "1"] + description: | + 予約区分 12:30-13:00 + 0: 未予約 + 1: 予約済み + booking_typ_1300: + type: string + enum: ["0", "1"] + description: | + 予約区分 13:00-13:30 + 0: 未予約 + 1: 予約済み + booking_typ_1330: + type: string + enum: ["0", "1"] + description: | + 予約区分 13:30-14:00 + 0: 未予約 + 1: 予約済み + booking_typ_1400: + type: string + enum: ["0", "1"] + description: | + 予約区分 14:00-14:30 + 0: 未予約 + 1: 予約済み + booking_typ_1430: + type: string + enum: ["0", "1"] + description: | + 予約区分 14:30-15:00 + 0: 未予約 + 1: 予約済み + booking_typ_1500: + type: string + enum: ["0", "1"] + description: | + 予約区分 15:00-15:30 + 0: 未予約 + 1: 予約済み + booking_typ_1530: + type: string + enum: ["0", "1"] + description: | + 予約区分 15:30-16:00 + 0: 未予約 + 1: 予約済み + booking_typ_1600: + type: string + enum: ["0", "1"] + description: | + 予約区分 16:00-16:30 + 0: 未予約 + 1: 予約済み + booking_typ_1630: + type: string + enum: ["0", "1"] + description: | + 予約区分 16:30-17:00 + 0: 未予約 + 1: 予約済み + booking_typ_1700: + type: string + enum: ["0", "1"] + description: | + 予約区分 17:00-17:30 + 0: 未予約 + 1: 予約済み + booking_typ_1730: + type: string + enum: ["0", "1"] + description: | + 予約区分 17:30-18:00 + 0: 未予約 + 1: 予約済み + booking_typ_1800: + type: string + enum: ["0", "1"] + description: | + 予約区分 18:00-18:30 + 0: 未予約 + 1: 予約済み + booking_typ_1830: + type: string + enum: ["0", "1"] + description: | + 予約区分 18:30-19:00 + 0: 未予約 + 1: 予約済み + booking_typ_1900: + type: string + enum: ["0", "1"] + description: | + 予約区分 19:00-19:30 + 0: 未予約 + 1: 予約済み + booking_typ_1930: + type: string + description: | + 予約区分 19:30-20:00 + 0: 未予約 + 1: 予約済み + booking_typ_2000: + type: string + enum: ["0", "1"] + description: | + 予約区分 20:00-20:30 + 0: 未予約 + 1: 予約済み + booking_typ_2030: + type: string + enum: ["0", "1"] + description: | + 予約区分 20:30-21:00 + 0: 未予約 + 1: 予約済み + booking_typ_2100: + type: string + enum: ["0", "1"] + description: | + 予約区分 21:00-21:30 + 0: 未予約 + 1: 予約済み + booking_typ_2130: + type: string + enum: ["0", "1"] + description: | + 予約区分 21:30-22:00 + 0: 未予約 + 1: 予約済み + booking_typ_2200: + type: string + enum: ["0", "1"] + description: | + 予約区分 22:00-22:30 + 0: 未予約 + 1: 予約済み + booking_typ_2230: + type: string + enum: ["0", "1"] + description: | + 予約区分 22:30-23:00 + 0: 未予約 + 1: 予約済み + booking_typ_2300: + type: string + enum: ["0", "1"] + description: | + 予約区分 23:00-23:30 + 0: 未予約 + 1: 予約済み + booking_typ_2330: + type: string + enum: ["0", "1"] + description: | + 予約区分 23:30-24:00 + 0: 未予約 + 1: 予約済み TrainingMenu: type: object properties: - id: + menu_id: type: string - name: + trainer_id: + type: string + description: トレーナーID + display_order: + type: string + description: 表示順序 + menu_name: + type: string + description: メニュー名 + menu_description: type: string - description: + description: メニュー説明 + required_time: + type: integer + description: 所要時間 + price: + type: integer + description: 料金 + Review: + type: object + properties: + review_id: type: string + description: レビューID + display_name: + type: string + description: トレーニーの表示名 + trainer_name: + type: string + description: トレーナー名 + comment: + type: string + description: レビューコメント + posted_at: + type: string + format: date + description: 投稿日時 responses: BadRequest: description: 400 Bad Request From a9ca2892c4d64c31dbfc88ef2f79cd439834967b Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 23:08:30 +0900 Subject: [PATCH 12/15] fix: EDR --- documents/forMarkdown/future_muscle_partner/erd.a5er | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/documents/forMarkdown/future_muscle_partner/erd.a5er b/documents/forMarkdown/future_muscle_partner/erd.a5er index 379ef9a4..16e2c8c2 100644 --- a/documents/forMarkdown/future_muscle_partner/erd.a5er +++ b/documents/forMarkdown/future_muscle_partner/erd.a5er @@ -47,12 +47,13 @@ Page=MAIN Left=900 Top=400 Field="トレーニーID","trainee_id","",,,"","",$FFFFFFFF,"" +Field="トレーニー名","trainee_name","",,,"","",$FFFFFFFF,"" Field="表示氏名","display_name","",,,"","",$FFFFFFFF,"" Field="自己紹介","self_introduction","",,,"","",$FFFFFFFF,"" EffectMode=None Color=$000000 BkColor=$FFFFFF -ModifiedDateTime=20240419164924 +ModifiedDateTime=20240711124838 Position="MAIN",900,400,254,275 ZOrder=1 @@ -98,7 +99,7 @@ Field="料金","price","",,,"","",$FFFFFFFF,"" EffectMode=None Color=$000000 BkColor=$FFFFFF -ModifiedDateTime=20240419161745 +ModifiedDateTime=20240711142913 Position="MAIN",1300,400,238,333 ZOrder=3 @@ -111,6 +112,7 @@ Page=MAIN Left=1650 Top=400 Field="トレーナーID","trainer_id","",,,"","",$FFFFFFFF,"" +Field="トレーナー名","trainer_name","",,,"","",$FFFFFFFF,"" Field="単価","unit_price","",,,"","",$FFFFFFFF,"" Field="営業開始時間","business_start_at","",,,"","",$FFFFFFFF,"" Field="営業終了時間","business_end_at","",,,"","",$FFFFFFFF,"" @@ -119,7 +121,7 @@ Field="公開電話番号","public_tel","",,,"","",$FFFFFFFF,"" EffectMode=None Color=$000000 BkColor=$FFFFFF -ModifiedDateTime=20240419164109 +ModifiedDateTime=20240711124858 Position="MAIN",1650,400,426,296 ZOrder=4 From ee1561ee53fb5d6bd49ad7ec9e664447339c29d7 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 23:28:39 +0900 Subject: [PATCH 13/15] fix: edr --- documents/forMarkdown/future_muscle_partner/erd.a5er | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/documents/forMarkdown/future_muscle_partner/erd.a5er b/documents/forMarkdown/future_muscle_partner/erd.a5er index 16e2c8c2..bce2a89f 100644 --- a/documents/forMarkdown/future_muscle_partner/erd.a5er +++ b/documents/forMarkdown/future_muscle_partner/erd.a5er @@ -1,7 +1,7 @@ -# A5:ER FORMAT:17 +# A5:ER FORMAT:18 # A5:ER ENCODING:UTF8 # A5:ER Mk-1 Copyright © 2007 m.matsubara -# A5:SQL Mk-2 Version 2.18.3 Copyright © 1997 - 2023 m.matsubara +# A5:SQL Mk-2 Version 2.19.2 Copyright © 1997 - 2024 m.matsubara # https://a5m2.mmatsubara.com [Manager] @@ -42,6 +42,7 @@ BugFixEntityWidth=1 PName=trainee LName=トレーニー Comment= +TableInnerOption= TableOption= Page=MAIN Left=900 @@ -61,6 +62,7 @@ ZOrder=1 PName=booking LName=予約 Comment= +TableInnerOption= TableOption= Page=MAIN Left=1100 @@ -85,6 +87,7 @@ ZOrder=2 PName=menu LName=メニュー Comment= +TableInnerOption= TableOption= Page=MAIN Left=1300 @@ -107,6 +110,7 @@ ZOrder=3 PName=trainer LName=トレーナー Comment= +TableInnerOption= TableOption= Page=MAIN Left=1650 @@ -129,6 +133,7 @@ ZOrder=4 PName=calendar LName=カレンダー Comment= +TableInnerOption= TableOption= Page=MAIN Left=1650 @@ -194,6 +199,7 @@ ZOrder=5 PName=trainer_workspace LName=トレーナー勤務先 Comment= +TableInnerOption= TableOption= Page=MAIN Left=2200 @@ -213,6 +219,7 @@ ZOrder=6 PName=gym LName=ジム Comment= +TableInnerOption= TableOption= Page=MAIN Left=2350 @@ -362,6 +369,7 @@ ZOrder=13 PName=review LName=レビュー Comment= +TableInnerOption= TableOption= Page=MAIN Left=1650 From 25070d210d385a806c798dfadf6a1ca88d1820b2 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 23:55:22 +0900 Subject: [PATCH 14/15] fix: get booked training menu endpoint --- .../openapi.yaml" | 70 +++++++++++++++---- 1 file changed, 56 insertions(+), 14 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index d0960269..4fc58a0d 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -288,20 +288,6 @@ paths: '503': $ref: '#/components/responses/ServiceUnavailable' /bookings: - get: - tags: - - booking - summary: API-012 予約済みトレーニング取得 - operationId: getBookings - responses: - '200': - description: ユーザーの予約情報を取得しました。 - '401': - $ref: '#/components/responses/Unauthorized' - '500': - $ref: '#/components/responses/InternalServer' - '503': - $ref: '#/components/responses/ServiceUnavailable' post: tags: - booking @@ -328,6 +314,25 @@ paths: $ref: '#/components/responses/InternalServer' '503': $ref: '#/components/responses/ServiceUnavailable' + /bookings/{trainee_id}: + get: + tags: + - booking + summary: API-012 予約済みトレーニング取得 + operationId: getBookings + responses: + '200': + description: ユーザーの予約情報を取得しました。 + content: + application/json: + schema: + $ref: '#/components/schemas/Booking' + '401': + $ref: '#/components/responses/Unauthorized' + '500': + $ref: '#/components/responses/InternalServer' + '503': + $ref: '#/components/responses/ServiceUnavailable' /bookings/{booking_id}: delete: tags: @@ -639,6 +644,9 @@ components: ProfileRequest: type: object properties: + trainee_name: + type: string + description: トレーニー名 display_name: type: string description: 表示名 @@ -733,6 +741,40 @@ components: self_introduction: type: string description: 自己紹介 + Booking: + type: object + properties: + booking_id: + type: string + description: 予約ID + trainee_id: + type: string + description: トレーニーID + menu_id: + type: string + description: トレーニングメニューのID + start_at: + type: string + format: date + description: 開始日時 + end_at: + type: string + format: date + description: 終了日時 + booking_status_typ: + type: string + enum: ["1"] + description: | + 予約ステータス区分 + 1: 本登録 + training_start_at: + type: string + format: date + description: トレーニング開始日時 + training_end_at: + type: string + format: date + description: トレーニング終了日時 Trainer: type: object properties: From b3be5f74bba4446560d4490b324cb355e9f0ff37 Mon Sep 17 00:00:00 2001 From: TsubasaKanemitsu Date: Thu, 11 Jul 2024 23:55:32 +0900 Subject: [PATCH 15/15] fix: Booking --- .../openapi.yaml" | 27 ++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" index 4fc58a0d..d3ba51da 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" +++ "b/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI\350\250\255\350\250\210/openapi.yaml" @@ -747,12 +747,27 @@ components: booking_id: type: string description: 予約ID - trainee_id: - type: string - description: トレーニーID menu_id: type: string description: トレーニングメニューのID + trainer_id: + type: string + description: トレーナーのID + display_order: + type: string + description: 表示順序 + menu_name: + type: string + description: メニュー名 + menu_description: + type: string + description: メニュー説明 + required_time: + type: integer + description: 所要時間 + price: + type: integer + description: 料金 start_at: type: string format: date @@ -761,12 +776,6 @@ components: type: string format: date description: 終了日時 - booking_status_typ: - type: string - enum: ["1"] - description: | - 予約ステータス区分 - 1: 本登録 training_start_at: type: string format: date