From 01837ab6098e5c0fba588d7971faec8178b68687 Mon Sep 17 00:00:00 2001 From: jhsseonn Date: Sat, 16 Mar 2024 20:46:25 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20api=20=EB=AC=B8=EC=84=9C=20=EC=97=85?= =?UTF-8?q?=EB=8D=B0=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../resources/static/docs/authentication.html | 2 +- src/main/resources/static/docs/docs.html | 52 +- src/main/resources/static/docs/friend.html | 2 +- src/main/resources/static/docs/goal.html | 42 +- .../resources/static/docs/notification.html | 2 +- src/main/resources/static/docs/poke.html | 2 +- src/main/resources/static/docs/report.html | 760 ++++++++++++++++++ src/main/resources/static/docs/stamp.html | 2 +- .../resources/static/docs/themecolor.html | 2 +- src/main/resources/static/docs/user.html | 2 +- 10 files changed, 814 insertions(+), 54 deletions(-) create mode 100644 src/main/resources/static/docs/report.html diff --git a/src/main/resources/static/docs/authentication.html b/src/main/resources/static/docs/authentication.html index 1793dc56..eece4641 100644 --- a/src/main/resources/static/docs/authentication.html +++ b/src/main/resources/static/docs/authentication.html @@ -669,7 +669,7 @@

응답

diff --git a/src/main/resources/static/docs/docs.html b/src/main/resources/static/docs/docs.html index 3d6215d3..be8f5ab1 100644 --- a/src/main/resources/static/docs/docs.html +++ b/src/main/resources/static/docs/docs.html @@ -2306,8 +2306,8 @@
@@ -2479,8 +2479,8 @@
@@ -3079,8 +3079,8 @@
콕 찌르기

콕 찌르기 요청

-

요청

+

요청

-
HTTP request
+
HTTP request
POST /goals/1/poke/2 HTTP/1.1
@@ -3510,7 +3510,7 @@
-
Request headers
+
Request headers
@@ -3535,7 +3535,7 @@
-
Path parameters
+
Path parameters
@@ -3562,9 +3562,9 @@
-

응답

+

응답

-
HTTP response
+
HTTP response
HTTP/1.1 204 No Content
@@ -3579,7 +3579,7 @@
Version 0.0.1-SNAPSHOT
-Last updated 2024-03-01 18:25:36 +0900 +Last updated 2024-03-16 03:02:37 +0900
diff --git a/src/main/resources/static/docs/friend.html b/src/main/resources/static/docs/friend.html index c4542be5..35ca6675 100644 --- a/src/main/resources/static/docs/friend.html +++ b/src/main/resources/static/docs/friend.html @@ -1093,7 +1093,7 @@
HTTP response
diff --git a/src/main/resources/static/docs/goal.html b/src/main/resources/static/docs/goal.html index 1be07e0e..6e5fce02 100644 --- a/src/main/resources/static/docs/goal.html +++ b/src/main/resources/static/docs/goal.html @@ -456,8 +456,8 @@
HTTP request
{ "name" : "골 제목", "memo" : "골 메모", - "startDate" : "2024-03-03", - "endDate" : "2024-03-13", + "startDate" : "2024-03-16", + "endDate" : "2024-03-26", "teamUserIds" : [ 1, 2, 3 ] }
@@ -629,8 +629,8 @@
HTTP response
"id" : 1, "name" : "테스트 골1", "memo" : "테스트 골 메모1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-13", + "startDate" : "2024-03-16", + "endDate" : "2024-03-26", "days" : 11, "managerId" : 1, "teams" : [ { @@ -658,8 +658,8 @@
Response body
"id" : 1, "name" : "테스트 골1", "memo" : "테스트 골 메모1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-13", + "startDate" : "2024-03-16", + "endDate" : "2024-03-26", "days" : 11, "managerId" : 1, "teams" : [ { @@ -813,8 +813,8 @@
HTTP response
"goals" : [ { "id" : 1, "name" : "테스트 골1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-13", + "startDate" : "2024-03-16", + "endDate" : "2024-03-26", "days" : 11, "teams" : [ { "id" : 1, @@ -838,8 +838,8 @@
Response body
"goals" : [ { "id" : 1, "name" : "테스트 골1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-13", + "startDate" : "2024-03-16", + "endDate" : "2024-03-26", "days" : 11, "teams" : [ { "id" : 1, @@ -969,8 +969,8 @@
HTTP response
"goals" : [ { "id" : 2, "name" : "테스트 골2", - "startDate" : "2024-03-03", - "endDate" : "2024-03-08", + "startDate" : "2024-03-16", + "endDate" : "2024-03-21", "days" : 6, "teams" : [ { "id" : 1, @@ -994,8 +994,8 @@
Response body
"goals" : [ { "id" : 2, "name" : "테스트 골2", - "startDate" : "2024-03-03", - "endDate" : "2024-03-08", + "startDate" : "2024-03-16", + "endDate" : "2024-03-21", "days" : 6, "teams" : [ { "id" : 1, @@ -1162,7 +1162,7 @@
HTTP request
{ "name" : "수정된 테스트 골1", "memo" : "수정된 테스트 골 메모1", - "endDate" : "2024-03-23", + "endDate" : "2024-04-05", "teamUserIds" : [ 1, 2, 3 ] }
@@ -1229,8 +1229,8 @@
HTTP response
"id" : 1, "name" : "수정된 테스트 골1", "memo" : "수정된 테스트 골 메모1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-23", + "startDate" : "2024-03-16", + "endDate" : "2024-04-05", "days" : 20, "managerId" : 1, "teams" : [ { @@ -1264,8 +1264,8 @@
Response body
"id" : 1, "name" : "수정된 테스트 골1", "memo" : "수정된 테스트 골 메모1", - "startDate" : "2024-03-03", - "endDate" : "2024-03-23", + "startDate" : "2024-03-16", + "endDate" : "2024-04-05", "days" : 20, "managerId" : 1, "teams" : [ { @@ -1376,8 +1376,8 @@
Response fields
- + \ No newline at end of file diff --git a/src/main/resources/static/docs/notification.html b/src/main/resources/static/docs/notification.html index ae884104..f101342b 100644 --- a/src/main/resources/static/docs/notification.html +++ b/src/main/resources/static/docs/notification.html @@ -550,7 +550,7 @@

응답

diff --git a/src/main/resources/static/docs/poke.html b/src/main/resources/static/docs/poke.html index bd0631ad..0bcf29b1 100644 --- a/src/main/resources/static/docs/poke.html +++ b/src/main/resources/static/docs/poke.html @@ -523,7 +523,7 @@
HTTP response
diff --git a/src/main/resources/static/docs/report.html b/src/main/resources/static/docs/report.html new file mode 100644 index 00000000..d10f8786 --- /dev/null +++ b/src/main/resources/static/docs/report.html @@ -0,0 +1,760 @@ + + + + + + + +사용자 신고 + + + + + +
+
+

사용자 신고

+
+

요청

+
+
HTTP request
+
+
+
POST /reports/users/2 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+X-API-VERSION: 1
+Authorization: Bearer access_token
+
+{
+  "content" : "신고합니다."
+}
+
+
+
+
+
Request headers
+
Table 2. /goals/{goalId}/poke/{userId}
++++ + + + + + + + + + + + + + + + + +
NameDescription

X-API-VERSION

요청 버전

Authorization

액세스 토큰

+
+
+
Path parameters
+ + ++++ + + + + + + + + + + + + +
Table 1. /reports/users/{userId}
ParameterDescription

userId

신고할 사용자 아이디

+
+
+
Request fields
+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

content

String

신고 내용

+
+
+
+

응답

+
+
HTTP response
+
+
+
HTTP/1.1 204 No Content
+
+
+
+
+
+
+

골 신고

+
+

요청

+
+
HTTP request
+
+
+
POST /reports/goals/2 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+X-API-VERSION: 1
+Authorization: Bearer access_token
+
+{
+  "content" : "신고합니다."
+}
+
+
+
+
+
Request headers
+ ++++ + + + + + + + + + + + + + + + + +
NameDescription

X-API-VERSION

요청 버전

Authorization

액세스 토큰

+
+
+
Path parameters
+ + ++++ + + + + + + + + + + + + +
Table 1. /reports/goals/{goalId}
ParameterDescription

goalId

신고할 골 아이디

+
+
+
Request fields
+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

content

String

신고 내용

+
+
+
+

응답

+
+
HTTP response
+
+
+
HTTP/1.1 204 No Content
+
+
+
+
+
+
+

스탬프 신고

+
+

요청

+
+
HTTP request
+
+
+
POST /reports/stamps/2 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+X-API-VERSION: 1
+Authorization: Bearer access_token
+
+{
+  "content" : "신고합니다."
+}
+
+
+
+
+
Request headers
+ ++++ + + + + + + + + + + + + + + + + +
NameDescription

X-API-VERSION

요청 버전

Authorization

액세스 토큰

+
+
+
Path parameters
+ + ++++ + + + + + + + + + + + + +
Table 1. /reports/stamps/{stampId}
ParameterDescription

stampId

신고할 스탬프 아이디

+
+
+
Request fields
+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

content

String

신고 내용

+
+
+
+

응답

+
+
HTTP response
+
+
+
HTTP/1.1 204 No Content
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/stamp.html b/src/main/resources/static/docs/stamp.html index 4cd10cd2..52e5fb07 100644 --- a/src/main/resources/static/docs/stamp.html +++ b/src/main/resources/static/docs/stamp.html @@ -706,7 +706,7 @@
Response fields
diff --git a/src/main/resources/static/docs/themecolor.html b/src/main/resources/static/docs/themecolor.html index 1533480f..5b3d4e3c 100644 --- a/src/main/resources/static/docs/themecolor.html +++ b/src/main/resources/static/docs/themecolor.html @@ -524,7 +524,7 @@

응답

diff --git a/src/main/resources/static/docs/user.html b/src/main/resources/static/docs/user.html index 9eaa5d69..98353208 100644 --- a/src/main/resources/static/docs/user.html +++ b/src/main/resources/static/docs/user.html @@ -823,7 +823,7 @@

응답