sinatra-swagger 0.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1483 @@
1
+ {
2
+ "title": "A JSON Schema for Swagger 2.0 API.",
3
+ "id": "http://swagger.io/v2/schema.json#",
4
+ "$schema": "http://json-schema.org/draft-04/schema#",
5
+ "type": "object",
6
+ "required": [
7
+ "swagger",
8
+ "info",
9
+ "paths"
10
+ ],
11
+ "additionalProperties": false,
12
+ "patternProperties": {
13
+ "^x-": {
14
+ "$ref": "#/definitions/vendorExtension"
15
+ }
16
+ },
17
+ "properties": {
18
+ "swagger": {
19
+ "type": "string",
20
+ "enum": [
21
+ "2.0"
22
+ ],
23
+ "description": "The Swagger version of this document."
24
+ },
25
+ "info": {
26
+ "$ref": "#/definitions/info"
27
+ },
28
+ "host": {
29
+ "type": "string",
30
+ "format": "uri",
31
+ "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$",
32
+ "description": "The fully qualified URI to the host of the API."
33
+ },
34
+ "basePath": {
35
+ "type": "string",
36
+ "pattern": "^/",
37
+ "description": "The base path to the API. Example: '/api'."
38
+ },
39
+ "schemes": {
40
+ "$ref": "#/definitions/schemesList"
41
+ },
42
+ "consumes": {
43
+ "description": "A list of MIME types accepted by the API.",
44
+ "$ref": "#/definitions/mediaTypeList"
45
+ },
46
+ "produces": {
47
+ "description": "A list of MIME types the API can produce.",
48
+ "$ref": "#/definitions/mediaTypeList"
49
+ },
50
+ "paths": {
51
+ "$ref": "#/definitions/paths"
52
+ },
53
+ "definitions": {
54
+ "$ref": "#/definitions/definitions"
55
+ },
56
+ "parameters": {
57
+ "$ref": "#/definitions/parameterDefinitions"
58
+ },
59
+ "responses": {
60
+ "$ref": "#/definitions/responseDefinitions"
61
+ },
62
+ "security": {
63
+ "$ref": "#/definitions/security"
64
+ },
65
+ "securityDefinitions": {
66
+ "$ref": "#/definitions/securityDefinitions"
67
+ },
68
+ "tags": {
69
+ "type": "array",
70
+ "items": {
71
+ "$ref": "#/definitions/tag"
72
+ },
73
+ "uniqueItems": true
74
+ },
75
+ "externalDocs": {
76
+ "$ref": "#/definitions/externalDocs"
77
+ }
78
+ },
79
+ "definitions": {
80
+ "info": {
81
+ "type": "object",
82
+ "description": "General information about the API.",
83
+ "required": [
84
+ "version",
85
+ "title"
86
+ ],
87
+ "additionalProperties": false,
88
+ "patternProperties": {
89
+ "^x-": {
90
+ "$ref": "#/definitions/vendorExtension"
91
+ }
92
+ },
93
+ "properties": {
94
+ "title": {
95
+ "type": "string",
96
+ "description": "A unique and precise title of the API."
97
+ },
98
+ "version": {
99
+ "type": "string",
100
+ "description": "A semantic version number of the API."
101
+ },
102
+ "description": {
103
+ "type": "string",
104
+ "description": "A longer description of the API. Should be different from the title. Github-flavored markdown is allowed."
105
+ },
106
+ "termsOfService": {
107
+ "type": "string",
108
+ "description": "The terms of service for the API."
109
+ },
110
+ "contact": {
111
+ "$ref": "#/definitions/contact"
112
+ },
113
+ "license": {
114
+ "$ref": "#/definitions/license"
115
+ }
116
+ }
117
+ },
118
+ "contact": {
119
+ "type": "object",
120
+ "description": "Contact information for the owners of the API.",
121
+ "additionalProperties": false,
122
+ "properties": {
123
+ "name": {
124
+ "type": "string",
125
+ "description": "The identifying name of the contact person/organization."
126
+ },
127
+ "url": {
128
+ "type": "string",
129
+ "description": "The URL pointing to the contact information.",
130
+ "format": "uri"
131
+ },
132
+ "email": {
133
+ "type": "string",
134
+ "description": "The email address of the contact person/organization.",
135
+ "format": "email"
136
+ }
137
+ }
138
+ },
139
+ "license": {
140
+ "type": "object",
141
+ "required": [
142
+ "name"
143
+ ],
144
+ "additionalProperties": false,
145
+ "properties": {
146
+ "name": {
147
+ "type": "string",
148
+ "description": "The name of the license type. It's encouraged to use an OSI compatible license."
149
+ },
150
+ "url": {
151
+ "type": "string",
152
+ "description": "The URL pointing to the license.",
153
+ "format": "uri"
154
+ }
155
+ }
156
+ },
157
+ "paths": {
158
+ "type": "object",
159
+ "description": "Relative paths to the individual endpoints. They must be relative to the 'basePath'.",
160
+ "patternProperties": {
161
+ "^x-": {
162
+ "$ref": "#/definitions/vendorExtension"
163
+ },
164
+ "^/": {
165
+ "$ref": "#/definitions/pathItem"
166
+ }
167
+ },
168
+ "additionalProperties": false
169
+ },
170
+ "definitions": {
171
+ "type": "object",
172
+ "additionalProperties": {
173
+ "$ref": "#/definitions/schema"
174
+ },
175
+ "description": "One or more JSON objects describing the schemas being consumed and produced by the API."
176
+ },
177
+ "parameterDefinitions": {
178
+ "type": "object",
179
+ "additionalProperties": {
180
+ "$ref": "#/definitions/parameter"
181
+ },
182
+ "description": "One or more JSON representations for parameters"
183
+ },
184
+ "responseDefinitions": {
185
+ "type": "object",
186
+ "additionalProperties": {
187
+ "$ref": "#/definitions/response"
188
+ },
189
+ "description": "One or more JSON representations for parameters"
190
+ },
191
+ "externalDocs": {
192
+ "type": "object",
193
+ "additionalProperties": false,
194
+ "description": "information about external documentation",
195
+ "required": [
196
+ "url"
197
+ ],
198
+ "properties": {
199
+ "description": {
200
+ "type": "string"
201
+ },
202
+ "url": {
203
+ "type": "string",
204
+ "format": "uri"
205
+ }
206
+ }
207
+ },
208
+ "examples": {
209
+ "type": "object",
210
+ "patternProperties": {
211
+ "^[a-z0-9-]+/[a-z0-9\\-+]+$": {}
212
+ },
213
+ "additionalProperties": false
214
+ },
215
+ "mimeType": {
216
+ "type": "string",
217
+ "pattern": "^[\\sa-z0-9\\-+;\\.=\\/]+$",
218
+ "description": "The MIME type of the HTTP message."
219
+ },
220
+ "operation": {
221
+ "type": "object",
222
+ "required": [
223
+ "responses"
224
+ ],
225
+ "additionalProperties": false,
226
+ "patternProperties": {
227
+ "^x-": {
228
+ "$ref": "#/definitions/vendorExtension"
229
+ }
230
+ },
231
+ "properties": {
232
+ "tags": {
233
+ "type": "array",
234
+ "items": {
235
+ "type": "string"
236
+ },
237
+ "uniqueItems": true
238
+ },
239
+ "summary": {
240
+ "type": "string",
241
+ "description": "A brief summary of the operation."
242
+ },
243
+ "description": {
244
+ "type": "string",
245
+ "description": "A longer description of the operation, github-flavored markdown is allowed."
246
+ },
247
+ "externalDocs": {
248
+ "$ref": "#/definitions/externalDocs"
249
+ },
250
+ "operationId": {
251
+ "type": "string",
252
+ "description": "A friendly name of the operation"
253
+ },
254
+ "produces": {
255
+ "description": "A list of MIME types the API can produce.",
256
+ "$ref": "#/definitions/mediaTypeList"
257
+ },
258
+ "consumes": {
259
+ "description": "A list of MIME types the API can consume.",
260
+ "$ref": "#/definitions/mediaTypeList"
261
+ },
262
+ "parameters": {
263
+ "$ref": "#/definitions/parametersList"
264
+ },
265
+ "responses": {
266
+ "$ref": "#/definitions/responses"
267
+ },
268
+ "schemes": {
269
+ "$ref": "#/definitions/schemesList"
270
+ },
271
+ "deprecated": {
272
+ "type": "boolean",
273
+ "default": false
274
+ },
275
+ "security": {
276
+ "$ref": "#/definitions/security"
277
+ }
278
+ }
279
+ },
280
+ "pathItem": {
281
+ "type": "object",
282
+ "additionalProperties": false,
283
+ "patternProperties": {
284
+ "^x-": {
285
+ "$ref": "#/definitions/vendorExtension"
286
+ }
287
+ },
288
+ "properties": {
289
+ "$ref": {
290
+ "type": "string"
291
+ },
292
+ "get": {
293
+ "$ref": "#/definitions/operation"
294
+ },
295
+ "put": {
296
+ "$ref": "#/definitions/operation"
297
+ },
298
+ "post": {
299
+ "$ref": "#/definitions/operation"
300
+ },
301
+ "delete": {
302
+ "$ref": "#/definitions/operation"
303
+ },
304
+ "options": {
305
+ "$ref": "#/definitions/operation"
306
+ },
307
+ "head": {
308
+ "$ref": "#/definitions/operation"
309
+ },
310
+ "patch": {
311
+ "$ref": "#/definitions/operation"
312
+ },
313
+ "parameters": {
314
+ "$ref": "#/definitions/parametersList"
315
+ }
316
+ }
317
+ },
318
+ "responses": {
319
+ "type": "object",
320
+ "description": "Response objects names can either be any valid HTTP status code or 'default'.",
321
+ "minProperties": 1,
322
+ "additionalProperties": false,
323
+ "patternProperties": {
324
+ "^([0-9]{3})$|^(default)$": {
325
+ "$ref": "#/definitions/responseValue"
326
+ },
327
+ "^x-": {
328
+ "$ref": "#/definitions/vendorExtension"
329
+ }
330
+ },
331
+ "not": {
332
+ "type": "object",
333
+ "additionalProperties": false,
334
+ "patternProperties": {
335
+ "^x-": {
336
+ "$ref": "#/definitions/vendorExtension"
337
+ }
338
+ }
339
+ }
340
+ },
341
+ "responseValue": {
342
+ "oneOf": [
343
+ {
344
+ "$ref": "#/definitions/response"
345
+ },
346
+ {
347
+ "$ref": "#/definitions/jsonReference"
348
+ }
349
+ ]
350
+ },
351
+ "response": {
352
+ "type": "object",
353
+ "required": [
354
+ "description"
355
+ ],
356
+ "properties": {
357
+ "description": {
358
+ "type": "string"
359
+ },
360
+ "schema": {
361
+ "$ref": "#/definitions/schema"
362
+ },
363
+ "headers": {
364
+ "$ref": "#/definitions/headers"
365
+ },
366
+ "examples": {
367
+ "$ref": "#/definitions/examples"
368
+ }
369
+ },
370
+ "additionalProperties": false
371
+ },
372
+ "headers": {
373
+ "type": "object",
374
+ "additionalProperties": {
375
+ "$ref": "#/definitions/header"
376
+ }
377
+ },
378
+ "header": {
379
+ "type": "object",
380
+ "additionalProperties": false,
381
+ "required": [
382
+ "type"
383
+ ],
384
+ "properties": {
385
+ "type": {
386
+ "type": "string",
387
+ "enum": [
388
+ "string",
389
+ "number",
390
+ "integer",
391
+ "boolean",
392
+ "array"
393
+ ]
394
+ },
395
+ "format": {
396
+ "type": "string"
397
+ },
398
+ "items": {
399
+ "$ref": "#/definitions/primitivesItems"
400
+ },
401
+ "collectionFormat": {
402
+ "$ref": "#/definitions/collectionFormat"
403
+ },
404
+ "default": {
405
+ "$ref": "#/definitions/default"
406
+ },
407
+ "maximum": {
408
+ "$ref": "#/definitions/maximum"
409
+ },
410
+ "exclusiveMaximum": {
411
+ "$ref": "#/definitions/exclusiveMaximum"
412
+ },
413
+ "minimum": {
414
+ "$ref": "#/definitions/minimum"
415
+ },
416
+ "exclusiveMinimum": {
417
+ "$ref": "#/definitions/exclusiveMinimum"
418
+ },
419
+ "maxLength": {
420
+ "$ref": "#/definitions/maxLength"
421
+ },
422
+ "minLength": {
423
+ "$ref": "#/definitions/minLength"
424
+ },
425
+ "pattern": {
426
+ "$ref": "#/definitions/pattern"
427
+ },
428
+ "maxItems": {
429
+ "$ref": "#/definitions/maxItems"
430
+ },
431
+ "minItems": {
432
+ "$ref": "#/definitions/minItems"
433
+ },
434
+ "uniqueItems": {
435
+ "$ref": "#/definitions/uniqueItems"
436
+ },
437
+ "enum": {
438
+ "$ref": "#/definitions/enum"
439
+ },
440
+ "multipleOf": {
441
+ "$ref": "#/definitions/multipleOf"
442
+ },
443
+ "description": {
444
+ "type": "string"
445
+ }
446
+ }
447
+ },
448
+ "vendorExtension": {
449
+ "description": "Any property starting with x- is valid.",
450
+ "additionalProperties": true,
451
+ "additionalItems": true
452
+ },
453
+ "bodyParameter": {
454
+ "type": "object",
455
+ "required": [
456
+ "name",
457
+ "in",
458
+ "schema"
459
+ ],
460
+ "patternProperties": {
461
+ "^x-": {
462
+ "$ref": "#/definitions/vendorExtension"
463
+ }
464
+ },
465
+ "properties": {
466
+ "description": {
467
+ "type": "string",
468
+ "description": "A brief description of the parameter. This could contain examples of use. Github-flavored markdown is allowed."
469
+ },
470
+ "name": {
471
+ "type": "string",
472
+ "description": "The name of the parameter."
473
+ },
474
+ "in": {
475
+ "type": "string",
476
+ "description": "Determines the location of the parameter.",
477
+ "enum": [
478
+ "body"
479
+ ]
480
+ },
481
+ "required": {
482
+ "type": "boolean",
483
+ "description": "Determines whether or not this parameter is required or optional.",
484
+ "default": false
485
+ },
486
+ "schema": {
487
+ "$ref": "#/definitions/schema"
488
+ }
489
+ },
490
+ "additionalProperties": false
491
+ },
492
+ "headerParameterSubSchema": {
493
+ "additionalProperties": false,
494
+ "patternProperties": {
495
+ "^x-": {
496
+ "$ref": "#/definitions/vendorExtension"
497
+ }
498
+ },
499
+ "properties": {
500
+ "required": {
501
+ "type": "boolean",
502
+ "description": "Determines whether or not this parameter is required or optional.",
503
+ "default": false
504
+ },
505
+ "in": {
506
+ "type": "string",
507
+ "description": "Determines the location of the parameter.",
508
+ "enum": [
509
+ "header"
510
+ ]
511
+ },
512
+ "description": {
513
+ "type": "string",
514
+ "description": "A brief description of the parameter. This could contain examples of use. Github-flavored markdown is allowed."
515
+ },
516
+ "name": {
517
+ "type": "string",
518
+ "description": "The name of the parameter."
519
+ },
520
+ "type": {
521
+ "type": "string",
522
+ "enum": [
523
+ "string",
524
+ "number",
525
+ "boolean",
526
+ "integer",
527
+ "array"
528
+ ]
529
+ },
530
+ "format": {
531
+ "type": "string"
532
+ },
533
+ "items": {
534
+ "$ref": "#/definitions/primitivesItems"
535
+ },
536
+ "collectionFormat": {
537
+ "$ref": "#/definitions/collectionFormat"
538
+ },
539
+ "default": {
540
+ "$ref": "#/definitions/default"
541
+ },
542
+ "maximum": {
543
+ "$ref": "#/definitions/maximum"
544
+ },
545
+ "exclusiveMaximum": {
546
+ "$ref": "#/definitions/exclusiveMaximum"
547
+ },
548
+ "minimum": {
549
+ "$ref": "#/definitions/minimum"
550
+ },
551
+ "exclusiveMinimum": {
552
+ "$ref": "#/definitions/exclusiveMinimum"
553
+ },
554
+ "maxLength": {
555
+ "$ref": "#/definitions/maxLength"
556
+ },
557
+ "minLength": {
558
+ "$ref": "#/definitions/minLength"
559
+ },
560
+ "pattern": {
561
+ "$ref": "#/definitions/pattern"
562
+ },
563
+ "maxItems": {
564
+ "$ref": "#/definitions/maxItems"
565
+ },
566
+ "minItems": {
567
+ "$ref": "#/definitions/minItems"
568
+ },
569
+ "uniqueItems": {
570
+ "$ref": "#/definitions/uniqueItems"
571
+ },
572
+ "enum": {
573
+ "$ref": "#/definitions/enum"
574
+ },
575
+ "multipleOf": {
576
+ "$ref": "#/definitions/multipleOf"
577
+ }
578
+ }
579
+ },
580
+ "queryParameterSubSchema": {
581
+ "additionalProperties": false,
582
+ "patternProperties": {
583
+ "^x-": {
584
+ "$ref": "#/definitions/vendorExtension"
585
+ }
586
+ },
587
+ "properties": {
588
+ "required": {
589
+ "type": "boolean",
590
+ "description": "Determines whether or not this parameter is required or optional.",
591
+ "default": false
592
+ },
593
+ "in": {
594
+ "type": "string",
595
+ "description": "Determines the location of the parameter.",
596
+ "enum": [
597
+ "query"
598
+ ]
599
+ },
600
+ "description": {
601
+ "type": "string",
602
+ "description": "A brief description of the parameter. This could contain examples of use. Github-flavored markdown is allowed."
603
+ },
604
+ "name": {
605
+ "type": "string",
606
+ "description": "The name of the parameter."
607
+ },
608
+ "type": {
609
+ "type": "string",
610
+ "enum": [
611
+ "string",
612
+ "number",
613
+ "boolean",
614
+ "integer",
615
+ "array"
616
+ ]
617
+ },
618
+ "format": {
619
+ "type": "string"
620
+ },
621
+ "items": {
622
+ "$ref": "#/definitions/primitivesItems"
623
+ },
624
+ "collectionFormat": {
625
+ "$ref": "#/definitions/collectionFormatWithMulti"
626
+ },
627
+ "default": {
628
+ "$ref": "#/definitions/default"
629
+ },
630
+ "maximum": {
631
+ "$ref": "#/definitions/maximum"
632
+ },
633
+ "exclusiveMaximum": {
634
+ "$ref": "#/definitions/exclusiveMaximum"
635
+ },
636
+ "minimum": {
637
+ "$ref": "#/definitions/minimum"
638
+ },
639
+ "exclusiveMinimum": {
640
+ "$ref": "#/definitions/exclusiveMinimum"
641
+ },
642
+ "maxLength": {
643
+ "$ref": "#/definitions/maxLength"
644
+ },
645
+ "minLength": {
646
+ "$ref": "#/definitions/minLength"
647
+ },
648
+ "pattern": {
649
+ "$ref": "#/definitions/pattern"
650
+ },
651
+ "maxItems": {
652
+ "$ref": "#/definitions/maxItems"
653
+ },
654
+ "minItems": {
655
+ "$ref": "#/definitions/minItems"
656
+ },
657
+ "uniqueItems": {
658
+ "$ref": "#/definitions/uniqueItems"
659
+ },
660
+ "enum": {
661
+ "$ref": "#/definitions/enum"
662
+ },
663
+ "multipleOf": {
664
+ "$ref": "#/definitions/multipleOf"
665
+ }
666
+ }
667
+ },
668
+ "formDataParameterSubSchema": {
669
+ "additionalProperties": false,
670
+ "patternProperties": {
671
+ "^x-": {
672
+ "$ref": "#/definitions/vendorExtension"
673
+ }
674
+ },
675
+ "properties": {
676
+ "required": {
677
+ "type": "boolean",
678
+ "description": "Determines whether or not this parameter is required or optional.",
679
+ "default": false
680
+ },
681
+ "in": {
682
+ "type": "string",
683
+ "description": "Determines the location of the parameter.",
684
+ "enum": [
685
+ "formData"
686
+ ]
687
+ },
688
+ "description": {
689
+ "type": "string",
690
+ "description": "A brief description of the parameter. This could contain examples of use. Github-flavored markdown is allowed."
691
+ },
692
+ "name": {
693
+ "type": "string",
694
+ "description": "The name of the parameter."
695
+ },
696
+ "type": {
697
+ "type": "string",
698
+ "enum": [
699
+ "string",
700
+ "number",
701
+ "boolean",
702
+ "integer",
703
+ "array",
704
+ "file"
705
+ ]
706
+ },
707
+ "format": {
708
+ "type": "string"
709
+ },
710
+ "items": {
711
+ "$ref": "#/definitions/primitivesItems"
712
+ },
713
+ "collectionFormat": {
714
+ "$ref": "#/definitions/collectionFormatWithMulti"
715
+ },
716
+ "default": {
717
+ "$ref": "#/definitions/default"
718
+ },
719
+ "maximum": {
720
+ "$ref": "#/definitions/maximum"
721
+ },
722
+ "exclusiveMaximum": {
723
+ "$ref": "#/definitions/exclusiveMaximum"
724
+ },
725
+ "minimum": {
726
+ "$ref": "#/definitions/minimum"
727
+ },
728
+ "exclusiveMinimum": {
729
+ "$ref": "#/definitions/exclusiveMinimum"
730
+ },
731
+ "maxLength": {
732
+ "$ref": "#/definitions/maxLength"
733
+ },
734
+ "minLength": {
735
+ "$ref": "#/definitions/minLength"
736
+ },
737
+ "pattern": {
738
+ "$ref": "#/definitions/pattern"
739
+ },
740
+ "maxItems": {
741
+ "$ref": "#/definitions/maxItems"
742
+ },
743
+ "minItems": {
744
+ "$ref": "#/definitions/minItems"
745
+ },
746
+ "uniqueItems": {
747
+ "$ref": "#/definitions/uniqueItems"
748
+ },
749
+ "enum": {
750
+ "$ref": "#/definitions/enum"
751
+ },
752
+ "multipleOf": {
753
+ "$ref": "#/definitions/multipleOf"
754
+ }
755
+ }
756
+ },
757
+ "pathParameterSubSchema": {
758
+ "additionalProperties": false,
759
+ "patternProperties": {
760
+ "^x-": {
761
+ "$ref": "#/definitions/vendorExtension"
762
+ }
763
+ },
764
+ "properties": {
765
+ "required": {
766
+ "type": "boolean",
767
+ "enum": [
768
+ true
769
+ ],
770
+ "description": "Determines whether or not this parameter is required or optional."
771
+ },
772
+ "in": {
773
+ "type": "string",
774
+ "description": "Determines the location of the parameter.",
775
+ "enum": [
776
+ "path"
777
+ ]
778
+ },
779
+ "description": {
780
+ "type": "string",
781
+ "description": "A brief description of the parameter. This could contain examples of use. Github-flavored markdown is allowed."
782
+ },
783
+ "name": {
784
+ "type": "string",
785
+ "description": "The name of the parameter."
786
+ },
787
+ "type": {
788
+ "type": "string",
789
+ "enum": [
790
+ "string",
791
+ "number",
792
+ "boolean",
793
+ "integer",
794
+ "array"
795
+ ]
796
+ },
797
+ "format": {
798
+ "type": "string"
799
+ },
800
+ "items": {
801
+ "$ref": "#/definitions/primitivesItems"
802
+ },
803
+ "collectionFormat": {
804
+ "$ref": "#/definitions/collectionFormat"
805
+ },
806
+ "default": {
807
+ "$ref": "#/definitions/default"
808
+ },
809
+ "maximum": {
810
+ "$ref": "#/definitions/maximum"
811
+ },
812
+ "exclusiveMaximum": {
813
+ "$ref": "#/definitions/exclusiveMaximum"
814
+ },
815
+ "minimum": {
816
+ "$ref": "#/definitions/minimum"
817
+ },
818
+ "exclusiveMinimum": {
819
+ "$ref": "#/definitions/exclusiveMinimum"
820
+ },
821
+ "maxLength": {
822
+ "$ref": "#/definitions/maxLength"
823
+ },
824
+ "minLength": {
825
+ "$ref": "#/definitions/minLength"
826
+ },
827
+ "pattern": {
828
+ "$ref": "#/definitions/pattern"
829
+ },
830
+ "maxItems": {
831
+ "$ref": "#/definitions/maxItems"
832
+ },
833
+ "minItems": {
834
+ "$ref": "#/definitions/minItems"
835
+ },
836
+ "uniqueItems": {
837
+ "$ref": "#/definitions/uniqueItems"
838
+ },
839
+ "enum": {
840
+ "$ref": "#/definitions/enum"
841
+ },
842
+ "multipleOf": {
843
+ "$ref": "#/definitions/multipleOf"
844
+ }
845
+ }
846
+ },
847
+ "nonBodyParameter": {
848
+ "type": "object",
849
+ "required": [
850
+ "name",
851
+ "in",
852
+ "type"
853
+ ],
854
+ "oneOf": [
855
+ {
856
+ "$ref": "#/definitions/headerParameterSubSchema"
857
+ },
858
+ {
859
+ "$ref": "#/definitions/formDataParameterSubSchema"
860
+ },
861
+ {
862
+ "$ref": "#/definitions/queryParameterSubSchema"
863
+ },
864
+ {
865
+ "$ref": "#/definitions/pathParameterSubSchema"
866
+ }
867
+ ]
868
+ },
869
+ "parameter": {
870
+ "oneOf": [
871
+ {
872
+ "$ref": "#/definitions/bodyParameter"
873
+ },
874
+ {
875
+ "$ref": "#/definitions/nonBodyParameter"
876
+ }
877
+ ]
878
+ },
879
+ "schema": {
880
+ "type": "object",
881
+ "description": "A deterministic version of a JSON Schema object.",
882
+ "patternProperties": {
883
+ "^x-": {
884
+ "$ref": "#/definitions/vendorExtension"
885
+ }
886
+ },
887
+ "properties": {
888
+ "$ref": {
889
+ "type": "string"
890
+ },
891
+ "format": {
892
+ "type": "string"
893
+ },
894
+ "title": {
895
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/title"
896
+ },
897
+ "description": {
898
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/description"
899
+ },
900
+ "default": {
901
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/default"
902
+ },
903
+ "multipleOf": {
904
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/multipleOf"
905
+ },
906
+ "maximum": {
907
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/maximum"
908
+ },
909
+ "exclusiveMaximum": {
910
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum"
911
+ },
912
+ "minimum": {
913
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/minimum"
914
+ },
915
+ "exclusiveMinimum": {
916
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum"
917
+ },
918
+ "maxLength": {
919
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger"
920
+ },
921
+ "minLength": {
922
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
923
+ },
924
+ "pattern": {
925
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/pattern"
926
+ },
927
+ "maxItems": {
928
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger"
929
+ },
930
+ "minItems": {
931
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
932
+ },
933
+ "uniqueItems": {
934
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/uniqueItems"
935
+ },
936
+ "maxProperties": {
937
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger"
938
+ },
939
+ "minProperties": {
940
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
941
+ },
942
+ "required": {
943
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
944
+ },
945
+ "enum": {
946
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/enum"
947
+ },
948
+ "type": {
949
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/type"
950
+ },
951
+ "items": {
952
+ "anyOf": [
953
+ {
954
+ "$ref": "#/definitions/schema"
955
+ },
956
+ {
957
+ "type": "array",
958
+ "minItems": 1,
959
+ "items": {
960
+ "$ref": "#/definitions/schema"
961
+ }
962
+ }
963
+ ],
964
+ "default": {}
965
+ },
966
+ "allOf": {
967
+ "type": "array",
968
+ "minItems": 1,
969
+ "items": {
970
+ "$ref": "#/definitions/schema"
971
+ }
972
+ },
973
+ "properties": {
974
+ "type": "object",
975
+ "additionalProperties": {
976
+ "$ref": "#/definitions/schema"
977
+ },
978
+ "default": {}
979
+ },
980
+ "discriminator": {
981
+ "type": "string"
982
+ },
983
+ "readOnly": {
984
+ "type": "boolean",
985
+ "default": false
986
+ },
987
+ "xml": {
988
+ "$ref": "#/definitions/xml"
989
+ },
990
+ "externalDocs": {
991
+ "$ref": "#/definitions/externalDocs"
992
+ },
993
+ "example": {}
994
+ }
995
+ },
996
+ "primitivesItems": {
997
+ "type": "object",
998
+ "additionalProperties": false,
999
+ "properties": {
1000
+ "type": {
1001
+ "type": "string",
1002
+ "enum": [
1003
+ "string",
1004
+ "number",
1005
+ "integer",
1006
+ "boolean",
1007
+ "array"
1008
+ ]
1009
+ },
1010
+ "format": {
1011
+ "type": "string"
1012
+ },
1013
+ "items": {
1014
+ "$ref": "#/definitions/primitivesItems"
1015
+ },
1016
+ "collectionFormat": {
1017
+ "$ref": "#/definitions/collectionFormat"
1018
+ },
1019
+ "default": {
1020
+ "$ref": "#/definitions/default"
1021
+ },
1022
+ "maximum": {
1023
+ "$ref": "#/definitions/maximum"
1024
+ },
1025
+ "exclusiveMaximum": {
1026
+ "$ref": "#/definitions/exclusiveMaximum"
1027
+ },
1028
+ "minimum": {
1029
+ "$ref": "#/definitions/minimum"
1030
+ },
1031
+ "exclusiveMinimum": {
1032
+ "$ref": "#/definitions/exclusiveMinimum"
1033
+ },
1034
+ "maxLength": {
1035
+ "$ref": "#/definitions/maxLength"
1036
+ },
1037
+ "minLength": {
1038
+ "$ref": "#/definitions/minLength"
1039
+ },
1040
+ "pattern": {
1041
+ "$ref": "#/definitions/pattern"
1042
+ },
1043
+ "maxItems": {
1044
+ "$ref": "#/definitions/maxItems"
1045
+ },
1046
+ "minItems": {
1047
+ "$ref": "#/definitions/minItems"
1048
+ },
1049
+ "uniqueItems": {
1050
+ "$ref": "#/definitions/uniqueItems"
1051
+ },
1052
+ "enum": {
1053
+ "$ref": "#/definitions/enum"
1054
+ },
1055
+ "multipleOf": {
1056
+ "$ref": "#/definitions/multipleOf"
1057
+ }
1058
+ }
1059
+ },
1060
+ "security": {
1061
+ "type": "array",
1062
+ "items": {
1063
+ "$ref": "#/definitions/securityRequirement"
1064
+ },
1065
+ "uniqueItems": true
1066
+ },
1067
+ "securityRequirement": {
1068
+ "type": "object",
1069
+ "additionalProperties": {
1070
+ "type": "array",
1071
+ "items": {
1072
+ "type": "string"
1073
+ },
1074
+ "uniqueItems": true
1075
+ }
1076
+ },
1077
+ "xml": {
1078
+ "type": "object",
1079
+ "additionalProperties": false,
1080
+ "properties": {
1081
+ "name": {
1082
+ "type": "string"
1083
+ },
1084
+ "namespace": {
1085
+ "type": "string"
1086
+ },
1087
+ "prefix": {
1088
+ "type": "string"
1089
+ },
1090
+ "attribute": {
1091
+ "type": "boolean",
1092
+ "default": false
1093
+ },
1094
+ "wrapped": {
1095
+ "type": "boolean",
1096
+ "default": false
1097
+ }
1098
+ }
1099
+ },
1100
+ "tag": {
1101
+ "type": "object",
1102
+ "additionalProperties": false,
1103
+ "required": [
1104
+ "name"
1105
+ ],
1106
+ "properties": {
1107
+ "name": {
1108
+ "type": "string"
1109
+ },
1110
+ "description": {
1111
+ "type": "string"
1112
+ },
1113
+ "externalDocs": {
1114
+ "$ref": "#/definitions/externalDocs"
1115
+ }
1116
+ },
1117
+ "patternProperties": {
1118
+ "^x-": {
1119
+ "$ref": "#/definitions/vendorExtension"
1120
+ }
1121
+ }
1122
+ },
1123
+ "securityDefinitions": {
1124
+ "type": "object",
1125
+ "additionalProperties": {
1126
+ "oneOf": [
1127
+ {
1128
+ "$ref": "#/definitions/basicAuthenticationSecurity"
1129
+ },
1130
+ {
1131
+ "$ref": "#/definitions/apiKeySecurity"
1132
+ },
1133
+ {
1134
+ "$ref": "#/definitions/oauth2ImplicitSecurity"
1135
+ },
1136
+ {
1137
+ "$ref": "#/definitions/oauth2PasswordSecurity"
1138
+ },
1139
+ {
1140
+ "$ref": "#/definitions/oauth2ApplicationSecurity"
1141
+ },
1142
+ {
1143
+ "$ref": "#/definitions/oauth2AccessCodeSecurity"
1144
+ }
1145
+ ]
1146
+ }
1147
+ },
1148
+ "basicAuthenticationSecurity": {
1149
+ "type": "object",
1150
+ "additionalProperties": false,
1151
+ "required": [
1152
+ "type"
1153
+ ],
1154
+ "properties": {
1155
+ "type": {
1156
+ "type": "string",
1157
+ "enum": [
1158
+ "basic"
1159
+ ]
1160
+ },
1161
+ "description": {
1162
+ "type": "string"
1163
+ }
1164
+ },
1165
+ "patternProperties": {
1166
+ "^x-": {
1167
+ "$ref": "#/definitions/vendorExtension"
1168
+ }
1169
+ }
1170
+ },
1171
+ "apiKeySecurity": {
1172
+ "type": "object",
1173
+ "additionalProperties": false,
1174
+ "required": [
1175
+ "type",
1176
+ "name",
1177
+ "in"
1178
+ ],
1179
+ "properties": {
1180
+ "type": {
1181
+ "type": "string",
1182
+ "enum": [
1183
+ "apiKey"
1184
+ ]
1185
+ },
1186
+ "name": {
1187
+ "type": "string"
1188
+ },
1189
+ "in": {
1190
+ "type": "string",
1191
+ "enum": [
1192
+ "header",
1193
+ "query"
1194
+ ]
1195
+ },
1196
+ "description": {
1197
+ "type": "string"
1198
+ }
1199
+ },
1200
+ "patternProperties": {
1201
+ "^x-": {
1202
+ "$ref": "#/definitions/vendorExtension"
1203
+ }
1204
+ }
1205
+ },
1206
+ "oauth2ImplicitSecurity": {
1207
+ "type": "object",
1208
+ "additionalProperties": false,
1209
+ "required": [
1210
+ "type",
1211
+ "flow",
1212
+ "authorizationUrl"
1213
+ ],
1214
+ "properties": {
1215
+ "type": {
1216
+ "type": "string",
1217
+ "enum": [
1218
+ "oauth2"
1219
+ ]
1220
+ },
1221
+ "flow": {
1222
+ "type": "string",
1223
+ "enum": [
1224
+ "implicit"
1225
+ ]
1226
+ },
1227
+ "scopes": {
1228
+ "$ref": "#/definitions/oauth2Scopes"
1229
+ },
1230
+ "authorizationUrl": {
1231
+ "type": "string",
1232
+ "format": "uri"
1233
+ },
1234
+ "description": {
1235
+ "type": "string"
1236
+ }
1237
+ },
1238
+ "patternProperties": {
1239
+ "^x-": {
1240
+ "$ref": "#/definitions/vendorExtension"
1241
+ }
1242
+ }
1243
+ },
1244
+ "oauth2PasswordSecurity": {
1245
+ "type": "object",
1246
+ "additionalProperties": false,
1247
+ "required": [
1248
+ "type",
1249
+ "flow",
1250
+ "tokenUrl"
1251
+ ],
1252
+ "properties": {
1253
+ "type": {
1254
+ "type": "string",
1255
+ "enum": [
1256
+ "oauth2"
1257
+ ]
1258
+ },
1259
+ "flow": {
1260
+ "type": "string",
1261
+ "enum": [
1262
+ "password"
1263
+ ]
1264
+ },
1265
+ "scopes": {
1266
+ "$ref": "#/definitions/oauth2Scopes"
1267
+ },
1268
+ "tokenUrl": {
1269
+ "type": "string",
1270
+ "format": "uri"
1271
+ },
1272
+ "description": {
1273
+ "type": "string"
1274
+ }
1275
+ },
1276
+ "patternProperties": {
1277
+ "^x-": {
1278
+ "$ref": "#/definitions/vendorExtension"
1279
+ }
1280
+ }
1281
+ },
1282
+ "oauth2ApplicationSecurity": {
1283
+ "type": "object",
1284
+ "additionalProperties": false,
1285
+ "required": [
1286
+ "type",
1287
+ "flow",
1288
+ "tokenUrl"
1289
+ ],
1290
+ "properties": {
1291
+ "type": {
1292
+ "type": "string",
1293
+ "enum": [
1294
+ "oauth2"
1295
+ ]
1296
+ },
1297
+ "flow": {
1298
+ "type": "string",
1299
+ "enum": [
1300
+ "application"
1301
+ ]
1302
+ },
1303
+ "scopes": {
1304
+ "$ref": "#/definitions/oauth2Scopes"
1305
+ },
1306
+ "tokenUrl": {
1307
+ "type": "string",
1308
+ "format": "uri"
1309
+ },
1310
+ "description": {
1311
+ "type": "string"
1312
+ }
1313
+ },
1314
+ "patternProperties": {
1315
+ "^x-": {
1316
+ "$ref": "#/definitions/vendorExtension"
1317
+ }
1318
+ }
1319
+ },
1320
+ "oauth2AccessCodeSecurity": {
1321
+ "type": "object",
1322
+ "additionalProperties": false,
1323
+ "required": [
1324
+ "type",
1325
+ "flow",
1326
+ "authorizationUrl",
1327
+ "tokenUrl"
1328
+ ],
1329
+ "properties": {
1330
+ "type": {
1331
+ "type": "string",
1332
+ "enum": [
1333
+ "oauth2"
1334
+ ]
1335
+ },
1336
+ "flow": {
1337
+ "type": "string",
1338
+ "enum": [
1339
+ "accessCode"
1340
+ ]
1341
+ },
1342
+ "scopes": {
1343
+ "$ref": "#/definitions/oauth2Scopes"
1344
+ },
1345
+ "authorizationUrl": {
1346
+ "type": "string",
1347
+ "format": "uri"
1348
+ },
1349
+ "tokenUrl": {
1350
+ "type": "string",
1351
+ "format": "uri"
1352
+ },
1353
+ "description": {
1354
+ "type": "string"
1355
+ }
1356
+ },
1357
+ "patternProperties": {
1358
+ "^x-": {
1359
+ "$ref": "#/definitions/vendorExtension"
1360
+ }
1361
+ }
1362
+ },
1363
+ "oauth2Scopes": {
1364
+ "type": "object",
1365
+ "additionalProperties": {
1366
+ "type": "string"
1367
+ }
1368
+ },
1369
+ "mediaTypeList": {
1370
+ "type": "array",
1371
+ "items": {
1372
+ "$ref": "#/definitions/mimeType"
1373
+ },
1374
+ "uniqueItems": true
1375
+ },
1376
+ "parametersList": {
1377
+ "type": "array",
1378
+ "description": "The parameters needed to send a valid API call.",
1379
+ "minItems": 1,
1380
+ "additionalItems": false,
1381
+ "items": {
1382
+ "oneOf": [
1383
+ {
1384
+ "$ref": "#/definitions/parameter"
1385
+ },
1386
+ {
1387
+ "$ref": "#/definitions/jsonReference"
1388
+ }
1389
+ ]
1390
+ },
1391
+ "uniqueItems": true
1392
+ },
1393
+ "schemesList": {
1394
+ "type": "array",
1395
+ "description": "The transfer protocol of the API.",
1396
+ "items": {
1397
+ "type": "string",
1398
+ "enum": [
1399
+ "http",
1400
+ "https",
1401
+ "ws",
1402
+ "wss"
1403
+ ]
1404
+ },
1405
+ "uniqueItems": true
1406
+ },
1407
+ "collectionFormat": {
1408
+ "type": "string",
1409
+ "enum": [
1410
+ "csv",
1411
+ "ssv",
1412
+ "tsv",
1413
+ "pipes"
1414
+ ],
1415
+ "default": "csv"
1416
+ },
1417
+ "collectionFormatWithMulti": {
1418
+ "type": "string",
1419
+ "enum": [
1420
+ "csv",
1421
+ "ssv",
1422
+ "tsv",
1423
+ "pipes",
1424
+ "multi"
1425
+ ],
1426
+ "default": "csv"
1427
+ },
1428
+ "title": {
1429
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/title"
1430
+ },
1431
+ "description": {
1432
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/description"
1433
+ },
1434
+ "default": {
1435
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/default"
1436
+ },
1437
+ "multipleOf": {
1438
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/multipleOf"
1439
+ },
1440
+ "maximum": {
1441
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/maximum"
1442
+ },
1443
+ "exclusiveMaximum": {
1444
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum"
1445
+ },
1446
+ "minimum": {
1447
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/minimum"
1448
+ },
1449
+ "exclusiveMinimum": {
1450
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum"
1451
+ },
1452
+ "maxLength": {
1453
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger"
1454
+ },
1455
+ "minLength": {
1456
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
1457
+ },
1458
+ "pattern": {
1459
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/pattern"
1460
+ },
1461
+ "maxItems": {
1462
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger"
1463
+ },
1464
+ "minItems": {
1465
+ "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
1466
+ },
1467
+ "uniqueItems": {
1468
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/uniqueItems"
1469
+ },
1470
+ "enum": {
1471
+ "$ref": "http://json-schema.org/draft-04/schema#/properties/enum"
1472
+ },
1473
+ "jsonReference": {
1474
+ "type": "object",
1475
+ "additionalProperties": false,
1476
+ "properties": {
1477
+ "$ref": {
1478
+ "type": "string"
1479
+ }
1480
+ }
1481
+ }
1482
+ }
1483
+ }