From 7ff23361038ba208e8d8303aea86a1c77906e8ea Mon Sep 17 00:00:00 2001 From: giwoong Date: Thu, 19 Dec 2024 15:57:45 +0900 Subject: [PATCH] =?UTF-8?q?Chore:=20.gitignore=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + src/docs/asciidoc/block.adoc | 130 ----------- src/docs/asciidoc/challenge.adoc | 275 ----------------------- src/docs/asciidoc/follow.adoc | 90 -------- src/docs/asciidoc/index.adoc | 12 - src/docs/asciidoc/login.adoc | 25 --- src/docs/asciidoc/member.adoc | 63 ------ src/docs/asciidoc/notification.adoc | 35 --- src/docs/asciidoc/personalDashboard.adoc | 77 ------- src/docs/asciidoc/teamDashboard.adoc | 93 -------- src/docs/asciidoc/teamDocument.adoc | 74 ------ 11 files changed, 1 insertion(+), 874 deletions(-) delete mode 100644 src/docs/asciidoc/block.adoc delete mode 100644 src/docs/asciidoc/challenge.adoc delete mode 100644 src/docs/asciidoc/follow.adoc delete mode 100644 src/docs/asciidoc/index.adoc delete mode 100644 src/docs/asciidoc/login.adoc delete mode 100644 src/docs/asciidoc/member.adoc delete mode 100644 src/docs/asciidoc/notification.adoc delete mode 100644 src/docs/asciidoc/personalDashboard.adoc delete mode 100644 src/docs/asciidoc/teamDashboard.adoc delete mode 100644 src/docs/asciidoc/teamDocument.adoc diff --git a/.gitignore b/.gitignore index 5b016859..80969aba 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ out/ !**/src/test/**/out/ src/**/application-prod.yml +src/docs ### NetBeans ### /nbproject/private/ diff --git a/src/docs/asciidoc/block.adoc b/src/docs/asciidoc/block.adoc deleted file mode 100644 index 60c5bcf7..00000000 --- a/src/docs/asciidoc/block.adoc +++ /dev/null @@ -1,130 +0,0 @@ -== 블록 API 문서 - -=== 블록 생성 API - -==== 요청 - -include::{snippets}/block/save/http-request.adoc[] -include::{snippets}/block/save/request-fields.adoc[] - -==== 응답 - -include::{snippets}/block/save/http-response.adoc[] -include::{snippets}/block/save/response-fields.adoc[] - -=== 블록 수정 API - -==== 요청 - -include::{snippets}/block/update/http-request.adoc[] -include::{snippets}/block/update/path-parameters.adoc[] -include::{snippets}/block/update/request-fields.adoc[] - -==== 응답 - -include::{snippets}/block/update/http-response.adoc[] -include::{snippets}/block/update/response-fields.adoc[] - -=== 블록 상태 수정 API - -==== 요청 - -include::{snippets}/block/progress/update/http-request.adoc[] -include::{snippets}/block/progress/update/path-parameters.adoc[] -include::{snippets}/block/progress/update/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/progress/update/http-response.adoc[] -include::{snippets}/block/progress/update/response-fields.adoc[] - -=== 블록 상태 수정 실패 API (400 Bad Request) - -==== 요청 - -include::{snippets}/block/progress/update/failure/http-request.adoc[] -include::{snippets}/block/progress/update/failure/path-parameters.adoc[] -include::{snippets}/block/progress/update/failure/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/progress/update/failure/http-response.adoc[] - -=== 블록 상태별 전체 조회 - -==== 요청 - -include::{snippets}/block/findByBlockWithProgress/http-request.adoc[] -include::{snippets}/block/findByBlockWithProgress/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/findByBlockWithProgress/http-response.adoc[] -include::{snippets}/block/findByBlockWithProgress/response-fields.adoc[] - -=== 블록 상세 조회 - -==== 요청 - -include::{snippets}/block/findById/http-request.adoc[] -include::{snippets}/block/findById/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/findById/http-response.adoc[] -include::{snippets}/block/findById/response-fields.adoc[] - -=== 블록 삭제 - -==== 요청 - -include::{snippets}/block/delete/http-request.adoc[] -include::{snippets}/block/delete/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/delete/http-response.adoc[] - -=== 블록 상태 변경 - -==== 요청 - -include::{snippets}/block/change/http-request.adoc[] - -==== 응답 - -include::{snippets}/block/change/http-response.adoc[] - -=== 삭제된 블록 조회 - -==== 요청 - -include::{snippets}/block/findDeletedBlocks/http-request.adoc[] -include::{snippets}/block/findDeletedBlocks/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/findDeletedBlocks/http-response.adoc[] -include::{snippets}/block/findDeletedBlocks/response-fields.adoc[] - -=== 블록 영구 삭제 - -==== 요청 - -include::{snippets}/block/deletePermanentBlock/http-request.adoc[] -include::{snippets}/block/deletePermanentBlock/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/deletePermanentBlock/http-response.adoc[] - -=== 삭제된 블록 영구 삭제 (휴지통 비움) - -==== 요청 - -include::{snippets}/block/deleteAllPermanentBlock/http-request.adoc[] -include::{snippets}/block/deleteAllPermanentBlock/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/block/deleteAllPermanentBlock/http-response.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/challenge.adoc b/src/docs/asciidoc/challenge.adoc deleted file mode 100644 index 01f494c2..00000000 --- a/src/docs/asciidoc/challenge.adoc +++ /dev/null @@ -1,275 +0,0 @@ -= 챌린지 API 문서 - -== 열거형 타입 항목 설명 - -이 문서에서는 챌린지 관련 API에서 사용되는 다양한 열거형 타입의 항목들을 설명합니다. -아래의 각 열거형 타입은 API 요청 및 응답에서 사용될 수 있으며, 각 항목은 Name과 Description으로 구성되어 있습니다. - -- Name: 코드에서 사용되는 열거형 상수의 이름입니다. -- Description: 열거형 상수에 대한 설명입니다.. - -=== category(카테고리) 항목 설명 - -[cols="1,1",options="header"] -|=== -| Name | Description - -| HEALTH_AND_FITNESS -| 건강 및 운동 - -| MENTAL_WELLNESS -| 정신 및 마음관리 - -| PRODUCTIVITY_AND_TIME_MANAGEMENT -| 생산성 및 시간 관리 - -| FINANCE_AND_ASSET_MANAGEMENT -| 재정 및 자산 관리 - -| SELF_DEVELOPMENT -| 자기 개발 - -| LIFE_ORGANIZATION_AND_MANAGEMENT -| 생활 정리 및 관리 - -| SOCIAL_CONNECTIONS -| 사회적 연결 - -| CREATIVITY_AND_ARTS -| 창의력 및 예술 활동 - -| OTHERS -| 기타 -|=== - -=== cycle(주기) 항목 설명 - -[cols="1,1",options="header"] -|=== -| Name | Description - -| DAILY -| 매일 - -| WEEKLY -| 매주 - -| MONTHLY -| 매달 -|=== - -=== cycleDetail(주기 상세 정보) 항목 설명 - -[cols="1,1",options="header"] -|=== -| Name | Description - -| DAILY -| 매일 - -| MON -| 월요일 - -| TUE -| 화요일 - -| WED -| 수요일 - -| THU -| 목요일 - -| FRI -| 금요일 - -| SAT -| 토요일 - -| SUN -| 일요일 - -| FIRST -| 1일 - -| SECOND -| 2일 - -| THIRD -| 3일 - -| FOURTH -| 4일 - -| FIFTH -| 5일 - -| SIXTH -| 6일 - -| SEVENTH -| 7일 - -| EIGHTH -| 8일 - -| NINTH -| 9일 - -| TENTH -| 10일 - -| ELEVENTH -| 11일 - -| TWELFTH -| 12일 - -| THIRTEENTH -| 13일 - -| FOURTEENTH -| 14일 - -| FIFTEENTH -| 15일 - -| SIXTEENTH -| 16일 - -| SEVENTEENTH -| 17일 - -| EIGHTEENTH -| 18일 - -| NINETEENTH -| 19일 - -| TWENTIETH -| 20일 - -| TWENTY_FIRST -| 21일 - -| TWENTY_SECOND -| 22일 - -| TWENTY_THIRD -| 23일 - -| TWENTY_FOURTH -| 24일 - -| TWENTY_FIFTH -| 25일 - -| TWENTY_SIXTH -| 26일 - -| TWENTY_SEVENTH -| 27일 - -| TWENTY_EIGHTH -| 28일 - -| TWENTY_NINTH -| 29일 - -| THIRTIETH -| 30일 - -| THIRTY_FIRST -| 31일 -|=== - -== 챌린지 생성 API - -=== 요청 - -include::{snippets}/challenge/save/http-request.adoc[] -include::{snippets}/challenge/save/request-parts.adoc[] - -=== 응답 - -include::{snippets}/challenge/save/http-response.adoc[] -include::{snippets}/challenge/save/response-fields.adoc[] - -== 챌린지 수정 API - -=== 요청 - -include::{snippets}/challenge/update/http-request.adoc[] -include::{snippets}/challenge/update/path-parameters.adoc[] -include::{snippets}/challenge/update/request-parts.adoc[] - -=== 응답 - -include::{snippets}/challenge/update/http-response.adoc[] -include::{snippets}/challenge/update/response-fields.adoc[] - -== 챌린지 전체 조회 API - -=== 요청 - -include::{snippets}/challenge/findAll/http-request.adoc[] -include::{snippets}/challenge/findAll/query-parameters.adoc[] - -=== 응답 - -include::{snippets}/challenge/findAll/http-response.adoc[] -include::{snippets}/challenge/findAll/response-fields.adoc[] - -== 챌린지 카테고리 별 검색 API - -=== 요청 - -include::{snippets}/challenge/search/http-request.adoc[] -include::{snippets}/challenge/search/query-parameters.adoc[] - -=== 응답 - -include::{snippets}/challenge/search/http-response.adoc[] -include::{snippets}/challenge/search/response-fields.adoc[] - -== 챌린지 상세 조회 API - -=== 요청 - -include::{snippets}/challenge/findById/http-request.adoc[] -include::{snippets}/challenge/findById/path-parameters.adoc - -=== 응답 - -include::{snippets}/challenge/findById/http-response.adoc[] -include::{snippets}/challenge/findById/response-fields.adoc[] - -== 챌린지 삭제 API - -=== 요청 - -include::{snippets}/challenge/delete/http-request.adoc[] -include::{snippets}/challenge/delete/path-parameters.adoc[] - -=== 응답 - -include::{snippets}/challenge/delete/http-response.adoc[] - -== 챌린지 참여 API - -=== 요청 - -include::{snippets}/challenge/addChallengeToPersonalDashboard/http-request.adoc[] -include::{snippets}/challenge/addChallengeToPersonalDashboard/path-parameters.adoc[] - -=== 응답 - -include::{snippets}/challenge/addChallengeToPersonalDashboard/http-response.adoc[] - -== 챌린지 삭제 API - -include::{snippets}/challenge/withdraw/http-request.adoc[] -include::{snippets}/challenge/withdraw/path-parameters.adoc[] - -=== 응답 - -include::{snippets}/challenge/withdraw/http-response.adoc[] diff --git a/src/docs/asciidoc/follow.adoc b/src/docs/asciidoc/follow.adoc deleted file mode 100644 index 562bf9ce..00000000 --- a/src/docs/asciidoc/follow.adoc +++ /dev/null @@ -1,90 +0,0 @@ -= 친구 API 문서 - -== 친구 추가 요청 API - -=== 요청 - -include::{snippets}/follow/save/http-request.adoc[] -include::{snippets}/follow/save/request-fields.adoc[] -include::{snippets}/follow/accept/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/save/http-response.adoc[] -include::{snippets}/follow/save/response-fields.adoc[] - -== 친구 요청 수락 API - -=== 요청 - -include::{snippets}/follow/accept/http-request.adoc[] -include::{snippets}/follow/accept/path-parameters.adoc[] - -=== 응답 - -include::{snippets}/follow/accept/http-response.adoc[] -include::{snippets}/follow/accept/response-fields.adoc[] - -== 내 친구 목록 조회 API - -=== 요청 - -include::{snippets}/follow/findFollowList/http-request.adoc[] -include::{snippets}/follow/findFollowList/query-parameters.adoc[] -include::{snippets}/follow/accept/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/findFollowList/http-response.adoc[] -include::{snippets}/follow/findFollowList/response-fields.adoc[] - -== 추천 친구 목록 조회 API - -=== 요청 - -include::{snippets}/follow/findRecommendedFollowList/http-request.adoc[] -include::{snippets}/follow/findRecommendedFollowList/query-parameters.adoc[] -include::{snippets}/follow/accept/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/findRecommendedFollowList/http-response.adoc[] -include::{snippets}/follow/findRecommendedFollowList/response-fields.adoc[] - -== 친구 삭제 API - -=== 요청 - -include::{snippets}/follow/delete/http-request.adoc[] -include::{snippets}/follow/delete/path-parameters.adoc[] -include::{snippets}/follow/accept/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/delete/http-response.adoc[] -include::{snippets}/follow/delete/response-fields.adoc[] - -== 키워드로 전체 친구 조회 API - -=== 요청 - -include::{snippets}/follow/searchFollowListUsingKeywords/http-request.adoc[] -include::{snippets}/follow/searchFollowListUsingKeywords/query-parameters.adoc[] -include::{snippets}/follow/accept/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/searchFollowListUsingKeywords/http-response.adoc[] -include::{snippets}/follow/searchFollowListUsingKeywords/response-fields.adoc[] - -== 내 팔로우 정보 조회 API - -=== 요청 - -include::{snippets}/follow/findMyFollowsCount/http-request.adoc[] -include::{snippets}/follow/findMyFollowsCount/request-headers.adoc[] - -=== 응답 - -include::{snippets}/follow/findMyFollowsCount/http-response.adoc[] -include::{snippets}/follow/findMyFollowsCount/response-fields.adoc[] diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc deleted file mode 100644 index f9dd6da4..00000000 --- a/src/docs/asciidoc/index.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= 끄적끄적 API 문서 -:doctype: book -:icons: font -:source-highlighter: highlightjs -:toc: left -:toclevels: 3 - -include::block.adoc[] -include::challenge.adoc[] - -include::personalDashboard.adoc[] -include::notification.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/login.adoc b/src/docs/asciidoc/login.adoc deleted file mode 100644 index 17c23586..00000000 --- a/src/docs/asciidoc/login.adoc +++ /dev/null @@ -1,25 +0,0 @@ -== 로그인 API 문서 - -=== 로그인 API - -==== 요청 - -include::{snippets}/auth/login/http-request.adoc[] -include::{snippets}/auth/login/request-fields.adoc[] - -==== 응답 - -include::{snippets}/auth/login/http-response.adoc[] -include::{snippets}/auth/login/response-fields.adoc[] - -=== 리프레쉬 토큰으로 액세스 토큰 발급 API - -==== 요청 - -include::{snippets}/auth/getNewAccessToken/http-request.adoc[] -include::{snippets}/auth/getNewAccessToken/request-fields.adoc[] - -==== 응답 - -include::{snippets}/auth/getNewAccessToken/http-response.adoc[] -include::{snippets}/auth/getNewAccessToken/response-fields.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/member.adoc b/src/docs/asciidoc/member.adoc deleted file mode 100644 index 48a9d425..00000000 --- a/src/docs/asciidoc/member.adoc +++ /dev/null @@ -1,63 +0,0 @@ -== 멤버 API 문서 - -=== 내 프로필 정보 조회 API - -==== 요청 - -include::{snippets}/member/mypage/http-request.adoc[] -include::{snippets}/member/mypage/request-headers.adoc[] - -==== 응답 - -include::{snippets}/member/mypage/http-response.adoc[] -include::{snippets}/member/mypage/response-fields.adoc[] - -=== 대시보드와 챌린지 정보 조회 API - -==== 요청 - -include::{snippets}/member/team-challenges/http-request.adoc[] -include::{snippets}/member/team-challenges/request-headers.adoc[] -include::{snippets}/member/team-challenges/query-parameters.adoc[] - - -==== 응답 - -include::{snippets}/member/team-challenges/http-response.adoc[] -include::{snippets}/member/team-challenges/response-fields.adoc[] - -=== 내 프로필 정보 수정 API - -==== 요청 - -include::{snippets}/member/mypage-update/http-request.adoc[] -include::{snippets}/member/mypage-update/request-headers.adoc[] -include::{snippets}/member/mypage-update/request-fields.adoc[] - -==== 응답 - -include::{snippets}/member/mypage/http-response.adoc[] -include::{snippets}/member/mypage/response-fields.adoc[] - -=== 친구 프로필 정보 조회 API - -==== 요청 - -include::{snippets}/member/friend-profile/http-request.adoc[] - -==== 응답 - -include::{snippets}/member/friend-profile/http-response.adoc[] -include::{snippets}/member/friend-profile/response-fields.adoc[] - -=== 친구 public 개인 대시보드와 챌린지 정보 조회 API - -==== 요청 - -include::{snippets}/member/friend-dashboard-challenges/http-request.adoc[] -include::{snippets}/member/friend-dashboard-challenges/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/member/friend-dashboard-challenges/http-response.adoc[] -include::{snippets}/member/friend-dashboard-challenges/response-fields.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/notification.adoc b/src/docs/asciidoc/notification.adoc deleted file mode 100644 index 13fcb0a5..00000000 --- a/src/docs/asciidoc/notification.adoc +++ /dev/null @@ -1,35 +0,0 @@ -== 알림 API 문서 - -=== 알림 등록 API - -==== 요청 - -include::{snippets}/notification/stream/http-request.adoc[] -include::{snippets}/notification/stream/request-headers.adoc[] - -==== 응답 - -include::{snippets}/notification/stream/http-response.adoc[] - -=== 알림 전체 리스트 조회 - -==== 요청 - -include::{snippets}/notification/findAll/http-request.adoc[] -include::{snippets}/notification/findAll/request-headers.adoc[] - -==== 응답 - -include::{snippets}/notification/findAll/http-response.adoc[] -include::{snippets}/notification/findAll/response-fields.adoc[] - -=== 모든 알림 읽음으로 표시 - -=== 요청 - -include::{snippets}/notification/markAsAllRead/http-request.adoc[] -include::{snippets}/notification/markAsAllRead/request-headers.adoc[] - -=== 응답 - -include::{snippets}/notification/markAsAllRead/http-response.adoc[] diff --git a/src/docs/asciidoc/personalDashboard.adoc b/src/docs/asciidoc/personalDashboard.adoc deleted file mode 100644 index 4b6a4d7c..00000000 --- a/src/docs/asciidoc/personalDashboard.adoc +++ /dev/null @@ -1,77 +0,0 @@ -== 개인 대시보드 API 문서 - -=== 개인 대시보드 생성 API - -==== 요청 - -include::{snippets}/dashboard/personal/save/http-request.adoc[] -include::{snippets}/dashboard/personal/save/request-headers.adoc[] -include::{snippets}/dashboard/personal/save/request-fields.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/save/http-response.adoc[] -include::{snippets}/dashboard/personal/save/response-fields.adoc[] - -=== 개인 대시보드 수정 API - -==== 요청 - -include::{snippets}/dashboard/personal/update/http-request.adoc[] -include::{snippets}/dashboard/personal/update/request-headers.adoc[] -include::{snippets}/dashboard/personal/update/path-parameters.adoc[] -include::{snippets}/dashboard/personal/update/request-fields.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/update/http-response.adoc[] -include::{snippets}/dashboard/personal/update/response-fields.adoc[] - -=== 개인 대시보드 전체 조회 - -==== 요청 - -include::{snippets}/dashboard/personal/findForPersonalDashboard/http-request.adoc[] -include::{snippets}/dashboard/personal/findForPersonalDashboard/request-headers.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/findForPersonalDashboard/http-response.adoc[] -include::{snippets}/dashboard/personal/findForPersonalDashboard/response-fields.adoc[] - -=== 개인 대시보드 상세 조회 - -==== 요청 - -include::{snippets}/dashboard/personal/findById/http-request.adoc[] -include::{snippets}/dashboard/personal/findById/request-headers.adoc[] -include::{snippets}/dashboard/personal/findById/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/findById/http-response.adoc[] -include::{snippets}/dashboard/personal/findById/response-fields.adoc[] - -=== 사용자의 개인 대시보드 카테고리 조회 - -==== 요청 - -include::{snippets}/dashboard/personal/categories/http-request.adoc[] -include::{snippets}/dashboard/personal/categories/request-headers.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/categories/http-response.adoc[] -include::{snippets}/dashboard/personal/categories/response-fields.adoc[] - -=== 개인 대시보드 삭제 API - -==== 요청 - -include::{snippets}/dashboard/personal/delete/http-request.adoc[] -include::{snippets}/dashboard/personal/delete/request-headers.adoc[] -include::{snippets}/dashboard/personal/delete/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/personal/delete/http-response.adoc[] \ No newline at end of file diff --git a/src/docs/asciidoc/teamDashboard.adoc b/src/docs/asciidoc/teamDashboard.adoc deleted file mode 100644 index 278c275d..00000000 --- a/src/docs/asciidoc/teamDashboard.adoc +++ /dev/null @@ -1,93 +0,0 @@ -== 팀 대시보드 API 문서 - -=== 팀 대시보드 생성 API - -==== 요청 - -include::{snippets}/dashboard/team/save/http-request.adoc[] -include::{snippets}/dashboard/team/save/request-fields.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/save/http-response.adoc[] -include::{snippets}/dashboard/team/save/response-fields.adoc[] - -=== 팀 대시보드 수정 API - -==== 요청 - -include::{snippets}/dashboard/team/update/http-request.adoc[] -include::{snippets}/dashboard/team/update/path-parameters.adoc[] -include::{snippets}/dashboard/team/update/request-fields.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/update/http-response.adoc[] -include::{snippets}/dashboard/team/update/response-fields.adoc[] - -=== 팀 대시보드 전체 조회 - -==== 요청 - -include::{snippets}/dashboard/team/findForTeamDashboard/http-request.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/findForTeamDashboard/http-response.adoc[] -include::{snippets}/dashboard/team/findForTeamDashboard/response-fields.adoc[] - -=== 팀 대시보드 상세 조회 - -==== 요청 - -include::{snippets}/dashboard/team/findById/http-request.adoc[] -include::{snippets}/dashboard/team/findById/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/findById/http-response.adoc[] -include::{snippets}/dashboard/team/findById/response-fields.adoc[] - -=== 팀 대시보드 삭제 - -==== 요청 - -include::{snippets}/dashboard/team/delete/http-request.adoc[] -include::{snippets}/dashboard/team/delete/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/delete/http-response.adoc[] - -=== 팀 대시보드 초대 멤버 리스트 조회 - -==== 요청 - -include::{snippets}/dashboard/team/search/http-request.adoc[] -include::{snippets}/dashboard/team/search/query-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/search/http-response.adoc[] - -=== 팀 대시보드 참여 초대 수락 - -==== 요청 - -include::{snippets}/dashboard/team/join/http-request.adoc[] -include::{snippets}/dashboard/team/join/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/join/http-response.adoc[] - -=== 팀 대시보드 탈퇴 - -==== 요청 - -include::{snippets}/dashboard/team/leave/http-request.adoc[] -include::{snippets}/dashboard/team/leave/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/dashboard/team/leave/http-response.adoc[] diff --git a/src/docs/asciidoc/teamDocument.adoc b/src/docs/asciidoc/teamDocument.adoc deleted file mode 100644 index a5f33494..00000000 --- a/src/docs/asciidoc/teamDocument.adoc +++ /dev/null @@ -1,74 +0,0 @@ -== Team Document API Documentation - -=== Team Document 생성 API - -==== 요청 - -include::{snippets}/teamDocument/save/http-request.adoc[] -include::{snippets}/teamDocument/save/request-fields.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/update/http-response.adoc[] -include::{snippets}/teamDocument/update/response-fields.adoc[] - -=== Team Document 수정 API - -==== 요청 - -include::{snippets}/teamDocument/update/http-request.adoc[] -include::{snippets}/teamDocument/update/path-parameters.adoc[] -include::{snippets}/teamDocument/update/request-fields.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/update/http-response.adoc[] -include::{snippets}/teamDocument/update/response-fields.adoc[] - -=== Team Document 상세 조회 API - -==== 요청 - -include::{snippets}/teamDocument/findById/http-request.adoc[] -include::{snippets}/teamDocument/findById/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/findById/http-response.adoc[] -include::{snippets}/teamDocument/findById/response-fields.adoc[] - -=== Team Document 카테고리 조회 API - -==== 요청 - -include::{snippets}/teamDocument/findCategories/http-request.adoc[] -include::{snippets}/teamDocument/findCategories/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/findCategories/http-response.adoc[] -include::{snippets}/teamDocument/findCategories/response-fields.adoc[] - -=== Team Document 카테고리별 검색 API - -==== 요청 - -include::{snippets}/teamDocument/search-by-category/http-request.adoc[] -include::{snippets}/teamDocument/search-by-category/query-parameters.adoc[] -include::{snippets}/teamDocument/search-by-category/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/search-by-category/http-response.adoc[] -include::{snippets}/teamDocument/search-by-category/response-fields.adoc[] - -=== Team Document 삭제 API - -==== 요청 - -include::{snippets}/teamDocument/delete/http-request.adoc[] -include::{snippets}/teamDocument/delete/path-parameters.adoc[] - -==== 응답 - -include::{snippets}/teamDocument/delete/http-response.adoc[]