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.

Sign up for GitHub

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

Jump to bottom

YEL-193 [add] notice build #419

Merged
merged 2 commits into from
Jan 29, 2024
Merged

YEL-193 [add] notice build #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d5fbce
YEL-193 [feat] notice build
hyeonjeongs Jan 29, 2024
2d2a414
YEL-193 [feat] 날짜 수정
hyeonjeongs Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docs/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@

=== Notice API

* 🆕 link:find-notice.html[공지 조회, 2024-01-26]
* 🆕 link:find-notice.html[공지 조회, 2024-01-29]
87 changes: 31 additions & 56 deletions src/main/resources/static/docs/find-notice.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,12 +447,34 @@ <h2 id="_공지_조회">공지 조회</h2>
<h3 id="_요청">요청</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/notice HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/notice/NOTICE HTTP/1.1
Authorization: Bearer your-access-token</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_요청_파라미터">요청 파라미터</h3>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /api/v1/notice/{tag}</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>tag</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">공지의 종류</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_응답">응답</h3>
<div class="listingblock">
<div class="content">
Expand All @@ -468,72 +490,22 @@ <h3 id="_응답">응답</h3>
"data" : {
"imageUrl" : "imageUrl",
"redirectUrl" : "redirectUrl",
"startDate" : "2024-01-24",
"endDate" : "2024-01-30",
"startDate" : "2024-01-26",
"endDate" : "2024-02-01",
"isAvailable" : true,
"type" : "event",
"type" : "NOTICE",
"title" : "notice title"
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>필드 타입</strong></p>
</div>
<div class="ulist">
<ul>
<li>
<p>"imageUrl": String</p>
<div class="ulist">
<ul>
<li>
<p>공지로 보여줄 이미지 URL입니다.</p>
</li>
</ul>
</div>
</li>
<li>
<p>"redirectUrl: String</p>
<div class="ulist">
<ul>
<li>
<p>클릭시 이동할 웹 URL입니다.</p>
</li>
</ul>
</div>
</li>
<li>
<p>"startDate": String(10)</p>
<div class="ulist">
<ul>
<li>
<p>YYYY-MM-DD (ISO-8601)</p>
</li>
</ul>
</div>
</li>
<li>
<p>"endDate": String(10)</p>
<div class="ulist">
<ul>
<li>
<p>YYYY-MM-DD (ISO-8601)</p>
</li>
</ul>
<p><strong>path variable</strong></p>
</div>
</li>
<li>
<p>"isAvailable": Boolean</p>
</li>
<li>
<p>"type" : String</p>
<div class="ulist">
<ul>
<li>
<p>ENUM 값 &#8594; "NOTICE" | "BANNER"</p>
</li>
</ul>
</div>
<p>tag(ENUM 값) &#8594; "NOTICE" | "BANNER"</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -591,6 +563,9 @@ <h3 id="_changelog">CHANGELOG</h3>
<div class="ulist">
<ul>
<li>
<p>2024.01.29 API tag 추가 및 수정</p>
</li>
<li>
<p>2024.01.26 API 릴리즈</p>
</li>
<li>
Expand Down
Loading