Skip to content

Commit df2285a

Browse files
committed
Merge branch 'feat/#377' into develop
2 parents b5af12b + 8bee275 commit df2285a

File tree

1 file changed

+36
-17
lines changed

1 file changed

+36
-17
lines changed

src/notifications/routes/notification.route.ts

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,25 @@ router.get('/me', authenticateJwt, getNotificationList); // 알림 목록 조회
7171
* description: |
7272
* - 커서 기반 페이지네이션(cursor-based-pagination) 사용.
7373
* - `cursor`는 이전 요청에서 받은 마지막 데이터의 ID를 의미하며, 이를 기준으로 이후 데이터를 조회.
74+
*
7475
* - 첫 요청 시에는 `cursor`를 생략하여 최신 데이터부터 조회.
76+
*
7577
* - `has_more` 속성으로 더 불러올 데이터가 있는지 미리 확인 가능.
7678
*
7779
* - type 종류:
78-
* - FOLLOW: 누가 나를 팔로우 했을 때
79-
* - NEW_PROMPT: 알림 설정한 프롬프터가 새 프롬프트를 올렸을 때
80-
* - INQUIRY: 나에게 문의사항이 도착했을 때
81-
* - ANNOUNCEMENT: 공지사항이 등록되었을 때
82-
* - REPORT: 내 신고가 접수되었을 때
80+
* - `FOLLOW`: 누가 나를 팔로우 했을 때
81+
*
82+
* - `NEW_PROMPT`: 알림 설정한 프롬프터가 새 프롬프트를 올렸을 때
83+
*
84+
* - `INQUIRY`: 나에게 문의사항이 도착했을 때
85+
*
86+
* - `ANNOUNCEMENT`: 공지사항이 등록되었을 때
8387
*
84-
* - actor 필드는 알림을 유발한 사용자를 뜻하며, 타입이 REPORT, ANNOUNCEMENT일 때에만 null입니다.
85-
* - profile_image 필드는 타입이 FOLLOW, NEW_PROMPT일 경우에만 반환됩니다.
88+
* - `REPORT`: 내 신고가 접수되었을 때
89+
*
90+
* - `ADMIN_MESSAGE`: 관리자 메시지가 도착했을 때
91+
*
92+
* - `actor` 필드는 알림을 유발한 사용자를 뜻하며, 타입이 `REPORT`, `ANNOUNCEMENT`일 때에는 null입니다.
8693
8794
* tags: [Notifications]
8895
* security:
@@ -117,28 +124,31 @@ router.get('/me', authenticateJwt, getNotificationList); // 알림 목록 조회
117124
* has_more: false
118125
* notifications:
119126
* - notification_id: 600
120-
* content: 신고가 접수되었습니다.
127+
* content: "신고가 접수되었습니다."
121128
* type: REPORT
122129
* created_at: "2025-10-26T16:58:29.743Z"
123130
* link_url: null
124131
* actor: null
125132
* - notification_id: 599
126-
* content: 신고가 접수되었습니다.
127-
* type: REPORT
133+
* content: "`홍길동`님이 새 프롬프트를 업로드하셨습니다."
134+
* type: NEW_PROMPT
128135
* created_at: "2025-10-26T16:57:04.162Z"
129-
* link_url: null
130-
* actor: null
136+
* link_url: /profile/10
137+
* actor:
138+
* user_id: 10
139+
* nickname: "홍길동"
140+
* profile_image: "https://promptplace-s3.s3.ap-northeast-2.amazonaws.com/profile-images/1a2b3c4d-5678-90ab-cdef-1234567890ab_1755892991870.png"
131141
* - notification_id: 598
132-
* content: 신고가 접수되었습니다.
133-
* type: REPORT
142+
* content: "새로운 공지사항이 등록되었습니다."
143+
* type: ANNOUNCEMENT
134144
* created_at: "2025-10-26T13:38:26.906Z"
135145
* link_url: null
136146
* actor: null
137147
* - notification_id: 489
138-
* content: "‘또도도잉’님이 회원님을 팔로우합니다."
139-
* type: FOLLOW
148+
* content: "프롬프트에 새로운 문의가 도착했습니다."
149+
* type: INQUIRY
140150
* created_at: "2025-08-21T12:26:45.288Z"
141-
* link_url: "/profile/33"
151+
* link_url: "/inquiries/2"
142152
* actor:
143153
* user_id: 33
144154
* nickname: "또도도잉"
@@ -152,6 +162,15 @@ router.get('/me', authenticateJwt, getNotificationList); // 알림 목록 조회
152162
* user_id: 33
153163
* nickname: "또도도잉"
154164
* profile_image: "https://promptplace-s3.s3.ap-northeast-2.amazonaws.com/profile-images/3b137096-7915-408d-ad94-b70e5aa53107_1755892991870.png"
165+
* - notification_id: 487
166+
* content: "안녕하세요. 프롬프트 플레이스 관리자입니다. 회원님의 원활한 서비스 이용을 위해 공지사항을 확인해주세요."
167+
* type: ADMIN_MESSAGE
168+
* created_at: "2025-08-21T12:26:42.522Z"
169+
* link_url: null
170+
* actor:
171+
* user_id: 45
172+
* nickname: "관리자"
173+
* profile_image: "https://promptplace-s3.s3.ap-northeast-2.amazonaws.com/profile-images/3b137096-7915-408d-ad94-b70e5aa53107_1755892991870.png"
155174
* statusCode: 200
156175
* 401:
157176
* description: 인증 실패

0 commit comments

Comments
 (0)