[기능] 캘린더 API 수정 요청

[NarciSource]

📌 필요한 작업

캘린더 서비스 API의 수정을 요청

📝 작업할 항목

• 공통

  • content-type: json/application 반환값은 모두 json으로 통일해주세요.
    간단한 성공 메시지라도 { "success": true, "message": "성공" } 이런 형태를 대개 사용해서 통일성을 줘요.
  • 현재 api의 추가, 수정, 삭제는 면접 일정 하나에 관한 것이죠.
    그렇다면 복수형이 아니죠. /interviews → /interview

• 면접 일정 추가

  • 반환값에 interviewDetailId가 필요해요.
    그래야 포함 관계 api(조회, 삭제, 수정)에서 사용할 id를 얻을 수 있으니까

• 면접 일정 조회

  • 이 api 응답의 id는 뭔지 모르겠어요. 이 반환값은 옵셔널로 데이터를 필터링한 리스트 형태이죠. 리스트의 id인가요?
  • 이 조회는 여러 데이터를 반환하는 형태에요. 엄밀히 말하면 면접 일정들 조회(/interviews)가 되겠죠.
  • 그렇다면 제대로 하나의 데이터를 반환하는 면접 일정 조회(/interview)가 요구돼요.
    이 api는 name이나 yearMonth 옵션 없이 interviewDetailId라는 필수 파라미터를 입력으로 받아 interviewDetails가 아닌 단수형 interviewDetail을 반환값으로 요구할 수 있겠죠.
  • 이 api 요청은 토큰 없이 해주세요. 토큰 인증은 API게이트웨이에서 할 거고,
    id로 바로 접근하니까 유저정보 필터링이 없으니까요.

• 스웨거UI

  • 응답 칸들에 Example란이 있는데 모두 비어있음
    반환값 표현이 불필요한 것은 지우고 필요한 것은 스키마 채워주세요.

📚 추가 정보

JSON:API 권장 표준 가이드 https://jsonapi.org/