/
briefkasten.openapi.yaml
481 lines (481 loc) · 11.3 KB
/
briefkasten.openapi.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
openapi: 3.1.0
info:
title: Reference
description: API Docs for Briefkasten
version: 0.1.9
content:
email: info@briefkastenhq.com
url: "https://docs.briefkastenhq.com"
servers:
- url: https://briefkastenhq.com/api
description: Production
- url: http://localhost:3000/api
description: Local Dev
paths:
"/bookmarks":
get:
summary: Search for bookmarks
parameters:
- name: query
in: query
description: Search query string
required: true
schema:
type: string
example: "Tech blogs"
format: string
responses:
"200":
description: Successful
content:
application/json:
schema:
description: List of bookmark results
type: array
items:
$ref: "#/components/bookmark"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
post:
summary: Create bookmarks
requestBody:
description: The bookmark to create
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/bookmark"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/bookmark"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
put:
summary: Update bookmarks
parameters:
- schema:
type: string
description: Query
name: query
in: query
requestBody:
description: The bookmark to update
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/bookmark"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/bookmark"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
delete:
summary: Delete bookmarks
requestBody:
description: Bookmark ID to delete
required: true
content:
application/json:
schema:
type: object
required:
- title
- url
properties:
id:
type: string
format: cuid
example: cjld2cjxh0000qzrmn831i7rn
responses:
"204":
description: No Content
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
"/tags":
get:
summary: Search for tags
parameters:
- schema:
type: string
description: Query
name: query
in: query
responses:
"200":
description: Successful
content:
application/json:
schema:
description: List of tag results
type: array
items:
$ref: "#/components/tag"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
post:
summary: Create tag
parameters:
- schema:
type: string
description: Query
name: query
in: query
requestBody:
description: The tag to create
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/tag"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/tag"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
put:
summary: Update tag
parameters:
- schema:
type: string
description: Query
name: query
in: query
requestBody:
description: The tag to update
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/tag"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/tag"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
delete:
summary: Delete tag
requestBody:
description: Tag ID to delete
required: true
content:
application/json:
schema:
type: object
required:
- title
- url
properties:
id:
type: string
format: cuid
example: cjld2cjxh0000qzrmn831i7rn
responses:
"204":
description: No Content
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
"/categories":
get:
summary: Search for categories
parameters:
- schema:
type: string
description: Query
name: query
in: query
responses:
"200":
description: Successful
content:
application/json:
schema:
description: List of categories results
type: array
items:
$ref: "#/components/category"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
post:
summary: Create categories
parameters:
- schema:
type: string
description: Query
name: query
in: query
requestBody:
description: The category to create
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/category"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/category"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
put:
summary: Update categories
parameters:
- schema:
type: string
description: Query
name: query
in: query
requestBody:
description: The category to update
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/category"
responses:
"200":
description: Successful
content:
application/json:
schema:
$ref: "#/components/category"
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
delete:
summary: Delete categories
requestBody:
description: Category ID to delete
required: true
content:
application/json:
schema:
type: object
required:
- title
- url
properties:
id:
type: string
format: cuid
example: cjld2cjxh0000qzrmn831i7rn
responses:
"204":
description: No Content
"401":
description: Unauthorized
"403":
description: Forbidden
"429":
description: Too Many Requests
components:
securitySchemes:
ApiKeyAuth: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-API-KEY # name of the header, query parameter or cookie
bookmark:
type: object
required:
- title
- url
properties:
id:
type: string
format: cuid
example: cjld2cjxh0000qzrmn831i7rn
userId:
type: string
format: cuid
description: Linked user id
example: cjld2cyuq0000t3rmniod1foy
title:
type: string
description: Page or link title
example: "Tech Blog"
url:
type: string
description: Link to the bookmark
example: https://engadget.com
category?:
type: string
description: Category grouping for your bookmark
desc?:
type: string
description: Description of the bookmark
tags?:
type: array
items:
$ref: "#/components/tag"
tag:
type: object
required:
- name
properties:
id:
type: string
format: cuid
example: tz4a98xxat96iws9zmbrgj3a
userId:
type: string
format: cuid
example: q6jy42jq92xypbao731oj7x8
name:
type: string
category:
type: object
required:
- name
properties:
id:
type: string
format: cuid
example: pfh0haxfpzowht3oi213cqos
userId:
type: string
format: cuid
example: nc6bzmkmd014706rfda898to
name:
type: string
description: Name of your category
description:
type: string
description: Description for the category
NotFoundError:
type: object
properties:
statusCode:
type: number
enum:
- 404
error:
type: string
enum:
- Not Found
message:
type: string
example: Not Found
required:
- statusCode
- error
ForbiddenError:
type: object
properties:
statusCode:
type: number
enum:
- 403
error:
type: string
enum:
- Forbidden
message:
type: string
example: Forbidden
required:
- statusCode
- error
TooManyRequestsError:
type: object
properties:
statusCode:
type: number
enum:
- 429
error:
type: string
enum:
- Too Many Requests
message:
type: string
example: Too Many Requests
required:
- statusCode
- error
UnauthorizedError:
type: object
properties:
statusCode:
type: number
enum:
- 401
error:
type: string
enum:
- Unauthorized
message:
type: string
example: Bad Token
required:
- statusCode
- error
security:
- ApiKeyAuth: []