Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor/#803 행사 및 함께해요 관련 api 명세 수정 #808

165 changes: 83 additions & 82 deletions backend/emm-sale/src/documentTest/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,6 @@ include::{snippets}/find-all-activities/http-response.adoc[]
.HTTP response 설명
include::{snippets}/find-all-activities/response-fields.adoc[]

=== `POST`: 새로운 Activity 추가

.HTTP request
include::{snippets}/add-activity/http-request.adoc[]

.HTTP request 설명
include::{snippets}/add-activity/request-fields.adoc[]

.HTTP response
include::{snippets}/add-activity/http-response.adoc[]

.HTTP response 설명
include::{snippets}/add-activity/response-fields.adoc[]

== Member

=== `POST`: 초기 사용자 등록
Expand Down Expand Up @@ -192,6 +178,31 @@ include::{snippets}/delete-interest-tag/response-fields.adoc[]

== Event

=== `GET`: 행사 목록 조회

.HTTP request
include::{snippets}/find-events/http-request.adoc[]

.HTTP request 설명
include::{snippets}/find-events/request-parameters.adoc[]

.HTTP response
include::{snippets}/find-events/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-events/response-fields.adoc[]

=== `GET` : 행사 상세정보 조회

.HTTP request
include::{snippets}/find-event/http-request.adoc[]

.HTTP response
include::{snippets}/find-event/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-event/response-fields.adoc[]

=== `POST` : 행사의 함께 해요 목록에 게시글 추가

.HTTP request 설명
Expand Down Expand Up @@ -219,71 +230,46 @@ include::{snippets}/delete-recruitment-post/http-request.adoc[]
.HTTP response
include::{snippets}/delete-recruitment-post/http-response.adoc[]

=== `GET`: 사용자가 해당 행사에 이미 함께 해요 게시글을 작성했는지 확인

.HTTP request
include::{snippets}/check-already-recruitment-post/http-request.adoc[]

.HTTP response
include::{snippets}/check-already-recruitment-post/http-response.adoc[]

=== `GET`: 사용자의 id를 기반으로 사용자가 작성한 모든 함께해요 요청 조회

.HTTP request
include::{snippets}/find-all-by-member-id-recruitment-post/http-request.adoc[]

.HTTP response
include::{snippets}/find-all-by-member-id-recruitment-post/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-all-by-member-id-recruitment-post/response-fields.adoc[]

=== `GET` : 행사 상세정보 조회
=== `GET` : 함께 해요 게시글 목록 조회

.HTTP request
include::{snippets}/find-event/http-request.adoc[]
include::{snippets}/find-recruitment-posts/http-request.adoc[]

.HTTP response
include::{snippets}/find-event/http-response.adoc[]
include::{snippets}/find-recruitment-posts/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-event/response-fields.adoc[]
include::{snippets}/find-recruitment-posts/response-fields.adoc[]

=== `GET`: 행사 목록 조회
=== `GET` : 함께 해요 게시글 단건 조회

.HTTP request
include::{snippets}/find-events/http-request.adoc[]

.HTTP request 설명
include::{snippets}/find-events/request-parameters.adoc[]
include::{snippets}/find-recruitment-post/http-request.adoc[]

.HTTP response
include::{snippets}/find-events/http-response.adoc[]
include::{snippets}/find-recruitment-post/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-events/response-fields.adoc[]
include::{snippets}/find-recruitment-post/response-fields.adoc[]

=== `GET` : 함께 해요 게시글 목록 조회
=== `GET`: 사용자의 id를 기반으로 사용자가 작성한 모든 함께해요 요청 조회

.HTTP request
include::{snippets}/find-recruitment-posts/http-request.adoc[]
include::{snippets}/find-all-by-member-id-recruitment-post/http-request.adoc[]

.HTTP response
include::{snippets}/find-recruitment-posts/http-response.adoc[]
include::{snippets}/find-all-by-member-id-recruitment-post/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-recruitment-posts/response-fields.adoc[]
include::{snippets}/find-all-by-member-id-recruitment-post/response-fields.adoc[]

=== `GET` : 함께 해요 게시글 단건 조회
=== `GET`: 사용자가 해당 행사에 이미 함께 해요 게시글을 작성했는지 확인

.HTTP request
include::{snippets}/find-recruitment-post/http-request.adoc[]
include::{snippets}/check-already-recruitment-post/http-request.adoc[]

.HTTP response
include::{snippets}/find-recruitment-post/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-recruitment-post/response-fields.adoc[]
include::{snippets}/check-already-recruitment-post/http-response.adoc[]

== Comment

Expand Down Expand Up @@ -401,32 +387,29 @@ include::{snippets}/unregister-block/http-request.adoc[]
.HTTP response
include::{snippets}/unregister-block/http-response.adoc[]

== TAG

=== `GET` : 존재하는 모든 태그 조회
=== `GET` : 차단한 사용자 목록 조회

.HTTP request
include::{snippets}/find-tags/http-request.adoc[]
include::{snippets}/find-blocks/http-request.adoc[]

.HTTP response
include::{snippets}/find-tags/http-response.adoc[]
include::{snippets}/find-blocks/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-tags/response-fields.adoc[]
include::{snippets}/find-blocks/response-fields.adoc[]

=== `POST` : 새로운 태그 추가
== TAG

.HTTP request
include::{snippets}/add-tag/http-request.adoc[]
=== `GET` : 존재하는 모든 태그 조회

.HTTP request 설명
include::{snippets}/add-tag/request-fields.adoc[]
.HTTP request
include::{snippets}/find-tags/http-request.adoc[]

.HTTP response
include::{snippets}/add-tag/http-response.adoc[]
include::{snippets}/find-tags/http-response.adoc[]

.HTTP response 설명
include::{snippets}/add-tag/response-fields.adoc[]
include::{snippets}/find-tags/response-fields.adoc[]

== Report

Expand All @@ -444,17 +427,6 @@ include::{snippets}/add-report/http-response.adoc[]
.HTTP response 설명
include::{snippets}/add-report/response-fields.adoc[]

=== `GET` : 신고 목록 전체 조회

.HTTP request
include::{snippets}/find-reports/http-request.adoc[]

.HTTP response
include::{snippets}/find-reports/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-reports/response-fields.adoc[]

== 스크랩

=== `GET` : 전체 스크랩 조회
Expand Down Expand Up @@ -696,14 +668,43 @@ include::{snippets}/delete-event/http-request.adoc[]
.HTTP response
include::{snippets}/delete-event/http-response.adoc[]

=== `GET` : 차단한 사용자 목록 조회
=== `POST`: 새로운 Activity 추가

.HTTP request
include::{snippets}/find-blocks/http-request.adoc[]
include::{snippets}/add-activity/http-request.adoc[]

.HTTP request 설명
include::{snippets}/add-activity/request-fields.adoc[]

.HTTP response
include::{snippets}/find-blocks/http-response.adoc[]
include::{snippets}/add-activity/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-blocks/response-fields.adoc[]
include::{snippets}/add-activity/response-fields.adoc[]

=== `POST` : 새로운 태그 추가

.HTTP request
include::{snippets}/add-tag/http-request.adoc[]

.HTTP request 설명
include::{snippets}/add-tag/request-fields.adoc[]

.HTTP response
include::{snippets}/add-tag/http-response.adoc[]

.HTTP response 설명
include::{snippets}/add-tag/response-fields.adoc[]

=== `GET` : 신고 목록 전체 조회

.HTTP request
include::{snippets}/find-reports/http-request.adoc[]

.HTTP response
include::{snippets}/find-reports/http-response.adoc[]

.HTTP response 설명
include::{snippets}/find-reports/response-fields.adoc[]


Loading
Loading