forked from techmastery-io/project-everest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.yaml
341 lines (326 loc) · 8.42 KB
/
api.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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
openapi: 3.0.0
info:
title: Content Management API
description: API for managing content and content types.
version: 1.0.0
servers:
- url: https://api.everest.com/v1
paths:
/content-types:
get:
summary: List all Content Types
responses:
"200":
description: A list of content types
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
example: "my-content-type"
post:
summary: Create a new Content Type
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "Blog Post"
schema:
type: object
responses:
"201":
description: Content Type created successfully
"400":
description: Bad Request
"422":
description: "Unprocessable Entity"
"500":
description: Internal Server Error
/content-types/{id}:
put:
summary: Update a Content Type
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "Updated Content Type Name"
responses:
"200":
description: Content Type updated successfully
"404":
description: Content Type not found
"400":
description: Bad Request
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
delete:
summary: Delete a Content Type
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"204":
description: Content Type deleted successfully
"500":
description: Internal Server Error
/contents:
get:
summary: List all Contents
responses:
"200":
description: A list of content items
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
slug:
type: string
is_published:
type: boolean
type_id:
type: string
data:
type: object
post:
summary: Create new Content
requestBody:
content:
application/json:
schema:
type: object
properties:
type_id:
type: string
slug:
type: string
example: "beverage"
data:
type: object
responses:
"201":
description: Content created successfully
"500":
description: Internal Server Error
/contents/{id}:
put:
summary: Update Content
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
slug:
type: string
example: "food"
data:
type: object
properties:
title:
type: string
example: "Chocolate Cake"
subtitle:
type: string
example: "What makes it the best cake flavour?"
body:
type: string
example: "Lorem Ipsum"
responses:
"200":
description: Content updated successfully
"404":
description: Content not found
"400":
description: Bad Request
"422":
description: Unprocessable Entity
"500":
description: Internal Server Error
delete:
summary: Delete Content
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"204":
description: Content deleted successfully
"500":
description: Internal Server Error
/folders:
post:
summary: Create new Folder
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "New Folder"
responses:
"201":
description: Folder created successfully
"500":
description: Internal Server Error
/folders/{id}:
put:
summary: Update an existing Folder
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: "Updated Folder"
responses:
"200":
description: Folder updated successfully
"400":
description: Bad Request
"404":
description: Folder not found
"422":
description: Unprocessable Entity
delete:
summary: Delete an existing Folder
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"204":
description: Folder deleted successfully
"500":
description: Internal Server Error
/client-api/content/{id}:
get:
summary: Fetch content by ID or key
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Content retrieved successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
slug:
type: string
is_published:
type: boolean
type_id:
type: string
data:
type: object
properties:
title:
type: string
subtitle:
type: string
body:
type: string
author:
type: string
/client-api/folders/{folderId}/contents:
get:
summary: List all content in a folder
parameters:
- name: folderId
in: path
required: true
schema:
type: string
responses:
"200":
description: A list of content items in the folder
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
/client-api/content-type/{typeId}/contents:
get:
summary: List all content by type
parameters:
- name: typeId
in: path
required: true
schema:
type: string
responses:
"200":
description: A list of content items of the specified type
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string