Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1037 lines (1036 loc) · 25.7 KB
/
Copy pathopenapi.yaml
File metadata and controls
1037 lines (1036 loc) · 25.7 KB
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
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
contact:
email: team@openapitools.org
description: Echo Server API
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: Echo Server API
version: 0.1.0
servers:
- url: http://localhost:3000/
paths:
/path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}:
get:
description: Test path parameter(s)
operationId: "tests/path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}"
parameters:
- explode: false
in: path
name: path_string
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: path_integer
required: true
schema:
type: integer
style: simple
- explode: false
in: path
name: enum_nonref_string_path
required: true
schema:
enum:
- success
- failure
- unclassified
type: string
style: simple
- explode: false
in: path
name: enum_ref_string_path
required: true
schema:
$ref: "#/components/schemas/StringEnumRef"
style: simple
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test path parameter(s)
tags:
- path
x-accepts:
- text/plain
/form/integer/boolean/string:
post:
description: Test form parameter(s)
operationId: test/form/integer/boolean/string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/test_form_integer_boolean_string_request"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test form parameter(s)
tags:
- form
x-content-type: application/x-www-form-urlencoded
x-accepts:
- text/plain
/form/oneof:
post:
description: Test form parameter(s) for oneOf schema
operationId: test/form/oneof
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: "#/components/schemas/test_form_oneof_request"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test form parameter(s) for oneOf schema
tags:
- form
x-content-type: application/x-www-form-urlencoded
x-accepts:
- text/plain
/form/object/multipart:
post:
description: Test form parameter(s) for multipart schema
operationId: test/form/object/multipart
requestBody:
content:
multipart/form-data:
schema:
$ref: "#/components/schemas/test_form_object_multipart_request"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test form parameter(s) for multipart schema
tags:
- form
x-content-type: multipart/form-data
x-accepts:
- text/plain
/header/integer/boolean/string/enums:
get:
description: Test header parameter(s)
operationId: test/header/integer/boolean/string/enums
parameters:
- explode: true
in: header
name: integer_header
required: false
schema:
type: integer
style: form
- explode: true
in: header
name: boolean_header
required: false
schema:
type: boolean
style: form
- explode: true
in: header
name: string_header
required: false
schema:
type: string
style: form
- explode: true
in: header
name: enum_nonref_string_header
required: false
schema:
enum:
- success
- failure
- unclassified
type: string
style: form
- explode: true
in: header
name: enum_ref_string_header
required: false
schema:
$ref: "#/components/schemas/StringEnumRef"
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test header parameter(s)
tags:
- header
x-accepts:
- text/plain
/query/enum_ref_string:
get:
description: Test query parameter(s)
operationId: test/enum_ref_string
parameters:
- explode: true
in: query
name: enum_nonref_string_query
required: false
schema:
enum:
- success
- failure
- unclassified
type: string
style: form
- explode: true
in: query
name: enum_ref_string_query
required: false
schema:
$ref: "#/components/schemas/StringEnumRef"
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/datetime/date/string:
get:
description: Test query parameter(s)
operationId: test/query/datetime/date/string
parameters:
- explode: true
in: query
name: datetime_query
required: false
schema:
format: date-time
type: string
style: form
- explode: true
in: query
name: date_query
required: false
schema:
format: date
type: string
style: form
- explode: true
in: query
name: string_query
required: false
schema:
type: string
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/integer/boolean/string:
get:
description: Test query parameter(s)
operationId: test/query/integer/boolean/string
parameters:
- explode: true
in: query
name: integer_query
required: false
schema:
type: integer
style: form
- explode: true
in: query
name: boolean_query
required: false
schema:
type: boolean
style: form
- explode: true
in: query
name: string_query
required: false
schema:
type: string
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_form/explode_true/array_string:
get:
description: Test query parameter(s)
operationId: test/query/style_form/explode_true/array_string
parameters:
- explode: true
in: query
name: query_object
required: false
schema:
$ref: "#/components/schemas/test_query_style_form_explode_true_array_string_query_object_parameter"
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_form/explode_false/array_integer:
get:
description: Test query parameter(s)
operationId: test/query/style_form/explode_false/array_integer
parameters:
- explode: false
in: query
name: query_object
required: false
schema:
items:
type: integer
type: array
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_form/explode_false/array_string:
get:
description: Test query parameter(s)
operationId: test/query/style_form/explode_false/array_string
parameters:
- explode: false
in: query
name: query_object
required: false
schema:
items:
type: string
type: array
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_form/explode_true/object:
get:
description: Test query parameter(s)
operationId: test/query/style_form/explode_true/object
parameters:
- explode: true
in: query
name: query_object
required: false
schema:
$ref: "#/components/schemas/Pet"
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_form/explode_true/object/allOf:
get:
description: Test query parameter(s)
operationId: test/query/style_form/explode_true/object/allOf
parameters:
- explode: true
in: query
name: query_object
required: false
schema:
$ref: "#/components/schemas/DataQuery"
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_deepObject/explode_true/object:
get:
description: Test query parameter(s)
operationId: test/query/style_deepObject/explode_true/object
parameters:
- explode: true
in: query
name: query_object
required: false
schema:
$ref: "#/components/schemas/Pet"
style: deepObject
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_deepObject/explode_true/object/allOf:
get:
description: Test query parameter(s)
operationId: test/query/style_deepObject/explode_true/object/allOf
parameters:
- explode: true
in: query
name: query_object
required: false
schema:
$ref: "#/components/schemas/test_query_style_deepObject_explode_true_object_allOf_query_object_parameter"
style: deepObject
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/query/style_jsonSerialization/object:
get:
description: Test query parameter(s)
operationId: test/query/style_jsonSerialization/object
parameters:
- content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
in: query
name: json_serialized_object_ref_string_query
required: false
- content:
application/json:
schema:
items:
$ref: "#/components/schemas/Pet"
type: array
in: query
name: json_serialized_object_array_ref_string_query
required: false
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test query parameter(s)
tags:
- query
x-accepts:
- text/plain
/body/application/octetstream/binary:
post:
description: Test body parameter(s)
operationId: test/body/application/octetstream/binary
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test body parameter(s)
tags:
- body
x-content-type: application/octet-stream
x-accepts:
- text/plain
/echo/body/Pet:
post:
description: Test body parameter(s)
operationId: test/echo/body/Pet
requestBody:
$ref: "#/components/requestBodies/Pet"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
description: Successful operation
summary: Test body parameter(s)
tags:
- body
x-content-type: application/json
x-accepts:
- application/json
/echo/body/allOf/Pet:
post:
description: Test body parameter(s)
operationId: test/echo/body/allOf/Pet
requestBody:
$ref: "#/components/requestBodies/AllOfPet"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
description: Successful operation
summary: Test body parameter(s)
tags:
- body
x-content-type: application/json
x-accepts:
- application/json
/echo/body/Pet/response_string:
post:
description: Test empty response body
operationId: test/echo/body/Pet/response_string
requestBody:
$ref: "#/components/requestBodies/Pet"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test empty response body
tags:
- body
x-content-type: application/json
x-accepts:
- text/plain
/echo/body/Tag/response_string:
post:
description: Test empty json (request body)
operationId: test/echo/body/Tag/response_string
requestBody:
$ref: "#/components/requestBodies/Tag"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test empty json (request body)
tags:
- body
x-content-type: application/json
x-accepts:
- text/plain
/echo/body/FreeFormObject/response_string:
post:
description: Test free form object
operationId: test/echo/body/FreeFormObject/response_string
requestBody:
content:
application/json:
schema:
type: object
description: Free form object
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test free form object
tags:
- body
x-content-type: application/json
x-accepts:
- text/plain
/echo/body/string_enum:
post:
description: Test string enum response body
operationId: test/echo/body/string_enum
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/StringEnumRef"
description: String enum
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/StringEnumRef"
description: Successful operation
summary: Test string enum response body
tags:
- body
x-content-type: application/json
x-accepts:
- application/json
/binary/gif:
post:
description: Test binary (gif) response body
operationId: test/binary/gif
responses:
"200":
content:
image/gif:
schema:
format: binary
type: string
description: Successful operation
summary: Test binary (gif) response body
tags:
- body
x-accepts:
- image/gif
/body/application/octetstream/single_binary:
post:
description: Test single binary in multipart mime
operationId: test/body/multipart/formdata/single_binary
requestBody:
content:
multipart/form-data:
schema:
$ref: "#/components/schemas/test_body_multipart_formdata_single_binary_request"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test single binary in multipart mime
tags:
- body
x-content-type: multipart/form-data
x-accepts:
- text/plain
/body/application/octetstream/array_of_binary:
post:
description: Test array of binary in multipart mime
operationId: test/body/multipart/formdata/array_of_binary
requestBody:
content:
multipart/form-data:
schema:
$ref: "#/components/schemas/test_body_multipart_formdata_array_of_binary_request"
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
summary: Test array of binary in multipart mime
tags:
- body
x-content-type: multipart/form-data
x-accepts:
- text/plain
/auth/http/basic:
post:
description: To test HTTP basic authentication
operationId: test/auth/http/basic
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
security:
- http_auth: []
summary: To test HTTP basic authentication
tags:
- auth
x-accepts:
- text/plain
/auth/http/bearer:
post:
description: To test HTTP bearer authentication
operationId: test/auth/http/bearer
responses:
"200":
content:
text/plain:
schema:
type: string
description: Successful operation
security:
- http_bearer_auth: []
summary: To test HTTP bearer authentication
tags:
- auth
x-accepts:
- text/plain
components:
requestBodies:
Pet:
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
description: Pet object that needs to be added to the store
AllOfPet:
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Pet"
description: Pet object that needs to be added to the store
Tag:
content:
application/json:
schema:
$ref: "#/components/schemas/Tag"
description: Tag object
schemas:
Category:
example:
id: 1
name: Dogs
properties:
id:
example: 1
format: int64
type: integer
name:
example: Dogs
type: string
type: object
xml:
name: category
Tag:
example:
id: 0
name: name
properties:
id:
format: int64
type: integer
name:
type: string
type: object
xml:
name: tag
Pet:
example:
id: 10
name: doggie
category:
id: 1
name: Dogs
photoUrls:
- photoUrls
- photoUrls
tags:
- id: 0
name: name
- id: 0
name: name
status: available
properties:
id:
example: 10
format: int64
type: integer
name:
example: doggie
type: string
category:
$ref: "#/components/schemas/Category"
photoUrls:
items:
type: string
xml:
name: photoUrl
type: array
xml:
wrapped: true
tags:
items:
$ref: "#/components/schemas/Tag"
type: array
xml:
wrapped: true
status:
description: pet status in the store
enum:
- available
- pending
- sold
type: string
required:
- name
- photoUrls
type: object
xml:
name: pet
StringEnumRef:
enum:
- success
- failure
- unclassified
type: string
DefaultValue:
description: to test the default value of properties
properties:
array_string_enum_ref_default:
default:
- success
- failure
items:
$ref: "#/components/schemas/StringEnumRef"
type: array
array_string_enum_default:
default:
- success
- failure
items:
enum:
- success
- failure
- unclassified
type: string
type: array
array_string_default:
default:
- failure
- skipped
items:
type: string
type: array
array_integer_default:
default:
- 1
- 3
items:
type: integer
type: array
array_string:
items:
type: string
type: array
array_string_nullable:
items:
type: string
nullable: true
type: array
array_string_extension_nullable:
items:
type: string
type: array
x-nullable: true
string_nullable:
nullable: true
type: string
type: object
Bird:
properties:
size:
type: string
color:
type: string
type: object
Query:
properties:
id:
description: Query
format: int64
type: integer
outcomes:
default:
- SUCCESS
- FAILURE
items:
enum:
- SUCCESS
- FAILURE
- SKIPPED
type: string
type: array
type: object
x-parent: true
DataQuery:
allOf:
- properties:
suffix:
description: test suffix
type: string
text:
description: Some text containing white spaces
example: Some text
type: string
date:
description: A date
format: date-time
type: string
type: object
- $ref: "#/components/schemas/Query"
NumberPropertiesOnly:
properties:
number:
type: number
float:
format: float
type: number
double:
format: double
maximum: 50.2
minimum: 0.8
type: number
type: object
test_form_integer_boolean_string_request:
properties:
integer_form:
type: integer
boolean_form:
type: boolean
string_form:
type: string
type: object
test_form_oneof_request_oneOf:
properties:
form1:
type: string
form2:
type: integer
type: object
test_form_oneof_request_oneOf_1:
properties:
form3:
type: string
form4:
type: boolean
type: object
test_form_oneof_request:
oneOf:
- $ref: "#/components/schemas/test_form_oneof_request_oneOf"
- $ref: "#/components/schemas/test_form_oneof_request_oneOf_1"
- $ref: "#/components/schemas/Tag"
type: object
test_form_object_multipart_request_marker:
properties:
name:
type: string
type: object
test_form_object_multipart_request:
properties:
marker:
$ref: "#/components/schemas/test_form_object_multipart_request_marker"
required: