Skip to content

Commit

Permalink
docs: API 문서 최신화 v2
Browse files Browse the repository at this point in the history
  • Loading branch information
jjuny0310 committed Nov 10, 2023
1 parent 61c1b12 commit c81ca01
Show file tree
Hide file tree
Showing 3 changed files with 975 additions and 818 deletions.
109 changes: 55 additions & 54 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,59 @@
:sectnums:
:docinfo: shared-head

[[overview]]
= Overview

[[overview_http_verbs]]
== HTTP Method

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its
use of HTTP verbs.

|===
| Verb | Usage

| `GET`
| Used to retrieve a resource

| `POST`
| Used to create a new resource

| `PUT`
| PUT 설명

| `PATCH`
| Used to update an existing resource, including partial updates

| `DELETE`
| Used to delete an existing resource
|===

[[overview_http_status_codes]]
== HTTP status codes

RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its
use of HTTP status codes.

|===
| Status code | Usage

| `200 OK`
| The request completed successfully

| `201 Created`
| A new resource has been created successfully. The resource's URI is available from the response's
`Location` header

| `204 No Content`
| An update to an existing resource has been applied successfully

| `400 Bad Request`
| The request was malformed. The response body will include an error providing further information

| `404 Not Found`
| The requested resource did not exist
|===
// [[overview]]
// = Overview
//
// [[overview_http_verbs]]
// == HTTP Method
//
// RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its
// use of HTTP verbs.

// |===
// | Verb | Usage
//
// | `GET`
// | Used to retrieve a resource
//
// | `POST`
// | Used to create a new resource
//
// | `PUT`
// | PUT 설명
//
// | `PATCH`
// | Used to update an existing resource, including partial updates
//
// | `DELETE`
// | Used to delete an existing resource
// |===

// [[overview_http_status_codes]]
// == HTTP status codes
//
// RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its
// use of HTTP status codes.

// |===
// | Status code | Usage
//
// | `200 OK`
// | The request completed successfully
//
// | `201 Created`
// | A new resource has been created successfully. The resource's URI is available from the response's
// `Location` header
//
// | `204 No Content`
// | An update to an existing resource has been applied successfully
//
// | `400 Bad Request`
// | The request was malformed. The response body will include an error providing further information
//
// | `404 Not Found`
// | The requested resource did not exist
// |===

include::board.adoc[]
include::post.adoc[]
Expand All @@ -74,4 +74,5 @@ include::recruit.adoc[]
include::recruitApplication.adoc[]
include::recruitComment.adoc[]
include::storage.adoc[]
include::report.adoc[]
include::report.adoc[]
include::notification.adoc[]
5 changes: 3 additions & 2 deletions src/docs/asciidoc/notification.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
== 알림

=== 알림 목록 조회
operation::notification/get-notifications-by-cursor[snippets='http-request,cookie,http-response,response-fields']
operation::notification/get-notifications-by-cursor[snippets='http-request,http-response,cookie,response-fields']

=== 새로운 알림 확인
operation::notification/check-new_notification[snippets='http-request,cookie,http-response,response-fields']
operation::notification/check-notification[snippets='http-request,http-response,cookie,response-fields']
Loading

0 comments on commit c81ca01

Please sign in to comment.