-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
786 lines (773 loc) · 18.7 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
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
openapi: 3.0.3
info:
title: Blog
description: Blog example
version: 1.0.0
servers:
- url: https://prod1.weos.sh/blog/dev
description: WeOS Dev
- url: https://prod1.weos.sh/blog/v1
- url: http://localhost:8681
x-weos-config:
event-source:
- title: default
driver: service
endpoint: https://prod1.weos.sh/events/v1
- title: event
driver: sqlite3
database: test.db
databases:
- title: default
driver: sqlite3
database: test.db
database:
driver: sqlite3
database: test.db
rest:
middleware:
- RequestID
- Recover
- ZapLogger
- LogLevel
components:
schemas:
Category:
type: object
properties:
title:
type: string
description:
type: string
required:
- title
x-identifier:
- title
Author:
type: object
properties:
id:
type: integer
format: uint
firstName:
type: string
lastName:
type: string
email:
type: string
format: email
required:
- firstName
- lastName
x-identifier:
- id
Blog:
type: object
properties:
url:
type: string
format: uri
x-unique: true
title:
type: string
description:
type: string
x-upload:
folder: ./files
limit: 10000
active:
type: boolean
status:
type: string
nullable: true
enum:
- "null"
- one
- two
image:
type: string
format: byte
categories:
type: array
items:
$ref: "#/components/schemas/Category"
posts:
type: array
items:
$ref: "#/components/schemas/Post"
lastUpdated:
type: string
format: date-time
x-update:
- Add Blog
- Update Blog
created:
type: string
format: date-time
x-update:
- Add Blog
required:
- title
- url
Post:
type: object
properties:
title:
type: string
description:
type: string
author:
$ref: "#/components/schemas/Author"
categories:
type: array
items:
$ref: "#/components/schemas/Category"
created:
type: string
format: date-time
paths:
/:
get:
operationId: Homepage
responses:
200:
description: Application Homepage
content:
text/html:
example: |
<html>
<head>
<title>Health</title>
</head>
<body>
This is a landing page
</body>
</html>
/page:
get:
summary: Test
parameters:
- in: header
name: Accept
schema:
type: string
responses:
'200':
description: Test Page
content:
text/html:
example: |
<html>
<head>
<title>Test Page</title>
</head>
<body>
This is a test page
</body>
</html>
schema:
type: string
application/json:
example:
blog:
value: {
"title": "API Testing",
"url": "www.example.com",
"email": "[email protected]"
}
/file:
get:
responses:
200:
description: file found
x-folder: "./controllers/rest/fixtures/staticF"
x-file: "./controllers/rest/fixtures/staticF/index"
404:
description: file not found
/health:
summary: Health Check
get:
x-controller: HealthCheck
responses:
200:
description: Health Response
500:
description: API Internal Error
/api/json:
get:
operationId: Get API Details
x-controller: APIDiscovery
responses:
200:
description: API Details
content:
application/json:
schema:
type: string
/api/html:
get:
operationId: Get API Details
x-controller: APIDiscovery
responses:
200:
description: API Details
content:
application/html:
schema:
type: string
/blogs:
post:
operationId: Add Blog
summary: Create Blog
x-middleware:
- Recover
- ZapLogger
- LogLevel
requestBody:
description: Blog info that is submitted
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/Blog"
multipart/form-data:
schema:
$ref: "#/components/schemas/Blog"
responses:
201:
description: Add Blog to Aggregator
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
get:
operationId: Get Blogs
summary: Get List of Blogs
parameters:
- in: query
name: page
schema:
type: integer
- in: query
name: l
x-alias: limit
schema:
type: integer
- in: query
name: filters
schema:
type: array
items:
type: object
properties:
field:
type: string
operator:
type: string
values:
type: array
items:
type: string
required: false
description: query string
x-context:
_filters:
- field: active
operator: eq
value: true
page: 1
limit: 10
responses:
200:
description: List of blogs
content:
application/json:
schema:
type: object
properties:
total:
type: integer
page:
type: integer
items:
type: array
items:
$ref: "#/components/schemas/Blog"
delete:
operationId: Delete Blog
parameters:
- in: query
name: id
schema:
type: string
required: true
description: blog id
requestBody:
description: Blog info that is submitted
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
responses:
200:
description: Update blog
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
400:
description: Invalid blog submitted
/blogs/{id}:
get:
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: blog id
- in: query
name: sequence_no
schema:
type: integer
- in: query
name: use_entity_id
schema:
type: boolean
required: false
summary: Get Blog by id
operationId: Get Blog
responses:
200:
description: Blog details without any supporting collections
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
304:
description: Not modified
400:
description: Item doesn't exist
put:
parameters:
- in: path
name: id
schema:
type: integer
required: true
description: blog id
- in: header
name: If-Match
schema:
type: string
required: false
summary: Update blog details
operationId: Update Blog
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/Blog"
multipart/form-data:
schema:
$ref: "#/components/schemas/Blog"
responses:
200:
description: Update Blog
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
400:
description: Request is malformed
404:
description: Item doesn't exist
412:
description: The item is stale
422:
description: Invalid content data sent
delete:
parameters:
- in: path
name: id
schema:
type: string
required: true
description: blog id
- in: header
name: If-Match
schema:
type: string
requestBody:
description: Blog info that is submitted
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/Blog"
summary: Delete blog
operationId: Delete Blog
responses:
200:
description: Blog Deleted
/posts/:
post:
operationId: Create Blog Post
summary: Create Blog Post
requestBody:
description: Post details
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Post"
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/Post"
responses:
201:
description: Post
content:
application/json:
schema:
$ref: "#/components/schemas/Post"
put:
operationId: Import Blog Posts
summary: Import Blog Posts
requestBody:
description: List of posts to import
required: true
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Post"
application/x-www-form-urlencoded:
schema:
type: array
items:
$ref: "#/components/schemas/Post"
responses:
201:
description: Post
get:
operationId: Get Posts
summary: Get a blog's list of posts
parameters:
- in: query
name: q
schema:
type: string
required: false
description: query string
responses:
200:
description: List of blog posts
content:
application/json:
schema:
type: object
properties:
total:
type: integer
page:
type: integer
items:
type: array
items:
$ref: "#/components/schemas/Post"
/posts/{id}:
get:
parameters:
- in: path
name: id
schema:
type: string
required: true
summary: Get blog post by id
responses:
200:
description: Get blog post information
content:
application/json:
schema:
$ref: "#/components/schemas/Post"
put:
parameters:
- in: path
name: id
schema:
type: string
required: true
summary: Update post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Post"
responses:
200:
description: Get blog post information
content:
application/json:
schema:
$ref: "#/components/schemas/Post"
delete:
parameters:
- in: path
name: id
schema:
type: string
required: true
summary: Delete post
responses:
200:
description: Delete post
/categories:
post:
operationId: Create Blog Category
summary: Create Blog Category
requestBody:
description: Post details
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Category"
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/Category"
responses:
201:
description: Post
content:
application/json:
schema:
$ref: "#/components/schemas/Category"
get:
operationId: Get Categories
summary: Get a blog's list of categories
parameters:
- in: query
name: q
schema:
type: string
required: false
description: query string
responses:
200:
description: List of blog categories
content:
application/json:
schema:
type: object
properties:
total:
type: integer
page:
type: integer
items:
type: array
items:
$ref: "#/components/schemas/Category"
/categories/{title}:
get:
parameters:
- in: path
name: title
schema:
type: string
required: true
- in: header
name: If-None-Match
schema:
type: string
- in: query
name: use_entity_id
schema:
type: boolean
summary: Get blog category by title
responses:
200:
description: Get blog category information
content:
application/json:
schema:
$ref: "#/components/schemas/Category"
put:
parameters:
- in: path
name: title
schema:
type: string
required: true
- in: header
name: If-Match
schema:
type: string
required: false
summary: Update category
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Category"
responses:
200:
description: Get blog category information
content:
application/json:
schema:
$ref: "#/components/schemas/Category"
delete:
parameters:
- in: path
name: title
schema:
type: string
required: true
summary: Delete category
responses:
200:
description: Delete category
/authors/:
post:
operationId: Create Blog Author
summary: Create Blog Author
requestBody:
description: Author details
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Author"
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/Author"
responses:
201:
description: Post
content:
application/json:
schema:
$ref: "#/components/schemas/Author"
get:
operationId: Get Authors
summary: Get a blog's list of authors
parameters:
- in: query
name: q
schema:
type: string
required: false
description: query string
responses:
200:
description: List of blog authors
content:
application/json:
schema:
type: object
properties:
total:
type: integer
page:
type: integer
items:
type: array
items:
$ref: "#/components/schemas/Author"
/authors/{id}:
get:
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: header
name: email
schema:
type: string
required: true
summary: Get Author by id
responses:
200:
description: Get author information
content:
application/json:
schema:
$ref: "#/components/schemas/Author"
put:
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: header
name: email
schema:
type: string
required: true
summary: Update Author details
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Author"
responses:
200:
description: Author details
content:
application/json:
schema:
$ref: "#/components/schemas/Author"
delete:
parameters:
- in: path
name: id
schema:
type: string
required: true
- in: header
name: email
schema:
type: string
required: true
summary: Delete author
responses:
200:
description: Delete author
/files:
get:
operationId: getFiles
responses:
200:
description: Files
x-folder: "./files"
post:
operationId: uploadFile
requestBody:
content:
multipart/form-data:
schema:
type: string
format: binary
x-upload:
folder: "./files"
limit: 1000
responses:
201:
description: File successfully uploaded