Skip to content

Commit

Permalink
[DOCS] 충돌 해결 #206
Browse files Browse the repository at this point in the history
  • Loading branch information
@ldk980130
ldk980130 committed Sep 14, 2024
1 parent d907053 commit e3fc2bf
Showing 1 changed file with 198 additions and 14 deletions.
212 changes: 198 additions & 14 deletions src/main/resources/static/docs/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,7 @@ <h1>훕치치 서버 API 문서</h1>
<ul class="sectlevel2">
<li><a href="#_득점_타임라인_생성">득점 타임라인 생성</a></li>
<li><a href="#_교체_타임라인_생성">교체 타임라인 생성</a></li>
<li><a href="#_게임_진행_타임라인_생성">게임 진행 타임라인 생성</a></li>
<li><a href="#_게임의_타임라인_조회">게임의 타임라인 조회</a></li>
<li><a href="#_타임라인_삭제">타임라인 삭제</a></li>
</ul>
Expand Down Expand Up @@ -1411,7 +1412,7 @@ <h4 id="_게임_등록_http_request"><a class="link" href="#_게임_등록_http_
"round" : "16강",
"quarter" : "경기전",
"state" : "SCHEDULED",
"startTime" : "2024-09-10T21:21:14.922773",
"startTime" : "2024-09-14T20:18:35.933557",
"idOfTeam1" : 1,
"idOfTeam2" : 2,
"videoId" : "videoId"
Expand Down Expand Up @@ -1726,8 +1727,8 @@ <h4 id="_리그_생성_http_request"><a class="link" href="#_리그_생성_http_
"organizationId" : 1,
"name" : "우물정 제기차기 대회",
"maxRound" : "4강",
"startAt" : "2024-09-10T21:21:15.379606",
"endAt" : "2024-09-10T21:21:15.379615"
"startAt" : "2024-09-14T20:18:36.181096",
"endAt" : "2024-09-14T20:18:36.181098"
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -1802,8 +1803,8 @@ <h4 id="_리그_수정_http_request"><a class="link" href="#_리그_수정_http_

{
"name" : "훕치치배 망고 빨리먹기 대회",
"startAt" : "2024-09-10T21:21:15.472437",
"endAt" : "2024-09-10T21:21:15.472445",
"startAt" : "2024-09-14T20:18:36.196107",
"endAt" : "2024-09-14T20:18:36.196111",
"maxRound" : "16강"
}</code></pre>
</div>
Expand Down Expand Up @@ -2584,12 +2585,12 @@ <h4 id="_매니저가_생성한_리그_전체_조회_http_response"><a class="li
"state" : "진행 중",
"sizeOfLeagueTeams" : 2,
"maxRound" : "16강",
"startAt" : "2024-09-10T21:21:20.177233",
"endAt" : "2024-09-10T21:21:20.177234",
"startAt" : "2024-09-14T20:18:39.509649",
"endAt" : "2024-09-14T20:18:39.509649",
"inProgressGames" : [ {
"id" : 1,
"state" : "PLAYING",
"startTime" : "2024-09-10T21:21:20.177222",
"startTime" : "2024-09-14T20:18:39.509643",
"gameTeams" : [ {
"gameTeamId" : 1,
"gameTeamName" : "경영 야생마",
Expand Down Expand Up @@ -3042,9 +3043,9 @@ <h4 id="_득점_타임라인_생성_http_request"><a class="link" href="#_득점
Cookie: HCC_SES=temp-cookie

{
"gameTeamId" : 1,
"recordedQuarterId" : 2,
"recordedAt" : 10,
"gameTeamId" : 1,
"scoreLineupPlayerId" : 1
}</code></pre>
</div>
Expand Down Expand Up @@ -3073,6 +3074,45 @@ <h4 id="_득점_타임라인_생성_path_parameters"><a class="link" href="#_득
</table>
</div>
<div class="sect3">
<h4 id="_득점_타임라인_생성_request_fields"><a class="link" href="#_득점_타임라인_생성_request_fields">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>gameTeamId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">경기 팀의 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedQuarterId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">쿼터 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>scoreLineupPlayerId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">득점 선수 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedAt</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">득점 시간</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_득점_타임라인_생성_http_response"><a class="link" href="#_득점_타임라인_생성_http_response">HTTP response</a></h4>
<div class="listingblock">
<div class="content">
Expand All @@ -3098,9 +3138,9 @@ <h4 id="_교체_타임라인_생성_http_request"><a class="link" href="#_교체
Cookie: HCC_SES=temp-cookie

{
"gameTeamId" : 1,
"recordedQuarterId" : 1,
"recordedAt" : 5,
"gameTeamId" : 1,
"originLineupPlayerId" : 2,
"replacementLineupPlayerId" : 3
}</code></pre>
Expand Down Expand Up @@ -3130,6 +3170,50 @@ <h4 id="_교체_타임라인_생성_path_parameters"><a class="link" href="#_교
</table>
</div>
<div class="sect3">
<h4 id="_교체_타임라인_생성_request_fields"><a class="link" href="#_교체_타임라인_생성_request_fields">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>gameTeamId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">경기 팀의 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedQuarterId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">쿼터 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>originLineupPlayerId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">기존 선수 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>replacementLineupPlayerId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">교체 선수 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedAt</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">교체 시간</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_교체_타임라인_생성_http_response"><a class="link" href="#_교체_타임라인_생성_http_response">HTTP response</a></h4>
<div class="listingblock">
<div class="content">
Expand All @@ -3143,6 +3227,95 @@ <h4 id="_교체_타임라인_생성_http_response"><a class="link" href="#_교
</div>
</div>
<div class="sect2">
<h3 id="_게임_진행_타임라인_생성"><a class="link" href="#_게임_진행_타임라인_생성">게임 진행 타임라인 생성</a></h3>
<div class="sect3">
<h4 id="_게임_진행_타임라인_생성_http_request"><a class="link" href="#_게임_진행_타임라인_생성_http_request">HTTP request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /games/1/timelines/progress HTTP/1.1
Content-Type: application/json
Content-Length: 90
Host: www.api.hufstreaming.site
Cookie: HCC_SES=temp-cookie

{
"recordedQuarterId" : 1,
"recordedAt" : 10,
"gameProgressType" : "QUARTER_START"
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_게임_진행_타임라인_생성_path_parameters"><a class="link" href="#_게임_진행_타임라인_생성_path_parameters">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /games/{gameId}/timelines/progress</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>gameId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">경기의 ID</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_게임_진행_타임라인_생성_request_fields"><a class="link" href="#_게임_진행_타임라인_생성_request_fields">Request fields</a></h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedQuarterId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">쿼터 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedAt</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">교체 시간</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>gameProgressType</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">변경할 게임 진행 상황</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_게임_진행_타임라인_생성_http_response"><a class="link" href="#_게임_진행_타임라인_생성_http_response">HTTP response</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location:</code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_게임의_타임라인_조회"><a class="link" href="#_게임의_타임라인_조회">게임의 타임라인 조회</a></h3>
<div class="sect3">
<h4 id="_게임의_타임라인_조회_http_request"><a class="link" href="#_게임의_타임라인_조회_http_request">HTTP request</a></h4>
Expand Down Expand Up @@ -3185,7 +3358,7 @@ <h4 id="_게임의_타임라인_조회_http_response"><a class="link" href="#_
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 1344
Content-Length: 1492

[ {
"gameQuarter" : "2쿼터",
Expand Down Expand Up @@ -3213,6 +3386,9 @@ <h4 id="_게임의_타임라인_조회_http_response"><a class="link" href="#_
"replacementRecord" : {
"replacementRecordId" : 1,
"replacedPlayerName" : "선수3"
},
"progressRecord" : {
"gameProgressType" : "QUARTER_START"
}
}, {
"recordId" : 1,
Expand All @@ -3238,6 +3414,9 @@ <h4 id="_게임의_타임라인_조회_http_response"><a class="link" href="#_
"replacementRecord" : {
"replacementRecordId" : 1,
"replacedPlayerName" : "선수3"
},
"progressRecord" : {
"gameProgressType" : "QUARTER_END"
}
} ]
} ]</code></pre>
Expand Down Expand Up @@ -3335,6 +3514,11 @@ <h4 id="_게임의_타임라인_조회_response_fields"><a class="link" href="#_
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">REPLACEMENT 타입일 때 교체되어 IN 되는 선수</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[].records[].progressRecord.gameProgressType</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PROGRESS 타입일 때 게임 진행 상태 타입 (GAME_START, QUARTER_START, QUARTER_END, GAME_END)</p></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -3538,7 +3722,7 @@ <h4 id="_사용자_로그인_http_response"><a class="link" href="#_사용자_
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Set-Cookie: HCC_SES=testAccessToken; Path=/; Max-Age=604800; Expires=Tue, 17 Sep 2024 12:21:07 GMT; Secure; HttpOnly; SameSite=Strict</code></pre>
Set-Cookie: HCC_SES=testAccessToken; Path=/; Max-Age=604800; Expires=Sat, 21 Sep 2024 11:18:31 GMT; Secure; HttpOnly; SameSite=Strict</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -3612,7 +3796,7 @@ <h4 id="_사용자_정보_조회_response_fields"><a class="link" href="#_사용
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-09-10 21:20:28 +0900
Last updated 2024-09-14 20:17:52 +0900
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
Expand All @@ -3623,4 +3807,4 @@ <h4 id="_사용자_정보_조회_response_fields"><a class="link" href="#_사용
}
</script>
</body>
</html>
</html>

0 comments on commit e3fc2bf

Please sign in to comment.