-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAPI_SPEC.yaml
More file actions
251 lines (251 loc) · 7.14 KB
/
Copy pathAPI_SPEC.yaml
File metadata and controls
251 lines (251 loc) · 7.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
openapi: 3.0.1
info:
title: Default module
description: ''
version: 1.0.0
tags: []
paths:
/alarm:
get:
summary: alarmList
deprecated: false
description: 인증된 사용자 자신에게 온 알람 목록을 id 내림차순으로 조회
tags: []
parameters:
- name: Authorization
in: header
description: ''
required: true
example: Bearer {{access_token}}
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: array
items:
$ref: '#/components/schemas/alarmResponse'
example:
message: get alarms
data:
- id: 2
matchingId: 3
description: xxx님이 매칭 요청을 보냈습니다
isRead: false
- id: 1
matchingId: 2
description: ooo님이 매칭 요청을 보냈습니다
isRead: false
headers: {}
'403':
description: 인증 실패 (Authorization 헤더 누락 또는 유효하지 않은 토큰). 응답 바디 없음.
'500':
description: 처리되지 않은 서버 내부 오류
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: '[ERROR: ?/?] 서버 내부 오류가 발생했습니다.'
data: null
security: []
/alarm/{matching_id}:
post:
summary: alarmCreate
deprecated: false
description: ''
tags: []
parameters:
- name: matching_id
in: path
description: ''
required: true
schema:
type: integer
format: int64
- name: Authorization
in: header
description: ''
required: true
example: Bearer {{access_token}}
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
required:
- description
example:
description: ooo님이 매칭 요청을 보냈습니다
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: create alarm
data: null
headers: {}
'400':
description: 요청 바디 검증 실패 (description 누락 또는 공백)
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: '[ERROR: Request/BadRequest] description 공백일 수 없습니다'
data: null
'403':
description: 인증 실패 (Authorization 헤더 누락 또는 유효하지 않은 토큰). 응답 바디 없음.
'500':
description: 처리되지 않은 서버 내부 오류
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: '[ERROR: ?/?] 서버 내부 오류가 발생했습니다.'
data: null
'502':
description: 매칭 서비스 내부 API 조회 실패
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: '[ERROR: Alarm/MatchingClient] 매칭 정보를 조회할 수 없습니다.'
data: null
security: []
/alarm/{alarm_id}:
patch:
summary: alarmReadUpdate
deprecated: false
description: 인증된 사용자 자신에게 온 알람 하나를 알람 id로 읽음 처리. 대상 알람이 없거나 본인 알람이 아니면 변경 없이 200 반환.
tags: []
parameters:
- name: alarm_id
in: path
description: ''
required: true
schema:
type: integer
format: int64
- name: Authorization
in: header
description: ''
required: true
example: Bearer {{access_token}}
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: update alarm read
data: null
headers: {}
'403':
description: 인증 실패 (Authorization 헤더 누락 또는 유효하지 않은 토큰). 응답 바디 없음.
'500':
description: 처리되지 않은 서버 내부 오류
content:
application/json:
schema:
type: object
properties:
message:
type: string
data:
type: object
nullable: true
example:
message: '[ERROR: ?/?] 서버 내부 오류가 발생했습니다.'
data: null
security: []
components:
schemas:
alarmCreateRequest:
type: object
properties:
description:
type: string
required:
- description
alarmResponse:
type: object
properties:
id:
type: integer
format: int64
matchingId:
type: integer
format: int64
description:
type: string
isRead:
type: boolean
required:
- id
- matchingId
- description
- isRead
responses: {}
securitySchemes: {}
servers: []
security: []