scorpio 0.0.4 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1079 @@
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
+ additionalProperties: false
11
+ patternProperties:
12
+ "^x-":
13
+ "$ref": "#/definitions/vendorExtension"
14
+ properties:
15
+ swagger:
16
+ type: string
17
+ enum:
18
+ - '2.0'
19
+ description: The Swagger version of this document.
20
+ info:
21
+ "$ref": "#/definitions/info"
22
+ host:
23
+ type: string
24
+ pattern: "^[^{}/ :\\\\]+(?::\\d+)?$"
25
+ description: 'The host (name or ip) of the API. Example: ''swagger.io'''
26
+ basePath:
27
+ type: string
28
+ pattern: "^/"
29
+ description: 'The base path to the API. Example: ''/api''.'
30
+ schemes:
31
+ "$ref": "#/definitions/schemesList"
32
+ consumes:
33
+ description: A list of MIME types accepted by the API.
34
+ allOf:
35
+ - "$ref": "#/definitions/mediaTypeList"
36
+ produces:
37
+ description: A list of MIME types the API can produce.
38
+ allOf:
39
+ - "$ref": "#/definitions/mediaTypeList"
40
+ paths:
41
+ "$ref": "#/definitions/paths"
42
+ definitions:
43
+ "$ref": "#/definitions/definitions"
44
+ parameters:
45
+ "$ref": "#/definitions/parameterDefinitions"
46
+ responses:
47
+ "$ref": "#/definitions/responseDefinitions"
48
+ security:
49
+ "$ref": "#/definitions/security"
50
+ securityDefinitions:
51
+ "$ref": "#/definitions/securityDefinitions"
52
+ tags:
53
+ type: array
54
+ items:
55
+ "$ref": "#/definitions/tag"
56
+ uniqueItems: true
57
+ externalDocs:
58
+ "$ref": "#/definitions/externalDocs"
59
+ definitions:
60
+ info:
61
+ type: object
62
+ description: General information about the API.
63
+ required:
64
+ - version
65
+ - title
66
+ additionalProperties: false
67
+ patternProperties:
68
+ "^x-":
69
+ "$ref": "#/definitions/vendorExtension"
70
+ properties:
71
+ title:
72
+ type: string
73
+ description: A unique and precise title of the API.
74
+ version:
75
+ type: string
76
+ description: A semantic version number of the API.
77
+ description:
78
+ type: string
79
+ description: A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.
80
+ termsOfService:
81
+ type: string
82
+ description: The terms of service for the API.
83
+ contact:
84
+ "$ref": "#/definitions/contact"
85
+ license:
86
+ "$ref": "#/definitions/license"
87
+ contact:
88
+ type: object
89
+ description: Contact information for the owners of the API.
90
+ additionalProperties: false
91
+ properties:
92
+ name:
93
+ type: string
94
+ description: The identifying name of the contact person/organization.
95
+ url:
96
+ type: string
97
+ description: The URL pointing to the contact information.
98
+ format: uri
99
+ email:
100
+ type: string
101
+ description: The email address of the contact person/organization.
102
+ format: email
103
+ patternProperties:
104
+ "^x-":
105
+ "$ref": "#/definitions/vendorExtension"
106
+ license:
107
+ type: object
108
+ required:
109
+ - name
110
+ additionalProperties: false
111
+ properties:
112
+ name:
113
+ type: string
114
+ description: The name of the license type. It's encouraged to use an OSI compatible license.
115
+ url:
116
+ type: string
117
+ description: The URL pointing to the license.
118
+ format: uri
119
+ patternProperties:
120
+ "^x-":
121
+ "$ref": "#/definitions/vendorExtension"
122
+ paths:
123
+ type: object
124
+ description: Relative paths to the individual endpoints. They must be relative to the 'basePath'.
125
+ patternProperties:
126
+ "^x-":
127
+ "$ref": "#/definitions/vendorExtension"
128
+ "^/":
129
+ "$ref": "#/definitions/pathItem"
130
+ additionalProperties: false
131
+ definitions:
132
+ type: object
133
+ additionalProperties:
134
+ "$ref": "#/definitions/schema"
135
+ description: One or more JSON objects describing the schemas being consumed and produced by the API.
136
+ parameterDefinitions:
137
+ type: object
138
+ additionalProperties:
139
+ "$ref": "#/definitions/parameter"
140
+ description: One or more JSON representations for parameters
141
+ responseDefinitions:
142
+ type: object
143
+ additionalProperties:
144
+ "$ref": "#/definitions/response"
145
+ description: One or more JSON representations for parameters
146
+ externalDocs:
147
+ type: object
148
+ additionalProperties: false
149
+ description: information about external documentation
150
+ required:
151
+ - url
152
+ properties:
153
+ description:
154
+ type: string
155
+ url:
156
+ type: string
157
+ format: uri
158
+ patternProperties:
159
+ "^x-":
160
+ "$ref": "#/definitions/vendorExtension"
161
+ examples:
162
+ type: object
163
+ additionalProperties: true
164
+ mimeType:
165
+ type: string
166
+ description: The MIME type of the HTTP message.
167
+ operation:
168
+ type: object
169
+ required:
170
+ - responses
171
+ additionalProperties: false
172
+ patternProperties:
173
+ "^x-":
174
+ "$ref": "#/definitions/vendorExtension"
175
+ properties:
176
+ tags:
177
+ type: array
178
+ items:
179
+ type: string
180
+ uniqueItems: true
181
+ summary:
182
+ type: string
183
+ description: A brief summary of the operation.
184
+ description:
185
+ type: string
186
+ description: A longer description of the operation, GitHub Flavored Markdown is allowed.
187
+ externalDocs:
188
+ "$ref": "#/definitions/externalDocs"
189
+ operationId:
190
+ type: string
191
+ description: A unique identifier of the operation.
192
+ produces:
193
+ description: A list of MIME types the API can produce.
194
+ allOf:
195
+ - "$ref": "#/definitions/mediaTypeList"
196
+ consumes:
197
+ description: A list of MIME types the API can consume.
198
+ allOf:
199
+ - "$ref": "#/definitions/mediaTypeList"
200
+ parameters:
201
+ "$ref": "#/definitions/parametersList"
202
+ responses:
203
+ "$ref": "#/definitions/responses"
204
+ schemes:
205
+ "$ref": "#/definitions/schemesList"
206
+ deprecated:
207
+ type: boolean
208
+ default: false
209
+ security:
210
+ "$ref": "#/definitions/security"
211
+ pathItem:
212
+ type: object
213
+ additionalProperties: false
214
+ patternProperties:
215
+ "^x-":
216
+ "$ref": "#/definitions/vendorExtension"
217
+ properties:
218
+ "$ref":
219
+ type: string
220
+ get:
221
+ "$ref": "#/definitions/operation"
222
+ put:
223
+ "$ref": "#/definitions/operation"
224
+ post:
225
+ "$ref": "#/definitions/operation"
226
+ delete:
227
+ "$ref": "#/definitions/operation"
228
+ options:
229
+ "$ref": "#/definitions/operation"
230
+ head:
231
+ "$ref": "#/definitions/operation"
232
+ patch:
233
+ "$ref": "#/definitions/operation"
234
+ parameters:
235
+ "$ref": "#/definitions/parametersList"
236
+ responses:
237
+ type: object
238
+ description: Response objects names can either be any valid HTTP status code or 'default'.
239
+ minProperties: 1
240
+ additionalProperties: false
241
+ patternProperties:
242
+ "^([0-9]{3})$|^(default)$":
243
+ "$ref": "#/definitions/responseValue"
244
+ "^x-":
245
+ "$ref": "#/definitions/vendorExtension"
246
+ not:
247
+ type: object
248
+ additionalProperties: false
249
+ patternProperties:
250
+ "^x-":
251
+ "$ref": "#/definitions/vendorExtension"
252
+ responseValue:
253
+ oneOf:
254
+ - "$ref": "#/definitions/response"
255
+ - "$ref": "#/definitions/jsonReference"
256
+ response:
257
+ type: object
258
+ required:
259
+ - description
260
+ properties:
261
+ description:
262
+ type: string
263
+ schema:
264
+ oneOf:
265
+ - "$ref": "#/definitions/schema"
266
+ - "$ref": "#/definitions/fileSchema"
267
+ headers:
268
+ "$ref": "#/definitions/headers"
269
+ examples:
270
+ "$ref": "#/definitions/examples"
271
+ additionalProperties: false
272
+ patternProperties:
273
+ "^x-":
274
+ "$ref": "#/definitions/vendorExtension"
275
+ headers:
276
+ type: object
277
+ additionalProperties:
278
+ "$ref": "#/definitions/header"
279
+ header:
280
+ type: object
281
+ additionalProperties: false
282
+ required:
283
+ - type
284
+ properties:
285
+ type:
286
+ type: string
287
+ enum:
288
+ - string
289
+ - number
290
+ - integer
291
+ - boolean
292
+ - array
293
+ format:
294
+ type: string
295
+ items:
296
+ "$ref": "#/definitions/primitivesItems"
297
+ collectionFormat:
298
+ "$ref": "#/definitions/collectionFormat"
299
+ default:
300
+ "$ref": "#/definitions/default"
301
+ maximum:
302
+ "$ref": "#/definitions/maximum"
303
+ exclusiveMaximum:
304
+ "$ref": "#/definitions/exclusiveMaximum"
305
+ minimum:
306
+ "$ref": "#/definitions/minimum"
307
+ exclusiveMinimum:
308
+ "$ref": "#/definitions/exclusiveMinimum"
309
+ maxLength:
310
+ "$ref": "#/definitions/maxLength"
311
+ minLength:
312
+ "$ref": "#/definitions/minLength"
313
+ pattern:
314
+ "$ref": "#/definitions/pattern"
315
+ maxItems:
316
+ "$ref": "#/definitions/maxItems"
317
+ minItems:
318
+ "$ref": "#/definitions/minItems"
319
+ uniqueItems:
320
+ "$ref": "#/definitions/uniqueItems"
321
+ enum:
322
+ "$ref": "#/definitions/enum"
323
+ multipleOf:
324
+ "$ref": "#/definitions/multipleOf"
325
+ description:
326
+ type: string
327
+ patternProperties:
328
+ "^x-":
329
+ "$ref": "#/definitions/vendorExtension"
330
+ vendorExtension:
331
+ description: Any property starting with x- is valid.
332
+ additionalProperties: true
333
+ additionalItems: true
334
+ bodyParameter:
335
+ type: object
336
+ required:
337
+ - name
338
+ - in
339
+ - schema
340
+ patternProperties:
341
+ "^x-":
342
+ "$ref": "#/definitions/vendorExtension"
343
+ properties:
344
+ description:
345
+ type: string
346
+ description: A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
347
+ name:
348
+ type: string
349
+ description: The name of the parameter.
350
+ in:
351
+ type: string
352
+ description: Determines the location of the parameter.
353
+ enum:
354
+ - body
355
+ required:
356
+ type: boolean
357
+ description: Determines whether or not this parameter is required or optional.
358
+ default: false
359
+ schema:
360
+ "$ref": "#/definitions/schema"
361
+ additionalProperties: false
362
+ headerParameterSubSchema:
363
+ additionalProperties: false
364
+ patternProperties:
365
+ "^x-":
366
+ "$ref": "#/definitions/vendorExtension"
367
+ properties:
368
+ required:
369
+ type: boolean
370
+ description: Determines whether or not this parameter is required or optional.
371
+ default: false
372
+ in:
373
+ type: string
374
+ description: Determines the location of the parameter.
375
+ enum:
376
+ - header
377
+ description:
378
+ type: string
379
+ description: A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
380
+ name:
381
+ type: string
382
+ description: The name of the parameter.
383
+ type:
384
+ type: string
385
+ enum:
386
+ - string
387
+ - number
388
+ - boolean
389
+ - integer
390
+ - array
391
+ format:
392
+ type: string
393
+ items:
394
+ "$ref": "#/definitions/primitivesItems"
395
+ collectionFormat:
396
+ "$ref": "#/definitions/collectionFormat"
397
+ default:
398
+ "$ref": "#/definitions/default"
399
+ maximum:
400
+ "$ref": "#/definitions/maximum"
401
+ exclusiveMaximum:
402
+ "$ref": "#/definitions/exclusiveMaximum"
403
+ minimum:
404
+ "$ref": "#/definitions/minimum"
405
+ exclusiveMinimum:
406
+ "$ref": "#/definitions/exclusiveMinimum"
407
+ maxLength:
408
+ "$ref": "#/definitions/maxLength"
409
+ minLength:
410
+ "$ref": "#/definitions/minLength"
411
+ pattern:
412
+ "$ref": "#/definitions/pattern"
413
+ maxItems:
414
+ "$ref": "#/definitions/maxItems"
415
+ minItems:
416
+ "$ref": "#/definitions/minItems"
417
+ uniqueItems:
418
+ "$ref": "#/definitions/uniqueItems"
419
+ enum:
420
+ "$ref": "#/definitions/enum"
421
+ multipleOf:
422
+ "$ref": "#/definitions/multipleOf"
423
+ queryParameterSubSchema:
424
+ additionalProperties: false
425
+ patternProperties:
426
+ "^x-":
427
+ "$ref": "#/definitions/vendorExtension"
428
+ properties:
429
+ required:
430
+ type: boolean
431
+ description: Determines whether or not this parameter is required or optional.
432
+ default: false
433
+ in:
434
+ type: string
435
+ description: Determines the location of the parameter.
436
+ enum:
437
+ - query
438
+ description:
439
+ type: string
440
+ description: A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
441
+ name:
442
+ type: string
443
+ description: The name of the parameter.
444
+ allowEmptyValue:
445
+ type: boolean
446
+ default: false
447
+ description: allows sending a parameter by name only or with an empty value.
448
+ type:
449
+ type: string
450
+ enum:
451
+ - string
452
+ - number
453
+ - boolean
454
+ - integer
455
+ - array
456
+ format:
457
+ type: string
458
+ items:
459
+ "$ref": "#/definitions/primitivesItems"
460
+ collectionFormat:
461
+ "$ref": "#/definitions/collectionFormatWithMulti"
462
+ default:
463
+ "$ref": "#/definitions/default"
464
+ maximum:
465
+ "$ref": "#/definitions/maximum"
466
+ exclusiveMaximum:
467
+ "$ref": "#/definitions/exclusiveMaximum"
468
+ minimum:
469
+ "$ref": "#/definitions/minimum"
470
+ exclusiveMinimum:
471
+ "$ref": "#/definitions/exclusiveMinimum"
472
+ maxLength:
473
+ "$ref": "#/definitions/maxLength"
474
+ minLength:
475
+ "$ref": "#/definitions/minLength"
476
+ pattern:
477
+ "$ref": "#/definitions/pattern"
478
+ maxItems:
479
+ "$ref": "#/definitions/maxItems"
480
+ minItems:
481
+ "$ref": "#/definitions/minItems"
482
+ uniqueItems:
483
+ "$ref": "#/definitions/uniqueItems"
484
+ enum:
485
+ "$ref": "#/definitions/enum"
486
+ multipleOf:
487
+ "$ref": "#/definitions/multipleOf"
488
+ formDataParameterSubSchema:
489
+ additionalProperties: false
490
+ patternProperties:
491
+ "^x-":
492
+ "$ref": "#/definitions/vendorExtension"
493
+ properties:
494
+ required:
495
+ type: boolean
496
+ description: Determines whether or not this parameter is required or optional.
497
+ default: false
498
+ in:
499
+ type: string
500
+ description: Determines the location of the parameter.
501
+ enum:
502
+ - formData
503
+ description:
504
+ type: string
505
+ description: A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
506
+ name:
507
+ type: string
508
+ description: The name of the parameter.
509
+ allowEmptyValue:
510
+ type: boolean
511
+ default: false
512
+ description: allows sending a parameter by name only or with an empty value.
513
+ type:
514
+ type: string
515
+ enum:
516
+ - string
517
+ - number
518
+ - boolean
519
+ - integer
520
+ - array
521
+ - file
522
+ format:
523
+ type: string
524
+ items:
525
+ "$ref": "#/definitions/primitivesItems"
526
+ collectionFormat:
527
+ "$ref": "#/definitions/collectionFormatWithMulti"
528
+ default:
529
+ "$ref": "#/definitions/default"
530
+ maximum:
531
+ "$ref": "#/definitions/maximum"
532
+ exclusiveMaximum:
533
+ "$ref": "#/definitions/exclusiveMaximum"
534
+ minimum:
535
+ "$ref": "#/definitions/minimum"
536
+ exclusiveMinimum:
537
+ "$ref": "#/definitions/exclusiveMinimum"
538
+ maxLength:
539
+ "$ref": "#/definitions/maxLength"
540
+ minLength:
541
+ "$ref": "#/definitions/minLength"
542
+ pattern:
543
+ "$ref": "#/definitions/pattern"
544
+ maxItems:
545
+ "$ref": "#/definitions/maxItems"
546
+ minItems:
547
+ "$ref": "#/definitions/minItems"
548
+ uniqueItems:
549
+ "$ref": "#/definitions/uniqueItems"
550
+ enum:
551
+ "$ref": "#/definitions/enum"
552
+ multipleOf:
553
+ "$ref": "#/definitions/multipleOf"
554
+ pathParameterSubSchema:
555
+ additionalProperties: false
556
+ patternProperties:
557
+ "^x-":
558
+ "$ref": "#/definitions/vendorExtension"
559
+ required:
560
+ - required
561
+ properties:
562
+ required:
563
+ type: boolean
564
+ enum:
565
+ - true
566
+ description: Determines whether or not this parameter is required or optional.
567
+ in:
568
+ type: string
569
+ description: Determines the location of the parameter.
570
+ enum:
571
+ - path
572
+ description:
573
+ type: string
574
+ description: A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
575
+ name:
576
+ type: string
577
+ description: The name of the parameter.
578
+ type:
579
+ type: string
580
+ enum:
581
+ - string
582
+ - number
583
+ - boolean
584
+ - integer
585
+ - array
586
+ format:
587
+ type: string
588
+ items:
589
+ "$ref": "#/definitions/primitivesItems"
590
+ collectionFormat:
591
+ "$ref": "#/definitions/collectionFormat"
592
+ default:
593
+ "$ref": "#/definitions/default"
594
+ maximum:
595
+ "$ref": "#/definitions/maximum"
596
+ exclusiveMaximum:
597
+ "$ref": "#/definitions/exclusiveMaximum"
598
+ minimum:
599
+ "$ref": "#/definitions/minimum"
600
+ exclusiveMinimum:
601
+ "$ref": "#/definitions/exclusiveMinimum"
602
+ maxLength:
603
+ "$ref": "#/definitions/maxLength"
604
+ minLength:
605
+ "$ref": "#/definitions/minLength"
606
+ pattern:
607
+ "$ref": "#/definitions/pattern"
608
+ maxItems:
609
+ "$ref": "#/definitions/maxItems"
610
+ minItems:
611
+ "$ref": "#/definitions/minItems"
612
+ uniqueItems:
613
+ "$ref": "#/definitions/uniqueItems"
614
+ enum:
615
+ "$ref": "#/definitions/enum"
616
+ multipleOf:
617
+ "$ref": "#/definitions/multipleOf"
618
+ nonBodyParameter:
619
+ type: object
620
+ required:
621
+ - name
622
+ - in
623
+ - type
624
+ oneOf:
625
+ - "$ref": "#/definitions/headerParameterSubSchema"
626
+ - "$ref": "#/definitions/formDataParameterSubSchema"
627
+ - "$ref": "#/definitions/queryParameterSubSchema"
628
+ - "$ref": "#/definitions/pathParameterSubSchema"
629
+ parameter:
630
+ oneOf:
631
+ - "$ref": "#/definitions/bodyParameter"
632
+ - "$ref": "#/definitions/nonBodyParameter"
633
+ schema:
634
+ type: object
635
+ description: A deterministic version of a JSON Schema object.
636
+ patternProperties:
637
+ "^x-":
638
+ "$ref": "#/definitions/vendorExtension"
639
+ properties:
640
+ "$ref":
641
+ type: string
642
+ format:
643
+ type: string
644
+ title:
645
+ "$ref": http://json-schema.org/draft-04/schema#/properties/title
646
+ description:
647
+ "$ref": http://json-schema.org/draft-04/schema#/properties/description
648
+ default:
649
+ "$ref": http://json-schema.org/draft-04/schema#/properties/default
650
+ multipleOf:
651
+ "$ref": http://json-schema.org/draft-04/schema#/properties/multipleOf
652
+ maximum:
653
+ "$ref": http://json-schema.org/draft-04/schema#/properties/maximum
654
+ exclusiveMaximum:
655
+ "$ref": http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum
656
+ minimum:
657
+ "$ref": http://json-schema.org/draft-04/schema#/properties/minimum
658
+ exclusiveMinimum:
659
+ "$ref": http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum
660
+ maxLength:
661
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveInteger
662
+ minLength:
663
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0
664
+ pattern:
665
+ "$ref": http://json-schema.org/draft-04/schema#/properties/pattern
666
+ maxItems:
667
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveInteger
668
+ minItems:
669
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0
670
+ uniqueItems:
671
+ "$ref": http://json-schema.org/draft-04/schema#/properties/uniqueItems
672
+ maxProperties:
673
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveInteger
674
+ minProperties:
675
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0
676
+ required:
677
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/stringArray
678
+ enum:
679
+ "$ref": http://json-schema.org/draft-04/schema#/properties/enum
680
+ additionalProperties:
681
+ anyOf:
682
+ - "$ref": "#/definitions/schema"
683
+ - type: boolean
684
+ default: {}
685
+ type:
686
+ "$ref": http://json-schema.org/draft-04/schema#/properties/type
687
+ items:
688
+ anyOf:
689
+ - "$ref": "#/definitions/schema"
690
+ - type: array
691
+ minItems: 1
692
+ items:
693
+ "$ref": "#/definitions/schema"
694
+ default: {}
695
+ allOf:
696
+ type: array
697
+ minItems: 1
698
+ items:
699
+ "$ref": "#/definitions/schema"
700
+ properties:
701
+ type: object
702
+ additionalProperties:
703
+ "$ref": "#/definitions/schema"
704
+ default: {}
705
+ discriminator:
706
+ type: string
707
+ readOnly:
708
+ type: boolean
709
+ default: false
710
+ xml:
711
+ "$ref": "#/definitions/xml"
712
+ externalDocs:
713
+ "$ref": "#/definitions/externalDocs"
714
+ example: {}
715
+ additionalProperties: false
716
+ fileSchema:
717
+ type: object
718
+ description: A deterministic version of a JSON Schema object.
719
+ patternProperties:
720
+ "^x-":
721
+ "$ref": "#/definitions/vendorExtension"
722
+ required:
723
+ - type
724
+ properties:
725
+ format:
726
+ type: string
727
+ title:
728
+ "$ref": http://json-schema.org/draft-04/schema#/properties/title
729
+ description:
730
+ "$ref": http://json-schema.org/draft-04/schema#/properties/description
731
+ default:
732
+ "$ref": http://json-schema.org/draft-04/schema#/properties/default
733
+ required:
734
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/stringArray
735
+ type:
736
+ type: string
737
+ enum:
738
+ - file
739
+ readOnly:
740
+ type: boolean
741
+ default: false
742
+ externalDocs:
743
+ "$ref": "#/definitions/externalDocs"
744
+ example: {}
745
+ additionalProperties: false
746
+ primitivesItems:
747
+ type: object
748
+ additionalProperties: false
749
+ properties:
750
+ type:
751
+ type: string
752
+ enum:
753
+ - string
754
+ - number
755
+ - integer
756
+ - boolean
757
+ - array
758
+ format:
759
+ type: string
760
+ items:
761
+ "$ref": "#/definitions/primitivesItems"
762
+ collectionFormat:
763
+ "$ref": "#/definitions/collectionFormat"
764
+ default:
765
+ "$ref": "#/definitions/default"
766
+ maximum:
767
+ "$ref": "#/definitions/maximum"
768
+ exclusiveMaximum:
769
+ "$ref": "#/definitions/exclusiveMaximum"
770
+ minimum:
771
+ "$ref": "#/definitions/minimum"
772
+ exclusiveMinimum:
773
+ "$ref": "#/definitions/exclusiveMinimum"
774
+ maxLength:
775
+ "$ref": "#/definitions/maxLength"
776
+ minLength:
777
+ "$ref": "#/definitions/minLength"
778
+ pattern:
779
+ "$ref": "#/definitions/pattern"
780
+ maxItems:
781
+ "$ref": "#/definitions/maxItems"
782
+ minItems:
783
+ "$ref": "#/definitions/minItems"
784
+ uniqueItems:
785
+ "$ref": "#/definitions/uniqueItems"
786
+ enum:
787
+ "$ref": "#/definitions/enum"
788
+ multipleOf:
789
+ "$ref": "#/definitions/multipleOf"
790
+ patternProperties:
791
+ "^x-":
792
+ "$ref": "#/definitions/vendorExtension"
793
+ security:
794
+ type: array
795
+ items:
796
+ "$ref": "#/definitions/securityRequirement"
797
+ uniqueItems: true
798
+ securityRequirement:
799
+ type: object
800
+ additionalProperties:
801
+ type: array
802
+ items:
803
+ type: string
804
+ uniqueItems: true
805
+ xml:
806
+ type: object
807
+ additionalProperties: false
808
+ properties:
809
+ name:
810
+ type: string
811
+ namespace:
812
+ type: string
813
+ prefix:
814
+ type: string
815
+ attribute:
816
+ type: boolean
817
+ default: false
818
+ wrapped:
819
+ type: boolean
820
+ default: false
821
+ patternProperties:
822
+ "^x-":
823
+ "$ref": "#/definitions/vendorExtension"
824
+ tag:
825
+ type: object
826
+ additionalProperties: false
827
+ required:
828
+ - name
829
+ properties:
830
+ name:
831
+ type: string
832
+ description:
833
+ type: string
834
+ externalDocs:
835
+ "$ref": "#/definitions/externalDocs"
836
+ patternProperties:
837
+ "^x-":
838
+ "$ref": "#/definitions/vendorExtension"
839
+ securityDefinitions:
840
+ type: object
841
+ additionalProperties:
842
+ oneOf:
843
+ - "$ref": "#/definitions/basicAuthenticationSecurity"
844
+ - "$ref": "#/definitions/apiKeySecurity"
845
+ - "$ref": "#/definitions/oauth2ImplicitSecurity"
846
+ - "$ref": "#/definitions/oauth2PasswordSecurity"
847
+ - "$ref": "#/definitions/oauth2ApplicationSecurity"
848
+ - "$ref": "#/definitions/oauth2AccessCodeSecurity"
849
+ basicAuthenticationSecurity:
850
+ type: object
851
+ additionalProperties: false
852
+ required:
853
+ - type
854
+ properties:
855
+ type:
856
+ type: string
857
+ enum:
858
+ - basic
859
+ description:
860
+ type: string
861
+ patternProperties:
862
+ "^x-":
863
+ "$ref": "#/definitions/vendorExtension"
864
+ apiKeySecurity:
865
+ type: object
866
+ additionalProperties: false
867
+ required:
868
+ - type
869
+ - name
870
+ - in
871
+ properties:
872
+ type:
873
+ type: string
874
+ enum:
875
+ - apiKey
876
+ name:
877
+ type: string
878
+ in:
879
+ type: string
880
+ enum:
881
+ - header
882
+ - query
883
+ description:
884
+ type: string
885
+ patternProperties:
886
+ "^x-":
887
+ "$ref": "#/definitions/vendorExtension"
888
+ oauth2ImplicitSecurity:
889
+ type: object
890
+ additionalProperties: false
891
+ required:
892
+ - type
893
+ - flow
894
+ - authorizationUrl
895
+ properties:
896
+ type:
897
+ type: string
898
+ enum:
899
+ - oauth2
900
+ flow:
901
+ type: string
902
+ enum:
903
+ - implicit
904
+ scopes:
905
+ "$ref": "#/definitions/oauth2Scopes"
906
+ authorizationUrl:
907
+ type: string
908
+ format: uri
909
+ description:
910
+ type: string
911
+ patternProperties:
912
+ "^x-":
913
+ "$ref": "#/definitions/vendorExtension"
914
+ oauth2PasswordSecurity:
915
+ type: object
916
+ additionalProperties: false
917
+ required:
918
+ - type
919
+ - flow
920
+ - tokenUrl
921
+ properties:
922
+ type:
923
+ type: string
924
+ enum:
925
+ - oauth2
926
+ flow:
927
+ type: string
928
+ enum:
929
+ - password
930
+ scopes:
931
+ "$ref": "#/definitions/oauth2Scopes"
932
+ tokenUrl:
933
+ type: string
934
+ format: uri
935
+ description:
936
+ type: string
937
+ patternProperties:
938
+ "^x-":
939
+ "$ref": "#/definitions/vendorExtension"
940
+ oauth2ApplicationSecurity:
941
+ type: object
942
+ additionalProperties: false
943
+ required:
944
+ - type
945
+ - flow
946
+ - tokenUrl
947
+ properties:
948
+ type:
949
+ type: string
950
+ enum:
951
+ - oauth2
952
+ flow:
953
+ type: string
954
+ enum:
955
+ - application
956
+ scopes:
957
+ "$ref": "#/definitions/oauth2Scopes"
958
+ tokenUrl:
959
+ type: string
960
+ format: uri
961
+ description:
962
+ type: string
963
+ patternProperties:
964
+ "^x-":
965
+ "$ref": "#/definitions/vendorExtension"
966
+ oauth2AccessCodeSecurity:
967
+ type: object
968
+ additionalProperties: false
969
+ required:
970
+ - type
971
+ - flow
972
+ - authorizationUrl
973
+ - tokenUrl
974
+ properties:
975
+ type:
976
+ type: string
977
+ enum:
978
+ - oauth2
979
+ flow:
980
+ type: string
981
+ enum:
982
+ - accessCode
983
+ scopes:
984
+ "$ref": "#/definitions/oauth2Scopes"
985
+ authorizationUrl:
986
+ type: string
987
+ format: uri
988
+ tokenUrl:
989
+ type: string
990
+ format: uri
991
+ description:
992
+ type: string
993
+ patternProperties:
994
+ "^x-":
995
+ "$ref": "#/definitions/vendorExtension"
996
+ oauth2Scopes:
997
+ type: object
998
+ additionalProperties:
999
+ type: string
1000
+ mediaTypeList:
1001
+ type: array
1002
+ items:
1003
+ "$ref": "#/definitions/mimeType"
1004
+ uniqueItems: true
1005
+ parametersList:
1006
+ type: array
1007
+ description: The parameters needed to send a valid API call.
1008
+ additionalItems: false
1009
+ items:
1010
+ oneOf:
1011
+ - "$ref": "#/definitions/parameter"
1012
+ - "$ref": "#/definitions/jsonReference"
1013
+ uniqueItems: true
1014
+ schemesList:
1015
+ type: array
1016
+ description: The transfer protocol of the API.
1017
+ items:
1018
+ type: string
1019
+ enum:
1020
+ - http
1021
+ - https
1022
+ - ws
1023
+ - wss
1024
+ uniqueItems: true
1025
+ collectionFormat:
1026
+ type: string
1027
+ enum:
1028
+ - csv
1029
+ - ssv
1030
+ - tsv
1031
+ - pipes
1032
+ default: csv
1033
+ collectionFormatWithMulti:
1034
+ type: string
1035
+ enum:
1036
+ - csv
1037
+ - ssv
1038
+ - tsv
1039
+ - pipes
1040
+ - multi
1041
+ default: csv
1042
+ title:
1043
+ "$ref": http://json-schema.org/draft-04/schema#/properties/title
1044
+ description:
1045
+ "$ref": http://json-schema.org/draft-04/schema#/properties/description
1046
+ default:
1047
+ "$ref": http://json-schema.org/draft-04/schema#/properties/default
1048
+ multipleOf:
1049
+ "$ref": http://json-schema.org/draft-04/schema#/properties/multipleOf
1050
+ maximum:
1051
+ "$ref": http://json-schema.org/draft-04/schema#/properties/maximum
1052
+ exclusiveMaximum:
1053
+ "$ref": http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum
1054
+ minimum:
1055
+ "$ref": http://json-schema.org/draft-04/schema#/properties/minimum
1056
+ exclusiveMinimum:
1057
+ "$ref": http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum
1058
+ maxLength:
1059
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveInteger
1060
+ minLength:
1061
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0
1062
+ pattern:
1063
+ "$ref": http://json-schema.org/draft-04/schema#/properties/pattern
1064
+ maxItems:
1065
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveInteger
1066
+ minItems:
1067
+ "$ref": http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0
1068
+ uniqueItems:
1069
+ "$ref": http://json-schema.org/draft-04/schema#/properties/uniqueItems
1070
+ enum:
1071
+ "$ref": http://json-schema.org/draft-04/schema#/properties/enum
1072
+ jsonReference:
1073
+ type: object
1074
+ required:
1075
+ - "$ref"
1076
+ additionalProperties: false
1077
+ properties:
1078
+ "$ref":
1079
+ type: string