Skip to content

Commit

Permalink
docs: api 문서 업데이트
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhsseonn
jhsseonn committed Mar 16, 2024
1 parent 85fcd06 commit 01837ab
Show file tree
Hide file tree
Showing 10 changed files with 814 additions and 54 deletions.
2 changes: 1 addition & 1 deletion src/main/resources/static/docs/authentication.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ <h4 id="_응답_2">응답</h4>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-01-28 21:29:55 +0900
Last updated 2024-01-26 08:53:29 +0900
</div>
</div>
</body>
Expand Down
52 changes: 26 additions & 26 deletions src/main/resources/static/docs/docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2306,8 +2306,8 @@ <h5 id="_요청_16_http_request"><a class="link" href="#_요청_16_http_request"
{
"name" : "골 제목",
"memo" : "골 메모",
"startDate" : "2024-03-03",
"endDate" : "2024-03-13",
"startDate" : "2024-03-16",
"endDate" : "2024-03-26",
"teamUserIds" : [ 1, 2, 3 ]
}</code></pre>
</div>
Expand Down Expand Up @@ -2479,8 +2479,8 @@ <h5 id="_응답_17_http_response"><a class="link" href="#_응답_17_http_respons
"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" : [ {
Expand Down Expand Up @@ -2508,8 +2508,8 @@ <h5 id="_응답_17_response_body"><a class="link" href="#_응답_17_response_bod
"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" : [ {
Expand Down Expand Up @@ -2663,8 +2663,8 @@ <h5 id="_응답_18_http_response"><a class="link" href="#_응답_18_http_respons
"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,
Expand All @@ -2688,8 +2688,8 @@ <h5 id="_응답_18_response_body"><a class="link" href="#_응답_18_response_bod
"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,
Expand Down Expand Up @@ -2819,8 +2819,8 @@ <h5 id="_응답_19_http_response"><a class="link" href="#_응답_19_http_respons
"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,
Expand All @@ -2844,8 +2844,8 @@ <h5 id="_응답_19_response_body"><a class="link" href="#_응답_19_response_bod
"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,
Expand Down Expand Up @@ -3012,7 +3012,7 @@ <h5 id="_요청_21_http_request"><a class="link" href="#_요청_21_http_request"
{
"name" : "수정된 테스트 골1",
"memo" : "수정된 테스트 골 메모1",
"endDate" : "2024-03-23",
"endDate" : "2024-04-05",
"teamUserIds" : [ 1, 2, 3 ]
}</code></pre>
</div>
Expand Down Expand Up @@ -3079,8 +3079,8 @@ <h5 id="_응답_21_http_response"><a class="link" href="#_응답_21_http_respons
"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" : [ {
Expand Down Expand Up @@ -3114,8 +3114,8 @@ <h5 id="_응답_21_response_body"><a class="link" href="#_응답_21_response_bod
"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" : [ {
Expand Down Expand Up @@ -3497,9 +3497,9 @@ <h2 id="_콕_찌르기"><a class="link" href="#_콕_찌르기">콕 찌르기</a>
<div class="sect2">
<h3 id="_콕_찌르기_요청"><a class="link" href="#_콕_찌르기_요청">콕 찌르기 요청</a></h3>
<div class="sect3">
<h4 id="_요청_22"><a class="link" href="#_요청_22">요청</a></h4>
<h4 id="_요청_24"><a class="link" href="#_요청_24">요청</a></h4>
<div class="sect4">
<h5 id="_요청_22_http_request"><a class="link" href="#_요청_22_http_request">HTTP request</a></h5>
<h5 id="_요청_24_http_request"><a class="link" href="#_요청_24_http_request">HTTP request</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /goals/1/poke/2 HTTP/1.1
Expand All @@ -3510,7 +3510,7 @@ <h5 id="_요청_22_http_request"><a class="link" href="#_요청_22_http_request"
</div>
</div>
<div class="sect4">
<h5 id="_요청_22_request_headers"><a class="link" href="#_요청_22_request_headers">Request headers</a></h5>
<h5 id="_요청_24_request_headers"><a class="link" href="#_요청_24_request_headers">Request headers</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
Expand All @@ -3535,7 +3535,7 @@ <h5 id="_요청_22_request_headers"><a class="link" href="#_요청_22_request_he
</table>
</div>
<div class="sect4">
<h5 id="_요청_22_path_parameters"><a class="link" href="#_요청_22_path_parameters">Path parameters</a></h5>
<h5 id="_요청_24_path_parameters"><a class="link" href="#_요청_24_path_parameters">Path parameters</a></h5>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. /goals/{goalId}/poke/{userId}</caption>
<colgroup>
Expand All @@ -3562,9 +3562,9 @@ <h5 id="_요청_22_path_parameters"><a class="link" href="#_요청_22_path_param
</div>
</div>
<div class="sect3">
<h4 id="_응답_22"><a class="link" href="#_응답_22">응답</a></h4>
<h4 id="_응답_24"><a class="link" href="#_응답_24">응답</a></h4>
<div class="sect4">
<h5 id="_응답_22_http_response"><a class="link" href="#_응답_22_http_response">HTTP response</a></h5>
<h5 id="_응답_24_http_response"><a class="link" href="#_응답_24_http_response">HTTP response</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 204 No Content</code></pre>
Expand All @@ -3579,7 +3579,7 @@ <h5 id="_응답_22_http_response"><a class="link" href="#_응답_22_http_respons
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-03-01 18:25:36 +0900
Last updated 2024-03-16 03:02:37 +0900
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/static/docs/friend.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1093,7 +1093,7 @@ <h5 id="_응답_6_http_response">HTTP response</h5>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-01-28 21:29:55 +0900
Last updated 2024-01-26 08:53:29 +0900
</div>
</div>
</body>
Expand Down
42 changes: 21 additions & 21 deletions src/main/resources/static/docs/goal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -456,8 +456,8 @@ <h5 id="_요청_http_request">HTTP request</h5>
{
"name" : "골 제목",
"memo" : "골 메모",
"startDate" : "2024-03-03",
"endDate" : "2024-03-13",
"startDate" : "2024-03-16",
"endDate" : "2024-03-26",
"teamUserIds" : [ 1, 2, 3 ]
}</code></pre>
</div>
Expand Down Expand Up @@ -629,8 +629,8 @@ <h5 id="_응답_2_http_response">HTTP response</h5>
"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" : [ {
Expand Down Expand Up @@ -658,8 +658,8 @@ <h5 id="_응답_2_response_body">Response body</h5>
"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" : [ {
Expand Down Expand Up @@ -813,8 +813,8 @@ <h5 id="_응답_3_http_response">HTTP response</h5>
"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,
Expand All @@ -838,8 +838,8 @@ <h5 id="_응답_3_response_body">Response body</h5>
"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,
Expand Down Expand Up @@ -969,8 +969,8 @@ <h5 id="_응답_4_http_response">HTTP response</h5>
"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,
Expand All @@ -994,8 +994,8 @@ <h5 id="_응답_4_response_body">Response body</h5>
"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,
Expand Down Expand Up @@ -1162,7 +1162,7 @@ <h5 id="_요청_6_http_request">HTTP request</h5>
{
"name" : "수정된 테스트 골1",
"memo" : "수정된 테스트 골 메모1",
"endDate" : "2024-03-23",
"endDate" : "2024-04-05",
"teamUserIds" : [ 1, 2, 3 ]
}</code></pre>
</div>
Expand Down Expand Up @@ -1229,8 +1229,8 @@ <h5 id="_응답_6_http_response">HTTP response</h5>
"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" : [ {
Expand Down Expand Up @@ -1264,8 +1264,8 @@ <h5 id="_응답_6_response_body">Response body</h5>
"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" : [ {
Expand Down Expand Up @@ -1376,8 +1376,8 @@ <h5 id="_응답_6_response_fields">Response fields</h5>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-02-18 13:48:10 +0900
Last updated 2024-03-16 03:02:37 +0900
</div>
</div>
</body>
</html>
</html>
2 changes: 1 addition & 1 deletion src/main/resources/static/docs/notification.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ <h4 id="_응답">응답</h4>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-02-01 20:29:52 +0900
Last updated 2024-02-01 19:10:19 +0900
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/static/docs/poke.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ <h5 id="_응답_http_response">HTTP response</h5>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-02-18 03:44:22 +0900
Last updated 2024-03-03 01:19:55 +0900
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 01837ab

Please sign in to comment.