-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 로그인된 사용자 알람 목록 조회, 알람 삭제, 알람 읽음 여부 업데이트 api 문서 추가
- Loading branch information
Showing
3 changed files
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
ifndef::snippets[] | ||
:snippets: ../../../build/generated-snippets | ||
endif::[] | ||
:doctype: book | ||
:icons: font | ||
:source-highlighter: highlight.js | ||
:toc: left | ||
:toclevels: 3 | ||
:sectlinks: | ||
:operation-http-request-title: Example Request | ||
:operation-http-response-title: Example Response | ||
|
||
==== *알람 삭제 API* | ||
|
||
===== *Http Request* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-delete-api-test/delete-alarm-by-alarm-id/http-request.adoc[] | ||
|
||
===== *Http Request Headers* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-delete-api-test/delete-alarm-by-alarm-id/request-headers.adoc[] | ||
|
||
===== *Http Request Path Parameters* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-delete-api-test/delete-alarm-by-alarm-id/path-parameters.adoc[] | ||
|
||
===== *Http Response* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-delete-api-test/delete-alarm-by-alarm-id/http-response.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
ifndef::snippets[] | ||
:snippets: ../../../build/generated-snippets | ||
endif::[] | ||
:doctype: book | ||
:icons: font | ||
:source-highlighter: highlight.js | ||
:toc: left | ||
:toclevels: 3 | ||
:sectlinks: | ||
:operation-http-request-title: Example Request | ||
:operation-http-response-title: Example Response | ||
|
||
==== *로그인된 사용자 알람 목록 조회 API* | ||
|
||
===== *Http Request* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-read-with-logined-member-api-test/read-alarms-by-member-id/http-request.adoc[] | ||
|
||
===== *Http Request Headers* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-read-with-logined-member-api-test/read-alarms-by-member-id/request-headers.adoc[] | ||
|
||
===== *Http Response* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-read-with-logined-member-api-test/read-alarms-by-member-id/http-response.adoc[] | ||
|
||
===== *Http Response Fields* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-read-with-logined-member-api-test/read-alarms-by-member-id/response-fields.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
ifndef::snippets[] | ||
:snippets: ../../../build/generated-snippets | ||
endif::[] | ||
:doctype: book | ||
:icons: font | ||
:source-highlighter: highlight.js | ||
:toc: left | ||
:toclevels: 3 | ||
:sectlinks: | ||
:operation-http-request-title: Example Request | ||
:operation-http-response-title: Example Response | ||
|
||
==== *알람 읽음 여부 업데이트 API* | ||
|
||
===== *Http Request* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-update-api-test/update-alarm-is-read-true-by-member/http-request.adoc[] | ||
|
||
===== *Http Request Headers* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-update-api-test/update-alarm-is-read-true-by-member/request-headers.adoc[] | ||
|
||
===== *Http Request Path Parameters* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-update-api-test/update-alarm-is-read-true-by-member/path-parameters.adoc[] | ||
|
||
===== *Http Response* | ||
|
||
include::{snippets}/../../build/generated-snippets/alarm-update-api-test/update-alarm-is-read-true-by-member/http-response.adoc[] |