Skip to content
This repository was archived by the owner on Nov 6, 2024. It is now read-only.

修復 orders 的 API 文件和 route 實作分歧的部分#174

Open
Lai-YT wants to merge 2 commits intobackendfrom
update-apidoc-of-orders
Open

修復 orders 的 API 文件和 route 實作分歧的部分#174
Lai-YT wants to merge 2 commits intobackendfrom
update-apidoc-of-orders

Conversation

@Lai-YT
Copy link
Copy Markdown
Collaborator

@Lai-YT Lai-YT commented Jan 12, 2023

What's changed?

移除 POST /orders 中在 delivery_info 內的 firstnamelastname 以及 email,共 3 個欄位。

因為經過討論,我們的 order 在新增(POST) 時會自動透過當前登入之使用者的身分查詢其上述欄位,不會讓使用者再次輸入,故移除。

Details

因為這個 order_payloadSwagger API 中的 definition 是被 reuse 的,所以影響到了其他 route 中的 definitionorder_response)。也因為不能只抽換部分 properties 的緣故,重新定義了一個和 order_payload 相像的 order_payload_with_user_info 來給其他仍需要回傳 firstnamelastname 以及 emaildefinition 使用。

What to review?

  • /orders 的各個 route 是否都有正常顯示
  • 移除的欄位是否都有確實移除,並且沒有影響到需要保留的地方
  • definition 的命名(order_payload_with_user_info)是否符合我們的慣例

@Lai-YT Lai-YT added documentation Improvements or additions to documentation backend labels Jan 12, 2023
@Lai-YT Lai-YT requested a review from c1ydehhx January 12, 2023 12:06
@Lai-YT Lai-YT self-assigned this Jan 12, 2023
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 12, 2023

Codecov Report

Merging #174 (0a86dbe) into backend (711320e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           backend     #174   +/-   ##
========================================
  Coverage    99.89%   99.89%           
========================================
  Files           21       21           
  Lines          967      967           
  Branches        89       89           
========================================
  Hits           966      966           
  Partials         1        1           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backend documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant