[API 명세서] 사소한 부분이지만, 마이스터디 리스트 조회 부분 엔드포인트에서 수정사항이 있어 공유드립니다.

[Whaleinmilktea]

명세서에서는 /studygroup/myList?approved=false일 경우 데이터가 200ok로 자신이 속한 스터디 리스트가 조회된다고 되어있지만,
실제 동작에서는 /studygroup/myList?approved=true인 경우 이뤄지고 있습니당

[serveman]

현재 구현되어있는 엔드포인트의 의미는 아래와 같습니다.

• 엔드포인트: /studygroup/myList
• key: approved
  • value: true => 신청이 승인이 된 상태 = 가입 승인이 완료된 스터디
  • value: false => 신청이 승인되지 않은 상태 = 가입 대기 중인 스터디
    입니다.

질문 내용을 보면,

• approved=true 로 검색했을 때
  • 해당 맴버로 가입이 되어있는 스터디를 조회하여 목록으로 응답합니다. ( 조회완료: 200 )
• approved=false 로 검색했을 때
  • 해당 맴버로 가입 신청 중인 스터디를 조회하여 목록으로 응답합니다. ( 조회완료: 200 )

[serveman]

응답 내용의 키 값의 의미는 다음과 같습니다

• approved=true 에 대한 응답
  • leaders: 현재 접속 중인 맴버가 리더로 활동 중인 스터디의 목록
  • members: 현재 접속 중인 맴버가 스터디 그룹원으로 활동 중인 스터디의 목록

• approved=false 에 대한 응답
  • beStudys: 현재 접속 중인 맴버로 가입 신청을 하여 승인되지 않은, 가입 대기 중인 스터디의 목록

[serveman]

엔드포인트의 의미와, 응답의 key 이름이 모호하다고 생각할 수 있습니다.

이 경우에는 의미를 명확히 전달할 수 있도록
서로 네이밍에 대해서 조금 더 고민해보면 좋을 것 같습니다.

[Whaleinmilktea]

아하! 그렇군요!
쿼리문에 대한 이해가 적어서 오해가 생긴 것 같습니다! 감사합니다!

[serveman]

이것도 소통을 통해서 엔드포인트에 대한 의미를 명확히 할 수 있습니다.

그럴땐 자신있게 ! 요청하시면 됩니다.
~~~ 한 식으로 하면 어떤가요?