-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-spec.yaml
314 lines (312 loc) · 10.1 KB
/
api-spec.yaml
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
openapi: 3.0.3
info:
title: Articles API
description: "API for managing articles, allowing creation, retrieval, updating, deletion, and searching of articles."
version: 1.0.0
servers:
- url: http://localhost:8000
tags:
- name: ArticleController
paths:
/articles:
get:
tags:
- ArticleController
description: Retrieve a list of article names
operationId: getArticleNames
parameters:
- name: author
in: query
required: false
schema:
type: string
example: "Christopher Nolan"
- name: tag
in: query
required: false
schema:
type: string
example: "blockbuster"
- name: date
in: query
required: false
schema:
type: string
format: date
example: "2024-01-01"
responses:
'200':
description: List of article names
content:
application/json:
schema:
type: array
items:
type: string
example: ["The Art of Storytelling in 'Inception'", "Directing Masterpieces: The Nolan Method", "Revolutionizing Cinema: The Impact of 'Interstellar'"]
'400':
description: Invalid query parameters
post:
tags:
- ArticleController
description: Create a new article
operationId: createArticle
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ArticleCreate'
example:
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
responses:
'201':
description: Article created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
example:
id: "12345"
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T03:54:00Z"
'400':
description: Invalid input
/articles/{id}:
get:
tags:
- ArticleController
description: Retrieve a specific article by its ID
operationId: getArticleById
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "12345"
responses:
'200':
description: Article details
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
example:
id: "12345"
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T03:54:00Z"
'404':
description: Article not found
put:
tags:
- ArticleController
description: Update an article by its ID
operationId: updateArticle
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "12345"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ArticleUpdate'
example:
title: "The Evolution of Special Effects in Sci-Fi (Updated)"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life. This update explores the latest technologies..."
tags: ["special effects", "sci-fi", "technology"]
responses:
'200':
description: Article updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
example:
id: "12345"
title: "The Evolution of Special Effects in Sci-Fi (Updated)"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life. This update explores the latest technologies..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi", "technology"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T04:00:00Z"
'400':
description: Invalid input
'404':
description: Article not found
'401':
description: Unauthorized (requires auth controller)
delete:
tags:
- ArticleController
description: Delete an article by its ID
operationId: deleteArticle
parameters:
- name: id
in: path
required: true
schema:
type: string
example: "12345"
responses:
'200':
description: Article deleted successfully
'404':
description: Article not found
'401':
description: Unauthorized (requires auth controller)
/articles/search:
get:
tags:
- ArticleController
description: Search articles based on a query
operationId: searchArticles
parameters:
- name: query
in: query
required: true
schema:
type: string
example: "cinematography in Blade Runner"
responses:
'200':
description: List of articles matching the search query
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Article'
example:
- id: "12345"
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T03:54:00Z"
'400':
description: Invalid query parameters
/articles/popular:
get:
tags:
- ArticleController
description: Retrieve popular articles
operationId: getPopularArticles
parameters:
- name: date
in: query
required: false
schema:
type: string
format: date
example: "2024-01-01"
- name: tag
in: query
required: false
schema:
type: string
example: "blockbuster"
responses:
'200':
description: List of popular articles
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Article'
example:
- id: "12345"
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T03:54:00Z"
'400':
description: Invalid query parameters
components:
schemas:
Article:
type: object
properties:
id:
type: string
title:
type: string
content:
type: string
author:
type: string
tags:
type: array
items:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
example:
id: "12345"
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
createdAt: "2024-01-01T03:54:00Z"
updatedAt: "2024-01-01T03:54:00Z"
ArticleCreate:
type: object
required:
- title
- content
- author
properties:
title:
type: string
content:
type: string
author:
type: string
tags:
type: array
items:
type: string
example:
title: "The Evolution of Special Effects in Sci-Fi"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life..."
author: "Ridley Scott"
tags: ["special effects", "sci-fi"]
ArticleUpdate:
type: object
properties:
title:
type: string
content:
type: string
tags:
type: array
items:
type: string
example:
title: "The Evolution of Special Effects in Sci-Fi (Updated)"
content: "Special effects have transformed the way we experience movies, with advancements bringing unimaginable worlds to life. This update explores the latest technologies..."
tags: ["special effects", "sci-fi", "technology"]