Skip to content

Commit 09bbade

Browse files
ahastudioahastudio
authored
OpenAPI 스펙 텍스트 수정 (#9)
OpenAPI 스펙 문서에 빠져있는 설명을 추가하고, 예제와 설명이 뒤섞인 것 구분.
1 parent 6ad2b03 commit 09bbade

File tree

1 file changed

+40
-46
lines changed

1 file changed

+40
-46
lines changed

‎tickets/openapi.yaml‎

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
title: My Project
3+
title: Tickets API
44
description: ""
55
version: 1.0.0
66
tags:
@@ -16,7 +16,7 @@ paths:
1616
parameters: []
1717
responses:
1818
"200":
19-
description: ""
19+
description: 성공
2020
content:
2121
application/json:
2222
schema:
@@ -28,7 +28,10 @@ paths:
2828
title: First Ticket
2929
description: This is the first ticket.
3030
status: open
31-
comments: []
31+
comments:
32+
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
33+
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
34+
content: This is the first comment.
3235
- id: 01JQA8YHSK6NSD1QEEJPES8592
3336
title: Slow load
3437
description: Page takes long.
@@ -39,14 +42,6 @@ paths:
3942
description: Click does nothing.
4043
status: open
4144
comments: []
42-
- id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
43-
title: 새로운 티켓
44-
description: 티켓을 하나 추가하려고 합니다.
45-
status: open
46-
comments:
47-
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
48-
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
49-
content: 첫 댓글의 주인공이 되세요!
5045
headers: {}
5146
security: []
5247
post:
@@ -64,28 +59,28 @@ paths:
6459
properties:
6560
title:
6661
type: string
67-
description: 새로운 티켓
62+
description: 제목
6863
description:
6964
type: string
70-
description: 티켓을 하나 추가하려고 합니다
65+
description: 본문
7166
required:
7267
- title
7368
- description
7469
example:
75-
title: 새로운 티켓
76-
description: 티켓 하나를 추가하려고 합니다.
70+
title: New Ticket
71+
description: This is a new ticket.
7772
responses:
7873
"200":
79-
description: ""
74+
description: 티켓 생성 성공
8075
content:
8176
application/json:
8277
schema:
8378
type: object
8479
properties: {}
8580
example:
8681
id: 01JQX1FTS2KJFQRFEWVEM83QH2
87-
title: 새로운 티켓
88-
description: 티켓 하나를 추가하려고 합니다.
82+
title: New Ticket
83+
description: This is a new ticket.
8984
status: open
9085
comments: []
9186
headers: {}
@@ -100,23 +95,23 @@ paths:
10095
parameters:
10196
- name: id
10297
in: path
103-
description: ""
98+
description: 티켓 ID
10499
required: true
105100
example: 01JQA8YHB2WQ5GTDWDKWK744B9
106101
schema:
107102
type: string
108103
responses:
109104
"200":
110-
description: ""
105+
description: 성공
111106
content:
112107
application/json:
113108
schema:
114109
type: object
115110
properties: {}
116111
example:
117112
id: 01JQA8YHB2WQ5GTDWDKWK744B9
118-
title: First Ticket
119-
description: This is the first ticket.
113+
title: Some Ticket
114+
description: This is a ticket.
120115
status: open
121116
comments: []
122117
headers: {}
@@ -130,7 +125,7 @@ paths:
130125
parameters:
131126
- name: id
132127
in: path
133-
description: ""
128+
description: 티켓 ID
134129
required: true
135130
example: 01JQA8YHB2WQ5GTDWDKWK744B9
136131
schema:
@@ -143,23 +138,23 @@ paths:
143138
properties:
144139
status:
145140
type: string
146-
description: closed
141+
description: 티켓 상태
147142
required:
148143
- status
149144
example:
150145
status: closed
151146
responses:
152147
"200":
153-
description: ""
148+
description: 티켓 수정 성공
154149
content:
155150
application/json:
156151
schema:
157152
type: object
158153
properties: {}
159154
example:
160155
id: 01JQA8YHB2WQ5GTDWDKWK744B9
161-
title: First Ticket
162-
description: This is the first ticket.
156+
title: Some Ticket
157+
description: This is a ticket.
163158
status: closed
164159
comments: []
165160
headers: {}
@@ -173,28 +168,28 @@ paths:
173168
parameters:
174169
- name: id
175170
in: path
176-
description: ""
171+
description: 티켓 ID
177172
required: true
178173
example: 01JQX1FTS2KJFQRFEWVEM83QH2
179174
schema:
180175
type: string
181176
responses:
182177
"200":
183-
description: ""
178+
description: 티켓 삭제 성공
184179
content:
185180
application/json:
186181
schema:
187182
type: object
188183
properties: {}
189184
example:
190185
id: 01JQX1FTS2KJFQRFEWVEM83QH2
191-
title: 새로운 티켓
192-
description: 티켓 하나를 추가하려고 합니다.
186+
title: Some Ticket
187+
description: This is a ticket.
193188
status: closed
194189
comments: []
195190
headers: {}
196191
"404":
197-
description: ""
192+
description: 티켓을 찾을 수 없음
198193
content:
199194
application/json:
200195
schema:
@@ -216,14 +211,14 @@ paths:
216211
parameters:
217212
- name: ticketId
218213
in: path
219-
description: ""
214+
description: 티켓 ID
220215
required: true
221216
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
222217
schema:
223218
type: string
224219
responses:
225220
"200":
226-
description: ""
221+
description: 성공
227222
content:
228223
application/json:
229224
schema:
@@ -232,7 +227,7 @@ paths:
232227
example:
233228
- id: 01JQFRVCZ36PC7C3CDYWGGGVH2
234229
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
235-
content: 첫 댓글의 주인공이 되세요!
230+
content: This is the first comment.
236231
headers: {}
237232
security: []
238233
post:
@@ -244,7 +239,7 @@ paths:
244239
parameters:
245240
- name: ticketId
246241
in: path
247-
description: ""
242+
description: 티켓 ID
248243
required: true
249244
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
250245
schema:
@@ -257,14 +252,14 @@ paths:
257252
properties:
258253
content:
259254
type: string
260-
description: 첫 댓글의 주인공이 되세요
255+
description: 댓글 본문
261256
required:
262257
- content
263258
example:
264-
content: 첫 댓글의 주인공이 되세요!
259+
content: This is the first comment.
265260
responses:
266261
"200":
267-
description: ""
262+
description: 댓글 생성 성공
268263
content:
269264
application/json:
270265
schema:
@@ -273,35 +268,34 @@ paths:
273268
example:
274269
id: 01JQX26V9XH60Y98S7Z1J87EYR
275270
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
276-
content: 첫 댓글의 주인공이 되세요!
271+
content: This is the first comment.
277272
headers: {}
278273
security: []
279274
/tickets/{ticketId}/comments/{id}:
280275
delete:
281276
summary: DELETE /tickets/:ticketId/comments/:id
282277
deprecated: false
283-
description: |
284-
댓글 삭제
278+
description: 댓글 삭제
285279
tags:
286280
- tickets api
287281
parameters:
288282
- name: ticketId
289283
in: path
290-
description: ""
284+
description: 티켓 ID
291285
required: true
292286
example: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
293287
schema:
294288
type: string
295289
- name: id
296290
in: path
297-
description: ""
291+
description: 댓글 ID
298292
required: true
299293
example: 01JQX26V9XH60Y98S7Z1J87EYR
300294
schema:
301295
type: string
302296
responses:
303297
"200":
304-
description: ""
298+
description: 댓글 삭제 성공
305299
content:
306300
application/json:
307301
schema:
@@ -310,7 +304,7 @@ paths:
310304
example:
311305
id: 01JQX26V9XH60Y98S7Z1J87EYR
312306
ticket_id: 01JQFRSC1ZD0BD7J7CFC4Y4KXP
313-
content: 첫 댓글의 주인공이 되세요!
307+
content: This is the first comment.
314308
headers: {}
315309
security: []
316310
components:

0 commit comments

Comments
 (0)