Skip to content

Commit 277a7b7

Browse files
authored
[#60] ✨ 백엔드 업데이트에 따른 타입 추가 (#191)
* [#60] ✨ update openapi type * [#60] ✨ upadte signup request interface * [#60] ✨ add community comment related interfaces
1 parent 1ec9138 commit 277a7b7

File tree

3 files changed

+111
-3
lines changed

3 files changed

+111
-3
lines changed

src/types/api/ApiSchema.types.d.ts

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,26 @@ export interface paths {
285285
patch?: never
286286
trace?: never
287287
}
288+
'/community/{communityId}/comments': {
289+
parameters: {
290+
query?: never
291+
header?: never
292+
path?: never
293+
cookie?: never
294+
}
295+
get?: never
296+
put?: never
297+
/**
298+
* 커뮤니티 댓글 등록
299+
* @description 커뮤니티에 댓글 작성하는 api입니다.작성자만 해당 기능을 사용할 수 있습니다. 최상위 댓글의 경우 parentId를 null로 보내주세요!
300+
*/
301+
post: operations['createComment']
302+
delete?: never
303+
options?: never
304+
head?: never
305+
patch?: never
306+
trace?: never
307+
}
288308
'/access': {
289309
parameters: {
290310
query?: never
@@ -1383,7 +1403,7 @@ export interface components {
13831403
* @description 깃허브
13841404
* @example bboggo
13851405
*/
1386-
gitHub: string
1406+
gitHub?: string
13871407
}
13881408
ApiResponseSignUpResponse: {
13891409
isSuccess?: boolean
@@ -1510,6 +1530,53 @@ export interface components {
15101530
message?: string
15111531
result?: string
15121532
}
1533+
CommunityCommentRequest: {
1534+
/**
1535+
* @description 댓글 내용
1536+
* @example 댓글입니다
1537+
*/
1538+
content: string
1539+
/**
1540+
* Format: int64
1541+
* @description 부모 댓글 ID (최상위 댓글이면 null)
1542+
*/
1543+
parentId?: number
1544+
}
1545+
ApiResponseCommunityCommentResponse: {
1546+
isSuccess?: boolean
1547+
code?: string
1548+
message?: string
1549+
result?: components['schemas']['CommunityCommentResponse']
1550+
}
1551+
CommunityCommentResponse: {
1552+
/**
1553+
* Format: int64
1554+
* @description 댓글 ID
1555+
* @example 1
1556+
*/
1557+
commentId?: number
1558+
/**
1559+
* Format: int64
1560+
* @description 부모 댓글 ID (없을 경우 null)
1561+
*/
1562+
parentCommentId?: number
1563+
/**
1564+
* @description 댓글 내용
1565+
* @example 댓글입니다
1566+
*/
1567+
content?: string
1568+
/**
1569+
* Format: int64
1570+
* @description 작성자 ID
1571+
* @example 1
1572+
*/
1573+
writer?: number
1574+
/**
1575+
* Format: date-time
1576+
* @description 작성일시
1577+
*/
1578+
createdAt?: string
1579+
}
15131580
TeamUpdateRequest: {
15141581
/**
15151582
* @description 팀 제목
@@ -2747,6 +2814,32 @@ export interface operations {
27472814
}
27482815
}
27492816
}
2817+
createComment: {
2818+
parameters: {
2819+
query?: never
2820+
header?: never
2821+
path: {
2822+
communityId: number
2823+
}
2824+
cookie?: never
2825+
}
2826+
requestBody: {
2827+
content: {
2828+
'application/json': components['schemas']['CommunityCommentRequest']
2829+
}
2830+
}
2831+
responses: {
2832+
/** @description OK */
2833+
200: {
2834+
headers: {
2835+
[name: string]: unknown
2836+
}
2837+
content: {
2838+
'*/*': components['schemas']['ApiResponseCommunityCommentResponse']
2839+
}
2840+
}
2841+
}
2842+
}
27502843
createAccessToken: {
27512844
parameters: {
27522845
query: {

src/types/api/Auth.types.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ export interface SignUpRequest {
1212
email: Email // 이메일
1313
password: Password // 비밀번호
1414
name: Name // 사용자 이름
15-
gitHub: GitHub // GitHub 계정 URL
15+
gitHub?: GitHub // GitHub 계정 URL
1616
}
1717
export interface SignUpResponse extends User {
18-
gitHub: GitHub // GitHub 계정 URL
18+
gitHub?: GitHub // GitHub 계정 URL
1919
}
2020

2121
/**

src/types/api/Community.types.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,21 @@ export type UpdateCommunityResponse = CreateCommunityResponse
6161
}
6262
*/
6363

64+
/**
65+
- path: '/v1/{communityId}/comments'
66+
- POST: 커뮤니티 댓글 등록
67+
*/
68+
export type CreateCommunityCommentRequest = {
69+
content: string
70+
parentId?: Id
71+
}
72+
export interface CreateCommunityCommentResponse extends TimeStamps {
73+
commentId: Id
74+
parentCommentId?: Id
75+
content: string
76+
writer: Id
77+
}
78+
6479
/**
6580
- path: '/v1/community/top5'
6681
- GET: 좋아요 순으로 인기 커뮤니티 Top 5 유저 조회

0 commit comments

Comments
 (0)