Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
93 changes: 64 additions & 29 deletions src/docs/asciidoc/api-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ endif::[]
:sectlinks:
:operation-http-request-title: Example Request
:operation-http-response-title: Example Response
:author: dokkisan
:revdate: 2024-08-07
:author: dokkisan, lvalentine6
:revdate: 2024-11-22
:revnumber: 1.0.0

= Issuefy API 명세서
Expand Down Expand Up @@ -47,39 +47,47 @@ include::{snippets}/issuefy/oauth/logout/http-response.adoc[]

== 2. 리포지토리

=== 2.1 리포지토리 구독
=== 2.1 구독중인 리포지토리 목록 조회

==== HTTP 요청

include::{snippets}/issuefy/subscriptions/post/http-request.adoc[]
include::{snippets}/issuefy/subscriptions/get/http-request.adoc[]

===== 요청 본문
===== 쿼리 매개변수

include::{snippets}/issuefy/subscriptions/post/request-fields.adoc[]
include::{snippets}/issuefy/subscriptions/get/query-parameters.adoc[]

==== HTTP 응답

include::{snippets}/issuefy/subscriptions/post/http-response.adoc[]
include::{snippets}/issuefy/subscriptions/get/http-response.adoc[]

=== 2.2 리포지토리 구독 취소
=== 2.2 리포지토리 구독

==== HTTP 요청
// TODO: 스니펫 host 수정
include::{snippets}/issuefy/subscriptions/delete/http-request.adoc[]

include::{snippets}/issuefy/subscriptions/post/http-request.adoc[]

===== 요청 본문

include::{snippets}/issuefy/subscriptions/post/request-fields.adoc[]

==== HTTP 응답

include::{snippets}/issuefy/subscriptions/delete/http-response.adoc[]
include::{snippets}/issuefy/subscriptions/post/http-response.adoc[]

=== 2.3 구독중인 리포지토리 목록 조회
=== 2.3 리포지토리 구독 취소

==== HTTP 요청

include::{snippets}/issuefy/subscriptions/get/http-request.adoc[]
include::{snippets}/issuefy/subscriptions/delete/http-request.adoc[]

===== 경로 매개변수

include::{snippets}/issuefy/subscriptions/delete/path-parameters.adoc[]

==== HTTP 응답

include::{snippets}/issuefy/subscriptions/get/http-response.adoc[]
include::{snippets}/issuefy/subscriptions/delete/http-response.adoc[]

=== 2.4 리포지토리 즐겨찾기

Expand Down Expand Up @@ -107,8 +115,12 @@ include::{snippets}/issuefy/issues/get/http-request.adoc[]

include::{snippets}/issuefy/issues/get/path-parameters.adoc[]

===== 쿼리 매개변수

include::{snippets}/issuefy/issues/get/query-parameters.adoc[]

==== HTTP 응답
// TODO: 이슈 응답 수정

include::{snippets}/issuefy/issues/get/http-response.adoc[]

===== 응답 본문
Expand All @@ -117,29 +129,26 @@ include::{snippets}/issuefy/issues/get/response-body.adoc[]

== 4. Server-Sent Events (SSE)

=== 4.1 SSE 연결
=== 4.1 SSE 연결 및 수신

==== HTTP 요청

include::{snippets}/issuefy/sse/connect/http-request.adoc[]

==== HTTP 응답

include::{snippets}/issuefy/sse/connect/http-response.adoc[]
[source,text]
----
event:initial
data:"connected successfully."
id:123456

=== 4.2 SSE 수신
event:info
data:{"unreadCount":0}

==== HTTP 요청

include::{snippets}/issuefy/sse/receive/http-request.adoc[]

===== 요청 필드

include::{snippets}/issuefy/sse/receive/request-fields.adoc[]

==== HTTP 응답

include::{snippets}/issuefy/sse/receive/http-response.adoc[]
event:info
data:{"unreadCount":1}
----

== 5. 알림

Expand Down Expand Up @@ -214,3 +223,29 @@ include::{snippets}/issuefy/user/update-email/request-fields.adoc[]
==== HTTP 응답

include::{snippets}/issuefy/user/update-email/http-response.adoc[]

== 7. 대시보드

=== 7.1 대시보드 정보 조회

==== HTTP 요청

include::{snippets}/dashboard/http-request.adoc[]

==== HTTP 응답

include::{snippets}/dashboard/http-response.adoc[]

===== 응답 필드

include::{snippets}/dashboard/response-fields.adoc[]

== 8. 서버 상태 확인

=== HTTP 요청

include::{snippets}/health-check/http-request.adoc[]

=== HTTP 응답

include::{snippets}/health-check/http-response.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class PagedRepositoryIssuesResponse {
private int currentPage;
Expand Down
Loading
Loading