forked from microsoft/github-copilot-vibe-coding-workshop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
334 lines (334 loc) · 7.85 KB
/
openapi.yaml
File metadata and controls
334 lines (334 loc) · 7.85 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
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
openapi: 3.1.0
info:
title: Simple Social Media Application API
version: 1.0.0
description: API for a basic social networking service with posts, comments, and likes.
servers:
- url: http://localhost:8080/api
paths:
/posts:
get:
summary: List all posts
responses:
'200':
description: List of posts
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
'500':
$ref: '#/components/responses/Error'
post:
summary: Create a new post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostCreate'
responses:
'201':
description: Post created
content:
application/json:
schema:
$ref: '#/components/schemas/Post'
'400':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/posts/{postId}:
parameters:
- name: postId
in: path
required: true
schema:
type: string
get:
summary: Get a single post
responses:
'200':
description: Post details
content:
application/json:
schema:
$ref: '#/components/schemas/Post'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
patch:
summary: Update a post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostUpdate'
responses:
'200':
description: Post updated
content:
application/json:
schema:
$ref: '#/components/schemas/Post'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
delete:
summary: Delete a post
responses:
'204':
description: Post deleted
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/posts/{postId}/comments:
parameters:
- name: postId
in: path
required: true
schema:
type: string
get:
summary: List comments for a post
responses:
'200':
description: List of comments
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
post:
summary: Create a comment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CommentCreate'
responses:
'201':
description: Comment created
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/posts/{postId}/comments/{commentId}:
parameters:
- name: postId
in: path
required: true
schema:
type: string
- name: commentId
in: path
required: true
schema:
type: string
get:
summary: Get a specific comment
responses:
'200':
description: Comment details
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
patch:
summary: Update a comment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CommentUpdate'
responses:
'200':
description: Comment updated
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
delete:
summary: Delete a comment
responses:
'204':
description: Comment deleted
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
/posts/{postId}/likes:
parameters:
- name: postId
in: path
required: true
schema:
type: string
post:
summary: Like a post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LikeCreate'
responses:
'201':
description: Like added
'400':
$ref: '#/components/responses/Error'
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
delete:
summary: Unlike a post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LikeDelete'
responses:
'204':
description: Like removed
'404':
$ref: '#/components/responses/Error'
'500':
$ref: '#/components/responses/Error'
components:
schemas:
Post:
type: object
properties:
id:
type: string
username:
type: string
content:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
likes:
type: integer
comments:
type: integer
PostCreate:
type: object
required:
- username
- content
properties:
username:
type: string
content:
type: string
PostUpdate:
type: object
required:
- username
- content
properties:
username:
type: string
content:
type: string
Comment:
type: object
properties:
id:
type: string
postId:
type: string
username:
type: string
content:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
CommentCreate:
type: object
required:
- username
- content
properties:
username:
type: string
content:
type: string
CommentUpdate:
type: object
required:
- username
- content
properties:
username:
type: string
content:
type: string
LikeCreate:
type: object
required:
- username
properties:
username:
type: string
LikeDelete:
type: object
required:
- username
properties:
username:
type: string
Error:
type: object
properties:
message:
type: string
code:
type: integer
responses:
Error:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'