Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[マイページ]購入報告・マイページに必要なAPIの定義 #911

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Kubosaka
Copy link
Collaborator

resolve #910

概要

マイページと購入報告ページで必要になりそうなAPIを定義しました

  • POST /buy_report
    • 購入報告の保存
  • PUT /buy_report/{id}
    • 購入報告の修正
  • DELETE /buy_report/{id}
    • 購入報告の削除
  • GET /buy_report/list
    • 購入報告一覧の取得
  • PUT /buy_report/status/{buy_report_id}
    • 購入報告を精算済みにするAPI
  • GET /festival_items/details/{division_id}
    • 部門ごとに購入物品を取得するAPI

画面スクリーンショット等

スクリーンショット 2025-01-16 23 36 42

テスト項目

備考

@Kubosaka Kubosaka requested a review from hikahana January 16, 2025 14:37
Comment on lines +713 to +718
file:
type: string
format: binary
description: 購入報告書のファイル、ない場合更新しないようにする
buy_report:
$ref: "#/components/schemas/buyReport"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

画像もバックエンドに送って、そこからMIniOにあげるようにしたい感
フロントもシンプルになる

application/json:
schema:
type: object
/buy_reports/list:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

購入報告で表示する購入報告の一覧
year指定で年度、何もなしで全件取得

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

これ名称detailsでも良いのでは

Copy link
Collaborator

@hikahana hikahana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コメントしました!

buy_report:
$ref: "#/components/schemas/buyReport"
required:
- file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[imo]
これ画像がない時とか無かったでしたっけ。まだ企業から画像貰えてないとか
だからrequiredにしなくてもよいかも

required:
- file
- buy_report
required: true
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

中でrequired入れてるしなくてもいいのでは

required: true
responses:
"200":
description: 作成されたbuyReportが返ってくる
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

めちゃ細かいけどここスネークだとdescriptionの統一感ある。

application/json:
schema:
type: object
/buy_reports/list:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

これ名称detailsでも良いのでは

description: マイページで表示する購入報告の情報
type: object
properties:
ID:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

これ小文字かも
id

description: 購入報告ページで表示する詳細情報
type: object
properties:
ID:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここも

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[マイページ]購入報告関連のAPI定義
2 participants