영수증 POST API 수정 요청

EasyAndBeauty / DailyReceipt-BE-WEB

4 stars 0 forks source link

영수증 POST API 수정 요청 #39

Closed mdgarden closed 1 year ago

mdgarden commented 1 year ago

Description

POST Receipt API의 리스폰스값을 수정부탁드립니다.

To-Be

[x] POST로 생성된 영수증의 id값을 포함한 receipt 전체를 리스폰스로 반환

기존 POST에서는 status만 받기로 했었는데, 제가 미처 생각하지 못한 부분이 있어 수정이 필요합니다. POST로 생성된 이후의 해당 영수증의 id값을포함한 receipt 전체를 리스폰스로 받을 수 있도록 수정해주시면 감사하겠습니다. API 문서도 수정해두었으니 참고 부탁드립니다.

https://github.com/EasyAndBeauty/DailyReceipt-BE-WEB/wiki/API-%EB%AC%B8%EC%84%9C#receipt

java-saeng commented 1 year ago

혹시 이전 명세는 삭제하셨을까요? 어느 부분이 변경된건지 궁금해서요 !

mdgarden commented 1 year ago

기존

API Name	POST Pinned Receipt
설명	영수증을 등록합니다.
Method	POST
Path	/api/v1/receipt/pinned
Params	none
Request	Receipt
Response	none(status만 return)
Auth	required

수정 후	API Name	POST Pinned Receipt
설명	영수증을 등록합니다.
Method	POST
Path	/api/v1/receipt/pinned
Params	none
Request	Receipt(todos, famous_saying, date, pinned, receipt_name)
Response	Receipt
Auth	required

요렇게 입니다! 리퀘스트는 표현이 애매해서 문서만 수정할 예정이고 실제로 바뀌는 부분은 리스폰스 부분입니다.

java-saeng commented 1 year ago

답변 늦어서 죄송합니다,,!

POST 시 id 뿐만 아니라 저장된 값들을 모두 반환해달라는 말씀이신가요?? 기존에는 id 만 반환했습니다

mdgarden commented 1 year ago

네 맞습니다 id 포함해서 모두 반환 부탁드립니다! 기존에 id만 반환하는건 몰랐네요 문서를 쓰다 말았나 ㅠ...아무튼 모두 반환하도록 수정 부탁드리겠습니다.