reservation 에 대한 추가 api 구성

[JuneParkCode]

배경

• 현재 API 의 경우 단순 CRUD 를 수행하고 있습니다. 그러나, reservation 등록, 수정, 취소의 경우 복잡한 transaction 이 요구되고 있어 별도의 api를 구성해야합니다.
• 기존의 /reservations 에서 POST, PATCH 관련 요청은 ADMIN에 한하여 사용할 수 있도록 제한할 것입니다.
• 기존의 /reservations 에서 수행할 수 있는 요청이나, 사용자 측에서의 요청을 세분화하고 정확하게 수행하는데 목적이 있습니다.

  새로 만들 API

  공통

• 아래 API는 모두 예약에 관련되어 멘토, 멘티에게 알림을 수행합니다.
  • 알림의 경우 현재 첫 구현에서는 email 로 수행됩니다.
  • 따라서, 초기에 mailing list에 등록할 수 있도록 해야합니다.
  • 추후에는 mailing list 에 송부하는 것 외에도 web 상에서 알림을 수신할 수 있도록 해야합니다.
• 반드시 예약에 관련된 사람 혹은 ADMIN만이 수행할 수있습니다.

  노쇼

• Front 에서 노쇼 상황 대처에 대한 가이드를 작성해둬야합니다.

  등록

• POST /reservations
  • 새로운 예약을 개설합니다.
  • 다음을 확인합니다.
  • 현재 상호 진행 중인 예약이 존재하는가?
    • REQUEST, ACCEPT 상태의 예약을 찾아봅니다.
  • 이후 예약의 상태는 REQUEST 가 됩니다.

    취소

• PATCH /reservations/{id}/cancel
  • REQUEST 상태의 예약을 취소합니다.
  • 예약 취소는 REQUEST 상황에서 멘티, 멘토 모두 신청할 수 있습니다.
  • 이후 예약 상태는 CANCEL이 됩니다.

    예약 확인

• PATCH /reservations/{id}/accept
  • 현재 REQUEST상태의 예약에 대해서 멘토가 확정을 합니다.
  • 예약 확인은 REQUEST 상태에서만 이루어질 수 있습니다.
  • 멘토만 해당 요청을 할 수 있습니다.
  • 이후 예약 상태는 ACCEPT 상태가 됩니다.

    멘토링 종료 (멘토입장)

• PATCH /reservations/{id}/mentor_completion
  • 멘토링 진행 이후 멘토가 해당 멘토링의 종료 처리를합니다.
  • 해당 요청은 멘토링에 관련된 멘토만 요청할 수 있습니다.
  • 요청이 가능한 상태는 멘토링이 수락된 상태인 ACCEPT 입니다.
  • API를 요청할때는 Feedback 을 작성해야하며, 이 관련 내용이 해당 요청의 body 에 포함됩니다.
  • 이후 예약의 상태는 PENDING 상태가 됩니다.

    멘토링 종료 (멘티입장)

• PATCH /reservations/{id}/mentee_completion
  • 멘티가 멘토링 종료 이후 멘토링에 대한 피드백과 함께 예약을 마무리합니다
  • 해당 요청은 멘토링에 관련된 멘티만 요청할 수 있습니다.
  • 요청이 가능한 상태는 멘토가 멘토링에 대한 피드백을 작성하고 멘티의 피드백을 기다리는 PENDING 입니다.
  • API를 요청할 때는 Feedback 을 작성해야하며, 이 관련 내용이 해당 요청의 body 에 포함됩니다.
  • 이후 예약의 상태는 COMPLETE가 됩니다.