📝 [STMT-268] API 명세서 추가 (#127)

Stumeet · Jun 3, 2024 · 9019d00 · 9019d00
1 parent 772a155
commit 9019d00
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc
@@ -222,6 +222,27 @@ include::{snippets}/get-study-detail/fail/not-found/response-body.adoc[]
 include::{snippets}/get-study-detail/fail/not-found/response-fields.adoc[]
 
 
+=== 가입 스터디 리스트 조회
+
+사용자가 가입된 스터디 리스트를 조회하는 API입니다.
+
+==== GET /api/v1/studies
+
+===== 요청
+include::{snippets}/get-joined-studies/success/http-request.adoc[]
+include::{snippets}/get-joined-studies/success/request-headers.adoc[]
+include::{snippets}/get-joined-studies/success/query-parameters.adoc[]
+
+===== 응답 성공 (200)
+include::{snippets}/get-joined-studies/success/response-body.adoc[]
+include::{snippets}/get-joined-studies/success/response-fields.adoc[]
+
+===== 응답 실패 (404)
+.존재하지 않는 스터디 상태로 요청한 경우
+include::{snippets}/get-joined-studies/fail/study-status-not-found/response-body.adoc[]
+include::{snippets}/get-joined-studies/fail/study-status-not-found/response-fields.adoc[]
+
+
 === 스터디 생성
 
 스터디를 생성하는 API 입니다.

diff --git a/src/test/java/com/stumeet/server/study/adapter/in/web/StudyQueryApiTest.java b/src/test/java/com/stumeet/server/study/adapter/in/web/StudyQueryApiTest.java
@@ -137,7 +137,7 @@ void fail_when_study_status_not_found() throws Exception {
 						headerWithName(AuthenticationHeader.ACCESS_TOKEN.getName()).description("서버로부터 전달받은 액세스 토큰")
 					),
 					queryParameters(
-						parameterWithName("status").description("스터디 상태 (`ACTIVE` / `FINISHED`)")
+						parameterWithName("status").description("스터디 상태: ACTIVE, FINISHED")
 					),
 					responseFields(
 						fieldWithPath("code").description("응답 상태"),