fork of hey-api/openapi-ts because I need some additional things
at main 2649 lines 74 kB view raw
1openapi: 3.1.0 2info: 3 title: swagger 4 version: v1.0 5servers: 6 - url: http://localhost:3000/base 7paths: 8 /api/v{api-version}/no+tag: 9 tags: [] 10 get: 11 operationId: export 12 patch: 13 responses: 14 default: 15 description: OK 16 post: 17 operationId: import 18 requestBody: 19 required: true 20 content: 21 application/json: 22 schema: 23 type: object 24 oneOf: 25 - $ref: '#/components/schemas/ModelWithReadOnlyAndWriteOnly' 26 - $ref: '#/components/schemas/ModelWithArrayReadOnlyAndWriteOnly' 27 responses: 28 '200': 29 description: Success 30 content: 31 application/json; type=collection: 32 schema: 33 $ref: '#/components/schemas/Model-From.Zendesk' 34 default: 35 description: Default success response 36 content: 37 application/json: 38 schema: 39 $ref: '#/components/schemas/ModelWithReadOnlyAndWriteOnly' 40 put: 41 operationId: foo+Wow 42 responses: 43 default: 44 description: OK 45 /api/v{api-version}/simple/$count: 46 get: 47 tags: 48 - Simple 49 operationId: api/v{version}/ODataController/$count 50 responses: 51 '200': 52 description: Success 53 content: 54 application/json; type=collection: 55 schema: 56 $ref: '#/components/schemas/Model-From.Zendesk' 57 /api/v{api-version}/simple:operation: 58 get: 59 parameters: 60 - description: foo in method 61 in: path 62 name: foo_param 63 required: true 64 schema: 65 oneOf: 66 - type: string 67 - format: uuid 68 type: string 69 responses: 70 '200': 71 description: Response is a simple number 72 content: 73 application/json: 74 schema: 75 type: number 76 default: 77 description: Default error response 78 content: 79 application/json: 80 schema: 81 $ref: '#/components/schemas/ModelWithBoolean' 82 /api/v{api-version}/simple: 83 get: 84 tags: 85 - Simple 86 operationId: GetCallWithoutParametersAndResponse 87 put: 88 tags: 89 - Simple 90 operationId: PutCallWithoutParametersAndResponse 91 post: 92 tags: 93 - Simple 94 operationId: PostCallWithoutParametersAndResponse 95 delete: 96 tags: 97 - Simple 98 operationId: DeleteCallWithoutParametersAndResponse 99 options: 100 tags: 101 - Simple 102 operationId: OptionsCallWithoutParametersAndResponse 103 head: 104 tags: 105 - Simple 106 operationId: HeadCallWithoutParametersAndResponse 107 patch: 108 tags: 109 - Simple 110 operationId: PatchCallWithoutParametersAndResponse 111 /api/v{api-version}/foo/{foo_param}/bar/{BarParam}: 112 delete: 113 tags: 114 - Parameters 115 operationId: deleteFoo 116 parameters: 117 - description: foo in method 118 in: path 119 name: foo_param 120 required: true 121 schema: 122 type: string 123 - description: bar in method 124 in: path 125 name: BarParam 126 required: true 127 schema: 128 type: string 129 - description: Parameter with illegal characters 130 name: x-Foo-Bar 131 in: header 132 required: true 133 content: 134 application/json: 135 schema: 136 $ref: '#/components/schemas/ModelWithString' 137 parameters: 138 - description: foo in global parameters 139 in: path 140 name: foo_param 141 required: true 142 schema: 143 type: string 144 - description: bar in global parameters 145 in: path 146 name: BarParam 147 required: true 148 schema: 149 type: string 150 /api/v{api-version}/descriptions: 151 post: 152 tags: 153 - Descriptions 154 operationId: CallWithDescriptions 155 parameters: 156 - description: |- 157 Testing multiline comments in string: First line 158 Second line 159 160 Fourth line 161 name: parameterWithBreaks 162 in: query 163 schema: 164 type: string 165 - description: 'Testing backticks in string: `backticks` and ```multiple 166 backticks``` should work' 167 name: parameterWithBackticks 168 in: query 169 schema: 170 type: string 171 - description: 172 "Testing slashes in string: \\backwards\\\\\\ and /forwards/// 173 should work" 174 name: parameterWithSlashes 175 in: query 176 schema: 177 type: string 178 - description: 179 'Testing expression placeholders in string: ${expression} should 180 work' 181 name: parameterWithExpressionPlaceholders 182 in: query 183 schema: 184 type: string 185 - description: 186 'Testing quotes in string: ''single quote'''''' and "double 187 quotes""" should work' 188 name: parameterWithQuotes 189 in: query 190 schema: 191 type: string 192 - description: 193 'Testing reserved characters in string: /* inline */ and /** inline 194 **/ should work' 195 name: parameterWithReservedCharacters 196 in: query 197 schema: 198 type: string 199 /api/v{api-version}/parameters/deprecated: 200 post: 201 tags: 202 - Deprecated 203 deprecated: true 204 operationId: DeprecatedCall 205 parameters: 206 - deprecated: true 207 description: This parameter is deprecated 208 name: parameter 209 in: header 210 required: true 211 schema: 212 oneOf: 213 - $ref: '#/components/schemas/DeprecatedModel' 214 - type: 'null' 215 /api/v{api-version}/parameters/{parameterPath}: 216 post: 217 tags: 218 - Parameters 219 operationId: CallWithParameters 220 parameters: 221 - description: This is the parameter that goes into the header 222 name: parameterHeader 223 in: header 224 required: true 225 schema: 226 type: 227 - string 228 - 'null' 229 - required: false 230 schema: 231 $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo' 232 name: foo_ref_enum 233 in: query 234 - required: true 235 schema: 236 allOf: 237 - $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo' 238 name: foo_all_of_enum 239 in: query 240 - description: This is the parameter that goes into the query params 241 name: cursor 242 in: query 243 required: true 244 schema: 245 type: 246 - string 247 - 'null' 248 - description: This is the parameter that goes into the cookie 249 name: parameterCookie 250 in: cookie 251 required: true 252 schema: 253 type: 254 - string 255 - 'null' 256 - description: This is the parameter that goes into the path 257 name: parameterPath 258 in: path 259 required: true 260 schema: 261 type: 262 - string 263 - 'null' 264 - description: api-version should be required in standalone clients 265 name: api-version 266 in: path 267 required: true 268 schema: 269 type: 270 - string 271 - 'null' 272 requestBody: 273 description: This is the parameter that goes into the body 274 required: true 275 content: 276 application/json: 277 schema: 278 properties: {} 279 type: 280 - object 281 - 'null' 282 /api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}: 283 post: 284 tags: 285 - Parameters 286 operationId: CallWithWeirdParameterNames 287 parameters: 288 - description: This is the parameter that goes into the path 289 name: parameter.path.1 290 in: path 291 required: false 292 schema: 293 type: string 294 - description: This is the parameter that goes into the path 295 name: parameter-path-2 296 in: path 297 required: false 298 schema: 299 type: string 300 - description: This is the parameter that goes into the path 301 name: PARAMETER-PATH-3 302 in: path 303 required: false 304 schema: 305 type: string 306 - description: This is the parameter with a reserved keyword 307 name: default 308 in: query 309 required: false 310 schema: 311 type: string 312 - description: This is the parameter that goes into the request header 313 name: parameter.header 314 in: header 315 required: true 316 schema: 317 type: 318 - string 319 - 'null' 320 - description: This is the parameter that goes into the request query params 321 name: parameter-query 322 in: query 323 required: true 324 schema: 325 type: 326 - string 327 - 'null' 328 - description: This is the parameter that goes into the cookie 329 name: PARAMETER-COOKIE 330 in: cookie 331 required: true 332 schema: 333 type: 334 - string 335 - 'null' 336 - description: api-version should be required in standalone clients 337 name: api-version 338 in: path 339 required: true 340 schema: 341 type: 342 - string 343 - 'null' 344 requestBody: 345 description: This is the parameter that goes into the body 346 required: true 347 content: 348 application/json: 349 schema: 350 oneOf: 351 - $ref: '#/components/schemas/ModelWithString' 352 - type: 'null' 353 /api/v{api-version}/parameters: 354 get: 355 tags: 356 - Parameters 357 operationId: GetCallWithOptionalParam 358 parameters: 359 - description: This is an optional parameter 360 name: page 361 in: query 362 required: false 363 schema: 364 type: number 365 requestBody: 366 description: This is a required parameter 367 required: true 368 content: 369 application/json: 370 schema: 371 $ref: '#/components/schemas/ModelWithOneOfEnum' 372 post: 373 tags: 374 - Parameters 375 operationId: PostCallWithOptionalParam 376 parameters: 377 - description: This is a required parameter 378 name: parameter 379 in: query 380 required: true 381 schema: 382 $ref: '#/components/schemas/Pageable' 383 requestBody: 384 description: This is an optional parameter 385 required: false 386 content: 387 application/json: 388 schema: 389 properties: 390 offset: 391 required: true 392 type: 393 - number 394 - 'null' 395 type: object 396 responses: 397 '200': 398 description: Response is a simple number 399 content: 400 application/json: 401 schema: 402 type: number 403 '204': 404 description: Success 405 /api/v{api-version}/requestBody: 406 post: 407 tags: 408 - RequestBody 409 parameters: 410 - $ref: '#/components/parameters/SimpleParameter' 411 requestBody: 412 $ref: '#/components/requestBodies/SimpleRequestBody' 413 /api/v{api-version}/formData: 414 post: 415 tags: 416 - FormData 417 parameters: 418 - $ref: '#/components/parameters/SimpleParameter' 419 requestBody: 420 $ref: '#/components/requestBodies/SimpleFormData' 421 /api/v{api-version}/defaults: 422 get: 423 tags: 424 - Defaults 425 operationId: CallWithDefaultParameters 426 parameters: 427 - description: This is a simple string with default value 428 name: parameterString 429 in: query 430 schema: 431 default: Hello World! 432 type: 433 - string 434 - 'null' 435 - description: This is a simple number with default value 436 name: parameterNumber 437 in: query 438 schema: 439 default: 123 440 type: 441 - number 442 - 'null' 443 - description: This is a simple boolean with default value 444 name: parameterBoolean 445 in: query 446 schema: 447 default: true 448 type: 449 - boolean 450 - 'null' 451 - description: This is a simple enum with default value 452 name: parameterEnum 453 in: query 454 schema: 455 enum: 456 - Success 457 - Warning 458 - Error 459 default: 0 460 - description: This is a simple model with default value 461 name: parameterModel 462 in: query 463 schema: 464 oneOf: 465 - $ref: '#/components/schemas/ModelWithString' 466 default: 467 prop: Hello World! 468 - type: 'null' 469 post: 470 tags: 471 - Defaults 472 operationId: CallWithDefaultOptionalParameters 473 parameters: 474 - description: This is a simple string that is optional with default value 475 name: parameterString 476 in: query 477 required: false 478 schema: 479 type: string 480 default: Hello World! 481 - description: This is a simple number that is optional with default value 482 name: parameterNumber 483 in: query 484 required: false 485 schema: 486 type: number 487 default: 123 488 - description: This is a simple boolean that is optional with default value 489 name: parameterBoolean 490 in: query 491 required: false 492 schema: 493 type: boolean 494 default: true 495 - description: This is a simple enum that is optional with default value 496 name: parameterEnum 497 in: query 498 required: false 499 schema: 500 enum: 501 - Success 502 - Warning 503 - Error 504 default: 0 505 - description: This is a simple model that is optional with default value 506 name: parameterModel 507 in: query 508 required: false 509 schema: 510 $ref: '#/components/schemas/ModelWithString' 511 default: 512 prop: Hello World! 513 put: 514 tags: 515 - Defaults 516 operationId: CallToTestOrderOfParams 517 parameters: 518 - description: This is a optional string with default 519 name: parameterOptionalStringWithDefault 520 in: query 521 required: false 522 schema: 523 type: string 524 default: Hello World! 525 - description: This is a optional string with empty default 526 name: parameterOptionalStringWithEmptyDefault 527 in: query 528 required: false 529 schema: 530 type: string 531 default: '' 532 - description: This is a optional string with no default 533 name: parameterOptionalStringWithNoDefault 534 in: query 535 required: false 536 schema: 537 type: string 538 - description: This is a string with default 539 name: parameterStringWithDefault 540 in: query 541 required: true 542 schema: 543 type: string 544 default: Hello World! 545 - description: This is a string with empty default 546 name: parameterStringWithEmptyDefault 547 in: query 548 required: true 549 schema: 550 type: string 551 default: '' 552 - description: This is a string with no default 553 name: parameterStringWithNoDefault 554 in: query 555 required: true 556 schema: 557 type: string 558 - description: This is a string that can be null with no default 559 name: parameterStringNullableWithNoDefault 560 in: query 561 required: false 562 schema: 563 type: 564 - string 565 - 'null' 566 - description: This is a string that can be null with default 567 name: parameterStringNullableWithDefault 568 in: query 569 required: false 570 schema: 571 default: null 572 type: 573 - string 574 - 'null' 575 /api/v{api-version}/duplicate: 576 delete: 577 tags: 578 - Duplicate 579 - Duplicate 580 operationId: DuplicateName 581 get: 582 tags: 583 - Duplicate 584 operationId: DuplicateName2 585 post: 586 tags: 587 - Duplicate 588 operationId: DuplicateName3 589 put: 590 tags: 591 - Duplicate 592 operationId: DuplicateName4 593 /api/v{api-version}/no-content: 594 get: 595 tags: 596 - noContent 597 operationId: CallWithNoContentResponse 598 responses: 599 '204': 600 description: Success 601 /api/v{api-version}/multiple-tags/response-and-no-content: 602 get: 603 tags: 604 - Response 605 - NoContent 606 operationId: CallWithResponseAndNoContentResponse 607 responses: 608 '200': 609 description: Response is a simple number 610 content: 611 application/json: 612 schema: 613 type: number 614 '204': 615 description: Success 616 /api/v{api-version}/multiple-tags/a: 617 get: 618 tags: 619 - MultipleTags1 620 - MultipleTags2 621 operationId: DummyA 622 responses: 623 '200': 624 content: 625 application/json: 626 schema: 627 $ref: '#/components/schemas/400' 628 /api/v{api-version}/multiple-tags/b: 629 get: 630 tags: 631 - MultipleTags1 632 - MultipleTags2 633 - MultipleTags3 634 operationId: DummyB 635 responses: 636 '204': 637 description: Success 638 /api/v{api-version}/response: 639 get: 640 tags: 641 - Response 642 operationId: CallWithResponse 643 responses: 644 default: 645 content: 646 application/json: 647 schema: 648 $ref: '#/components/schemas/import' 649 post: 650 tags: 651 - Response 652 operationId: CallWithDuplicateResponses 653 responses: 654 '200': 655 description: Message for 200 response 656 content: 657 application/json: 658 schema: 659 allOf: 660 - $ref: '#/components/schemas/ModelWithBoolean' 661 - $ref: '#/components/schemas/ModelWithInteger' 662 '201': 663 description: Message for 201 response 664 content: 665 application/json: 666 schema: 667 $ref: '#/components/schemas/ModelWithString' 668 '202': 669 description: Message for 202 response 670 content: 671 application/json: 672 schema: 673 $ref: '#/components/schemas/ModelWithString' 674 '500': 675 description: Message for 500 error 676 content: 677 application/json: 678 schema: 679 $ref: '#/components/schemas/ModelWithStringError' 680 '501': 681 description: Message for 501 error 682 content: 683 application/json: 684 schema: 685 $ref: '#/components/schemas/ModelWithStringError' 686 '502': 687 description: Message for 502 error 688 content: 689 application/json: 690 schema: 691 $ref: '#/components/schemas/ModelWithStringError' 692 default: 693 description: Default error response 694 content: 695 application/json: 696 schema: 697 $ref: '#/components/schemas/ModelWithBoolean' 698 4XX: 699 description: Message for 4XX errors 700 content: 701 application/json: 702 schema: 703 $ref: '#/components/schemas/DictionaryWithArray' 704 put: 705 tags: 706 - Response 707 operationId: CallWithResponses 708 responses: 709 '200': 710 description: Message for 200 response 711 content: 712 application/json: 713 schema: 714 type: object 715 properties: 716 '@namespace.string': 717 type: string 718 readOnly: true 719 '@namespace.integer': 720 type: integer 721 readOnly: true 722 value: 723 type: array 724 items: 725 $ref: '#/components/schemas/ModelWithString' 726 readOnly: true 727 '201': 728 description: Message for 201 response 729 content: 730 application/json: 731 schema: 732 $ref: '#/components/schemas/ModelThatExtends' 733 '202': 734 description: Message for 202 response 735 content: 736 application/json: 737 schema: 738 $ref: '#/components/schemas/ModelThatExtendsExtends' 739 '500': 740 description: Message for 500 error 741 content: 742 application/json: 743 schema: 744 $ref: '#/components/schemas/ModelWithStringError' 745 '501': 746 description: Message for 501 error 747 content: 748 application/json: 749 schema: 750 $ref: '#/components/schemas/ModelWithStringError' 751 '502': 752 description: Message for 502 error 753 content: 754 application/json: 755 schema: 756 $ref: '#/components/schemas/ModelWithStringError' 757 default: 758 description: Message for default response 759 content: 760 application/json: 761 schema: 762 $ref: '#/components/schemas/ModelWithStringError' 763 /api/v{api-version}/collectionFormat: 764 get: 765 tags: 766 - CollectionFormat 767 operationId: CollectionFormat 768 parameters: 769 - description: This is an array parameter that is sent as csv format 770 (comma-separated values) 771 name: parameterArrayCSV 772 in: query 773 required: true 774 schema: 775 type: 776 - array 777 - 'null' 778 items: 779 type: string 780 collectionFormat: csv 781 - description: This is an array parameter that is sent as ssv format 782 (space-separated values) 783 name: parameterArraySSV 784 in: query 785 required: true 786 schema: 787 type: 788 - array 789 - 'null' 790 items: 791 type: string 792 collectionFormat: ssv 793 - description: This is an array parameter that is sent as tsv format 794 (tab-separated values) 795 name: parameterArrayTSV 796 in: query 797 required: true 798 schema: 799 type: 800 - array 801 - 'null' 802 items: 803 type: string 804 collectionFormat: tsv 805 - description: This is an array parameter that is sent as pipes format 806 (pipe-separated values) 807 name: parameterArrayPipes 808 in: query 809 required: true 810 schema: 811 type: 812 - array 813 - 'null' 814 items: 815 type: string 816 collectionFormat: pipes 817 - description: 818 This is an array parameter that is sent as multi format (multiple 819 parameter instances) 820 name: parameterArrayMulti 821 in: query 822 required: true 823 schema: 824 type: 825 - array 826 - 'null' 827 items: 828 type: string 829 collectionFormat: multi 830 /api/v{api-version}/types: 831 get: 832 tags: 833 - Types 834 operationId: Types 835 parameters: 836 - description: This is a number parameter 837 name: parameterNumber 838 in: query 839 required: true 840 schema: 841 type: number 842 default: 123 843 - description: This is a string parameter 844 name: parameterString 845 in: query 846 required: true 847 schema: 848 type: 849 - string 850 - 'null' 851 default: default 852 - description: This is a boolean parameter 853 name: parameterBoolean 854 in: query 855 required: true 856 schema: 857 type: 858 - boolean 859 - 'null' 860 default: true 861 - description: This is an object parameter 862 name: parameterObject 863 in: query 864 required: true 865 schema: 866 type: 867 - object 868 - 'null' 869 default: null 870 - description: This is an array parameter 871 name: parameterArray 872 in: query 873 required: true 874 schema: 875 type: 876 - array 877 - 'null' 878 items: 879 type: string 880 - description: This is a dictionary parameter 881 name: parameterDictionary 882 in: query 883 required: true 884 schema: 885 type: 886 - object 887 - 'null' 888 items: 889 type: string 890 - description: This is an enum parameter 891 name: parameterEnum 892 in: query 893 required: true 894 schema: 895 oneOf: 896 - enum: 897 - Success 898 - Warning 899 - Error 900 - type: 'null' 901 - description: This is a number parameter 902 name: id 903 in: path 904 schema: 905 type: integer 906 format: int32 907 responses: 908 '200': 909 description: Response is a simple number 910 content: 911 application/json: 912 schema: 913 type: number 914 '201': 915 description: Response is a simple string 916 content: 917 application/json: 918 schema: 919 type: string 920 '202': 921 description: Response is a simple boolean 922 content: 923 application/json: 924 schema: 925 type: boolean 926 '203': 927 description: Response is a simple object 928 content: 929 application/json: 930 schema: 931 type: object 932 /api/v{api-version}/upload: 933 post: 934 tags: 935 - Upload 936 operationId: UploadFile 937 parameters: 938 - description: api-version should be required in standalone clients 939 name: api-version 940 in: path 941 required: true 942 schema: 943 type: 944 - string 945 - 'null' 946 requestBody: 947 content: 948 application/x-www-form-urlencoded: 949 description: Supply a file reference for upload 950 schema: 951 format: binary 952 type: string 953 required: true 954 responses: 955 '200': 956 content: 957 application/json: 958 schema: 959 type: boolean 960 /api/v{api-version}/file/{id}: 961 get: 962 tags: 963 - FileResponse 964 operationId: FileResponse 965 parameters: 966 - name: id 967 in: path 968 required: true 969 schema: 970 type: string 971 - description: api-version should be required in standalone clients 972 name: api-version 973 in: path 974 required: true 975 schema: 976 type: string 977 responses: 978 '200': 979 description: Success 980 content: 981 audio/*: 982 schema: 983 format: binary 984 type: string 985 video/*: 986 schema: 987 format: binary 988 type: string 989 /api/v{api-version}/complex: 990 get: 991 tags: 992 - Complex 993 operationId: ComplexTypes 994 parameters: 995 - description: Parameter containing object 996 name: parameterObject 997 in: query 998 required: true 999 schema: 1000 type: object 1001 properties: 1002 first: 1003 type: object 1004 properties: 1005 second: 1006 type: object 1007 properties: 1008 third: 1009 type: string 1010 - description: Parameter containing reference 1011 name: parameterReference 1012 in: query 1013 required: true 1014 schema: 1015 $ref: '#/components/schemas/ModelWithString' 1016 responses: 1017 '200': 1018 description: Successful response 1019 content: 1020 application/json: 1021 schema: 1022 type: array 1023 items: 1024 $ref: '#/components/schemas/ModelWithString' 1025 '400': 1026 description: 400 `server` error 1027 '500': 1028 description: 500 server error 1029 /api/v{api-version}/multipart: 1030 post: 1031 tags: 1032 - multipart 1033 operationId: MultipartRequest 1034 requestBody: 1035 content: 1036 multipart/form-data: 1037 schema: 1038 type: object 1039 properties: 1040 content: 1041 type: string 1042 format: binary 1043 data: 1044 oneOf: 1045 - $ref: '#/components/schemas/ModelWithString' 1046 - type: 'null' 1047 encoding: 1048 content: 1049 style: form 1050 data: 1051 style: form 1052 get: 1053 tags: 1054 - multipart 1055 operationId: MultipartResponse 1056 responses: 1057 '200': 1058 description: OK 1059 content: 1060 multipart/mixed: 1061 schema: 1062 type: object 1063 properties: 1064 file: 1065 type: string 1066 format: binary 1067 metadata: 1068 type: object 1069 properties: 1070 foo: 1071 type: string 1072 bar: 1073 type: string 1074 /api/v{api-version}/complex/{id}: 1075 put: 1076 tags: 1077 - Complex 1078 operationId: ComplexParams 1079 parameters: 1080 - name: id 1081 in: path 1082 required: true 1083 schema: 1084 type: integer 1085 format: int32 1086 - description: api-version should be required in standalone clients 1087 name: api-version 1088 in: path 1089 required: true 1090 schema: 1091 type: string 1092 requestBody: 1093 content: 1094 application/json-patch+json: 1095 schema: 1096 required: 1097 - key 1098 - name 1099 - parameters 1100 - type 1101 type: object 1102 properties: 1103 key: 1104 maxLength: 64 1105 pattern: ^[a-zA-Z0-9_]*$ 1106 type: 1107 - string 1108 - 'null' 1109 readOnly: true 1110 name: 1111 maxLength: 255 1112 type: 1113 - string 1114 - 'null' 1115 enabled: 1116 type: boolean 1117 default: true 1118 type: 1119 enum: 1120 - Monkey 1121 - Horse 1122 - Bird 1123 type: string 1124 readOnly: true 1125 listOfModels: 1126 type: 1127 - array 1128 - 'null' 1129 items: 1130 $ref: '#/components/schemas/ModelWithString' 1131 listOfStrings: 1132 type: 1133 - array 1134 - 'null' 1135 items: 1136 type: string 1137 parameters: 1138 type: object 1139 oneOf: 1140 - $ref: '#/components/schemas/ModelWithString' 1141 - $ref: '#/components/schemas/ModelWithEnum' 1142 - $ref: '#/components/schemas/ModelWithArray' 1143 - $ref: '#/components/schemas/ModelWithDictionary' 1144 user: 1145 type: object 1146 properties: 1147 id: 1148 type: integer 1149 format: int32 1150 readOnly: true 1151 name: 1152 type: 1153 - string 1154 - 'null' 1155 readOnly: true 1156 readOnly: true 1157 responses: 1158 '200': 1159 description: Success 1160 content: 1161 application/json; type=collection: 1162 schema: 1163 $ref: '#/components/schemas/ModelWithString' 1164 /api/v{api-version}/header: 1165 post: 1166 tags: 1167 - Header 1168 operationId: CallWithResultFromHeader 1169 responses: 1170 '200': 1171 description: Successful response 1172 headers: 1173 operation-location: 1174 schema: 1175 type: string 1176 '400': 1177 description: 400 server error 1178 '500': 1179 description: 500 server error 1180 /api/v{api-version}/error: 1181 post: 1182 tags: 1183 - Error 1184 operationId: testErrorCode 1185 parameters: 1186 - description: Status code to return 1187 name: status 1188 in: query 1189 required: true 1190 schema: 1191 type: integer 1192 responses: 1193 '200': 1194 description: 'Custom message: Successful response' 1195 '500': 1196 description: 'Custom message: Internal Server Error' 1197 '501': 1198 description: 'Custom message: Not Implemented' 1199 '502': 1200 description: 'Custom message: Bad Gateway' 1201 '503': 1202 description: 'Custom message: Service Unavailable' 1203 /api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串: 1204 post: 1205 tags: 1206 - Non-Ascii-æøåÆØÅöôêÊ 1207 operationId: nonAsciiæøåÆØÅöôêÊ字符串 1208 parameters: 1209 - description: Dummy input param 1210 name: nonAsciiParamæøåÆØÅöôêÊ 1211 in: query 1212 required: true 1213 schema: 1214 type: integer 1215 responses: 1216 '200': 1217 description: Successful response 1218 content: 1219 application/json: 1220 schema: 1221 type: array 1222 items: 1223 $ref: '#/components/schemas/NonAsciiStringæøåÆØÅöôêÊ字符串' 1224 put: 1225 tags: 1226 - Non-Ascii-æøåÆØÅöôêÊ 1227 summary: Login User 1228 operationId: putWithFormUrlEncoded 1229 requestBody: 1230 content: 1231 application/x-www-form-urlencoded: 1232 schema: 1233 $ref: '#/components/schemas/ArrayWithStrings' 1234 required: true 1235components: 1236 requestBodies: 1237 SimpleRequestBody: 1238 x-body-name: foo 1239 description: A reusable request body 1240 required: false 1241 content: 1242 application/json: 1243 schema: 1244 $ref: '#/components/schemas/ModelWithString' 1245 SimpleFormData: 1246 description: A reusable request body 1247 required: false 1248 content: 1249 multipart/form-data: 1250 schema: 1251 $ref: '#/components/schemas/ModelWithString' 1252 parameters: 1253 SimpleParameter: 1254 description: This is a reusable parameter 1255 name: parameter 1256 in: query 1257 required: false 1258 schema: 1259 type: string 1260 x-Foo-Bar: 1261 description: Parameter with illegal characters 1262 name: x-Foo-Bar 1263 in: header 1264 required: true 1265 content: 1266 application/json: 1267 schema: 1268 $ref: '#/components/schemas/ModelWithString' 1269 schemas: 1270 ExternalRefA: 1271 description: External ref to shared model (A) 1272 $ref: './external-shared.json#/components/schemas/ExternalSharedModel' 1273 ExternalRefB: 1274 description: External ref to shared model (B) 1275 $ref: './external-shared.json#/components/schemas/ExternalSharedModel' 1276 '400': 1277 description: Model with number-only name 1278 type: string 1279 camelCaseCommentWithBreaks: 1280 description: |- 1281 Testing multiline comments in string: First line 1282 Second line 1283 1284 Fourth line 1285 type: integer 1286 CommentWithBreaks: 1287 description: |- 1288 Testing multiline comments in string: First line 1289 Second line 1290 1291 Fourth line 1292 type: integer 1293 CommentWithBackticks: 1294 description: 'Testing backticks in string: `backticks` and ```multiple 1295 backticks``` should work' 1296 type: integer 1297 CommentWithBackticksAndQuotes: 1298 description: 1299 'Testing backticks and quotes in string: `backticks`, ''quotes'', 1300 "double quotes" and ```multiple backticks``` should work' 1301 type: integer 1302 CommentWithSlashes: 1303 description: 1304 "Testing slashes in string: \\backwards\\\\\\ and /forwards/// 1305 should work" 1306 type: integer 1307 CommentWithExpressionPlaceholders: 1308 description: 'Testing expression placeholders in string: ${expression} should work' 1309 type: integer 1310 CommentWithQuotes: 1311 description: 'Testing quotes in string: ''single quote'''''' and "double 1312 quotes""" should work' 1313 type: integer 1314 CommentWithReservedCharacters: 1315 description: 1316 'Testing reserved characters in string: /* inline */ and /** inline 1317 **/ should work' 1318 type: integer 1319 SimpleInteger: 1320 description: This is a simple number 1321 type: integer 1322 SimpleBoolean: 1323 description: This is a simple boolean 1324 type: boolean 1325 SimpleString: 1326 description: This is a simple string 1327 type: string 1328 NonAsciiStringæøåÆØÅöôêÊ字符串: 1329 description: 1330 A string with non-ascii (unicode) characters valid in typescript 1331 identifiers (æøåÆØÅöÔèÈ字符串) 1332 type: string 1333 SimpleFile: 1334 description: This is a simple file 1335 format: binary 1336 type: string 1337 SimpleReference: 1338 description: This is a simple reference 1339 $ref: '#/components/schemas/ModelWithString' 1340 SimpleStringWithPattern: 1341 description: This is a simple string 1342 maxLength: 64 1343 pattern: ^[a-zA-Z0-9_]*$ 1344 type: 1345 - string 1346 - 'null' 1347 EnumWithStrings: 1348 description: This is a simple enum with strings 1349 enum: 1350 - Success 1351 - Warning 1352 - Error 1353 - "'Single Quote'" 1354 - '"Double Quotes"' 1355 - 'Non-ascii: øæåôöØÆÅÔÖ字符串' 1356 EnumWithReplacedCharacters: 1357 enum: 1358 - "'Single Quote'" 1359 - '"Double Quotes"' 1360 - øæåôöØÆÅÔÖ字符串 1361 - 3.1 1362 - '' 1363 type: string 1364 EnumWithNumbers: 1365 description: This is a simple enum with numbers 1366 enum: 1367 - 1 1368 - 2 1369 - 3 1370 - 1.1 1371 - 1.2 1372 - 1.3 1373 - 100 1374 - 200 1375 - 300 1376 - -100 1377 - -200 1378 - -300 1379 - -1.1 1380 - -1.2 1381 - -1.3 1382 default: 200 1383 EnumFromDescription: 1384 description: Success=1,Warning=2,Error=3 1385 type: number 1386 EnumWithExtensions: 1387 description: This is a simple enum with numbers 1388 enum: 1389 - 200 1390 - 400 1391 - 500 1392 x-enum-varnames: 1393 - CUSTOM_SUCCESS 1394 - CUSTOM_WARNING 1395 - CUSTOM_ERROR 1396 x-enum-descriptions: 1397 - Used when the status of something is successful 1398 - Used when the status of something has a warning 1399 - Used when the status of something has an error 1400 EnumWithXEnumNames: 1401 enum: 1402 - 0 1403 - 1 1404 - 2 1405 x-enumNames: 1406 - zero 1407 - one 1408 - two 1409 ArrayWithNumbers: 1410 description: This is a simple array with numbers 1411 type: array 1412 items: 1413 type: integer 1414 ArrayWithBooleans: 1415 description: This is a simple array with booleans 1416 type: array 1417 items: 1418 type: boolean 1419 ArrayWithStrings: 1420 description: This is a simple array with strings 1421 type: array 1422 items: 1423 type: string 1424 default: 1425 - test 1426 ArrayWithReferences: 1427 description: This is a simple array with references 1428 type: array 1429 items: 1430 $ref: '#/components/schemas/ModelWithString' 1431 ArrayWithArray: 1432 description: This is a simple array containing an array 1433 type: array 1434 items: 1435 type: array 1436 items: 1437 $ref: '#/components/schemas/ModelWithString' 1438 ArrayWithProperties: 1439 description: This is a simple array with properties 1440 type: array 1441 items: 1442 type: object 1443 properties: 1444 16x16: 1445 $ref: '#/components/schemas/camelCaseCommentWithBreaks' 1446 bar: 1447 type: string 1448 ArrayWithAnyOfProperties: 1449 description: This is a simple array with any of properties 1450 type: array 1451 items: 1452 anyOf: 1453 - type: object 1454 properties: 1455 foo: 1456 type: string 1457 default: test 1458 - type: object 1459 properties: 1460 bar: 1461 type: string 1462 AnyOfAnyAndNull: 1463 type: object 1464 properties: 1465 data: 1466 anyOf: 1467 - {} 1468 - type: 'null' 1469 AnyOfArrays: 1470 description: This is a simple array with any of properties 1471 type: object 1472 properties: 1473 results: 1474 items: 1475 anyOf: 1476 - type: object 1477 properties: 1478 foo: 1479 type: string 1480 - type: object 1481 properties: 1482 bar: 1483 type: string 1484 type: array 1485 DictionaryWithString: 1486 description: This is a string dictionary 1487 type: object 1488 additionalProperties: 1489 type: string 1490 DictionaryWithPropertiesAndAdditionalProperties: 1491 type: object 1492 properties: 1493 foo: 1494 type: number 1495 bar: 1496 type: boolean 1497 additionalProperties: 1498 type: string 1499 DictionaryWithReference: 1500 description: This is a string reference 1501 type: object 1502 additionalProperties: 1503 $ref: '#/components/schemas/ModelWithString' 1504 DictionaryWithArray: 1505 description: This is a complex dictionary 1506 type: object 1507 additionalProperties: 1508 type: array 1509 items: 1510 $ref: '#/components/schemas/ModelWithString' 1511 DictionaryWithDictionary: 1512 description: This is a string dictionary 1513 type: object 1514 additionalProperties: 1515 type: object 1516 additionalProperties: 1517 type: string 1518 DictionaryWithProperties: 1519 description: This is a complex dictionary 1520 type: object 1521 additionalProperties: 1522 type: object 1523 properties: 1524 foo: 1525 type: string 1526 bar: 1527 type: string 1528 ModelWithInteger: 1529 description: This is a model with one number property 1530 type: object 1531 properties: 1532 prop: 1533 description: This is a simple number property 1534 type: integer 1535 ModelWithBoolean: 1536 description: This is a model with one boolean property 1537 type: object 1538 properties: 1539 prop: 1540 description: This is a simple boolean property 1541 type: boolean 1542 ModelWithString: 1543 description: This is a model with one string property 1544 type: object 1545 properties: 1546 prop: 1547 description: This is a simple string property 1548 type: string 1549 ModelWithStringError: 1550 description: This is a model with one string property 1551 type: object 1552 properties: 1553 prop: 1554 description: This is a simple string property 1555 type: string 1556 Model-From.Zendesk: 1557 description: 1558 "`Comment` or `VoiceComment`. The JSON object for adding voice 1559 comments to tickets is different. See [Adding voice comments to 1560 tickets](/documentation/ticketing/managing-tickets/adding-voice-comment\ 1561 s-to-tickets)" 1562 type: string 1563 ModelWithNullableString: 1564 description: This is a model with one string property 1565 type: object 1566 required: 1567 - nullableRequiredProp1 1568 - nullableRequiredProp2 1569 properties: 1570 nullableProp1: 1571 description: This is a simple string property 1572 type: 1573 - string 1574 - 'null' 1575 nullableRequiredProp1: 1576 description: This is a simple string property 1577 type: 1578 - string 1579 - 'null' 1580 nullableProp2: 1581 description: This is a simple string property 1582 type: 1583 - string 1584 - 'null' 1585 nullableRequiredProp2: 1586 description: This is a simple string property 1587 type: 1588 - string 1589 - 'null' 1590 foo_bar-enum: 1591 description: This is a simple enum with strings 1592 enum: 1593 - Success 1594 - Warning 1595 - Error 1596 - ØÆÅ字符串 1597 ModelWithEnum: 1598 description: This is a model with one enum 1599 type: object 1600 properties: 1601 foo_bar-enum: 1602 description: This is a simple enum with strings 1603 enum: 1604 - Success 1605 - Warning 1606 - Error 1607 - ØÆÅ字符串 1608 statusCode: 1609 description: These are the HTTP error code enums 1610 enum: 1611 - '100' 1612 - 200 FOO 1613 - 300 FOO_BAR 1614 - 400 foo-bar 1615 - 500 foo.bar 1616 - 600 foo&bar 1617 bool: 1618 description: Simple boolean enum 1619 type: boolean 1620 enum: 1621 - true 1622 ModelWithEnumWithHyphen: 1623 description: This is a model with one enum with escaped name 1624 type: object 1625 properties: 1626 foo-bar-baz-qux: 1627 type: string 1628 enum: 1629 - '3.0' 1630 title: Foo-Bar-Baz-Qux 1631 default: '3.0' 1632 ModelWithEnumFromDescription: 1633 description: This is a model with one enum 1634 type: object 1635 properties: 1636 test: 1637 type: integer 1638 description: Success=1,Warning=2,Error=3 1639 ModelWithNestedEnums: 1640 description: This is a model with nested enums 1641 type: object 1642 properties: 1643 dictionaryWithEnum: 1644 type: object 1645 additionalProperties: 1646 enum: 1647 - Success 1648 - Warning 1649 - Error 1650 dictionaryWithEnumFromDescription: 1651 type: object 1652 additionalProperties: 1653 type: integer 1654 description: Success=1,Warning=2,Error=3 1655 arrayWithEnum: 1656 type: array 1657 items: 1658 enum: 1659 - Success 1660 - Warning 1661 - Error 1662 arrayWithDescription: 1663 type: array 1664 items: 1665 type: integer 1666 description: Success=1,Warning=2,Error=3 1667 foo_bar-enum: 1668 description: This is a simple enum with strings 1669 enum: 1670 - Success 1671 - Warning 1672 - Error 1673 - ØÆÅ字符串 1674 ModelWithReference: 1675 description: This is a model with one property containing a reference 1676 type: object 1677 properties: 1678 prop: 1679 $ref: '#/components/schemas/ModelWithProperties' 1680 ModelWithArrayReadOnlyAndWriteOnly: 1681 description: This is a model with one property containing an array 1682 type: object 1683 properties: 1684 prop: 1685 type: array 1686 items: 1687 $ref: '#/components/schemas/ModelWithReadOnlyAndWriteOnly' 1688 propWithFile: 1689 type: array 1690 items: 1691 format: binary 1692 type: string 1693 propWithNumber: 1694 type: array 1695 items: 1696 type: number 1697 ModelWithArray: 1698 description: This is a model with one property containing an array 1699 type: object 1700 properties: 1701 prop: 1702 type: array 1703 items: 1704 $ref: '#/components/schemas/ModelWithString' 1705 propWithFile: 1706 type: array 1707 items: 1708 format: binary 1709 type: string 1710 propWithNumber: 1711 type: array 1712 items: 1713 type: number 1714 ModelWithDictionary: 1715 description: This is a model with one property containing a dictionary 1716 type: object 1717 properties: 1718 prop: 1719 type: object 1720 additionalProperties: 1721 type: string 1722 DeprecatedModel: 1723 deprecated: true 1724 description: This is a deprecated model with a deprecated property 1725 type: object 1726 properties: 1727 prop: 1728 deprecated: true 1729 description: This is a deprecated property 1730 type: string 1731 ModelWithCircularReference: 1732 description: This is a model with one property containing a circular reference 1733 type: object 1734 properties: 1735 prop: 1736 $ref: '#/components/schemas/ModelWithCircularReference' 1737 CompositionWithOneOf: 1738 description: This is a model with one property with a 'one of' relationship 1739 type: object 1740 properties: 1741 propA: 1742 type: object 1743 oneOf: 1744 - $ref: '#/components/schemas/ModelWithString' 1745 - $ref: '#/components/schemas/ModelWithEnum' 1746 - $ref: '#/components/schemas/ModelWithArray' 1747 - $ref: '#/components/schemas/ModelWithDictionary' 1748 CompositionWithOneOfAnonymous: 1749 description: 1750 This is a model with one property with a 'one of' relationship 1751 where the options are not $ref 1752 type: object 1753 properties: 1754 propA: 1755 type: object 1756 oneOf: 1757 - description: Anonymous object type 1758 type: object 1759 properties: 1760 propA: 1761 type: string 1762 - description: Anonymous string type 1763 type: string 1764 - description: Anonymous integer type 1765 type: integer 1766 ModelCircle: 1767 description: Circle 1768 type: object 1769 required: 1770 - kind 1771 properties: 1772 kind: 1773 type: string 1774 radius: 1775 type: number 1776 ModelSquare: 1777 description: Square 1778 type: object 1779 required: 1780 - kind 1781 properties: 1782 kind: 1783 type: string 1784 sideLength: 1785 type: number 1786 CompositionWithOneOfDiscriminator: 1787 description: 1788 This is a model with one property with a 'one of' relationship 1789 where the options are not $ref 1790 type: object 1791 oneOf: 1792 - $ref: '#/components/schemas/ModelCircle' 1793 - $ref: '#/components/schemas/ModelSquare' 1794 discriminator: 1795 propertyName: kind 1796 mapping: 1797 circle: '#/components/schemas/ModelCircle' 1798 square: '#/components/schemas/ModelSquare' 1799 CompositionWithAnyOf: 1800 description: This is a model with one property with a 'any of' relationship 1801 type: object 1802 properties: 1803 propA: 1804 type: object 1805 anyOf: 1806 - $ref: '#/components/schemas/ModelWithString' 1807 - $ref: '#/components/schemas/ModelWithEnum' 1808 - $ref: '#/components/schemas/ModelWithArray' 1809 - $ref: '#/components/schemas/ModelWithDictionary' 1810 CompositionWithAnyOfAnonymous: 1811 description: 1812 This is a model with one property with a 'any of' relationship 1813 where the options are not $ref 1814 type: object 1815 properties: 1816 propA: 1817 type: object 1818 anyOf: 1819 - description: Anonymous object type 1820 type: object 1821 properties: 1822 propA: 1823 type: string 1824 - description: Anonymous string type 1825 type: string 1826 - description: Anonymous integer type 1827 type: integer 1828 CompositionWithNestedAnyAndTypeNull: 1829 description: This is a model with nested 'any of' property with a type null 1830 type: object 1831 properties: 1832 propA: 1833 type: object 1834 anyOf: 1835 - items: 1836 anyOf: 1837 - $ref: '#/components/schemas/ModelWithDictionary' 1838 - type: 'null' 1839 type: array 1840 - items: 1841 anyOf: 1842 - $ref: '#/components/schemas/ModelWithArray' 1843 - type: 'null' 1844 type: array 1845 3e-num_1Период: 1846 enum: 1847 - Bird 1848 - Dog 1849 type: string 1850 ConstValue: 1851 type: string 1852 const: ConstValue 1853 CompositionWithNestedAnyOfAndNull: 1854 description: 1855 This is a model with one property with a 'any of' relationship 1856 where the options are not $ref 1857 type: object 1858 properties: 1859 propA: 1860 anyOf: 1861 - items: 1862 anyOf: 1863 - $ref: '#/components/schemas/3e-num_1Период' 1864 - $ref: '#/components/schemas/ConstValue' 1865 type: array 1866 - type: 'null' 1867 title: Scopes 1868 CompositionWithOneOfAndNullable: 1869 description: This is a model with one property with a 'one of' relationship 1870 type: object 1871 properties: 1872 propA: 1873 type: 1874 - object 1875 - 'null' 1876 oneOf: 1877 - type: object 1878 properties: 1879 boolean: 1880 type: boolean 1881 - $ref: '#/components/schemas/ModelWithEnum' 1882 - $ref: '#/components/schemas/ModelWithArray' 1883 - $ref: '#/components/schemas/ModelWithDictionary' 1884 CompositionWithOneOfAndSimpleDictionary: 1885 description: This is a model that contains a simple dictionary within composition 1886 type: object 1887 properties: 1888 propA: 1889 oneOf: 1890 - type: boolean 1891 - type: object 1892 additionalProperties: 1893 type: number 1894 CompositionWithOneOfAndSimpleArrayDictionary: 1895 description: 1896 This is a model that contains a dictionary of simple arrays within 1897 composition 1898 type: object 1899 properties: 1900 propA: 1901 oneOf: 1902 - type: boolean 1903 - type: object 1904 additionalProperties: 1905 type: array 1906 items: 1907 type: boolean 1908 CompositionWithOneOfAndComplexArrayDictionary: 1909 description: This is a model that contains a dictionary of complex arrays 1910 (composited) within composition 1911 type: object 1912 properties: 1913 propA: 1914 oneOf: 1915 - type: boolean 1916 - type: object 1917 additionalProperties: 1918 type: array 1919 items: 1920 oneOf: 1921 - type: number 1922 - type: string 1923 CompositionWithAllOfAndNullable: 1924 description: This is a model with one property with a 'all of' relationship 1925 type: object 1926 properties: 1927 propA: 1928 type: 1929 - object 1930 - 'null' 1931 allOf: 1932 - type: object 1933 properties: 1934 boolean: 1935 type: boolean 1936 - $ref: '#/components/schemas/ModelWithEnum' 1937 - $ref: '#/components/schemas/ModelWithArray' 1938 - $ref: '#/components/schemas/ModelWithDictionary' 1939 CompositionWithAnyOfAndNullable: 1940 description: This is a model with one property with a 'any of' relationship 1941 type: object 1942 properties: 1943 propA: 1944 type: 1945 - object 1946 - 'null' 1947 anyOf: 1948 - type: object 1949 properties: 1950 boolean: 1951 type: boolean 1952 - $ref: '#/components/schemas/ModelWithEnum' 1953 - $ref: '#/components/schemas/ModelWithArray' 1954 - $ref: '#/components/schemas/ModelWithDictionary' 1955 CompositionBaseModel: 1956 description: This is a base model with two simple optional properties 1957 type: object 1958 properties: 1959 firstName: 1960 type: string 1961 lastname: 1962 type: string 1963 CompositionExtendedModel: 1964 description: This is a model that extends the base model 1965 type: object 1966 allOf: 1967 - $ref: '#/components/schemas/CompositionBaseModel' 1968 properties: 1969 age: 1970 type: number 1971 required: 1972 - firstName 1973 - lastname 1974 - age 1975 ModelWithProperties: 1976 description: This is a model with one nested property 1977 type: object 1978 required: 1979 - required 1980 - requiredAndReadOnly 1981 - requiredAndNullable 1982 properties: 1983 required: 1984 type: string 1985 requiredAndReadOnly: 1986 type: string 1987 readOnly: true 1988 requiredAndNullable: 1989 type: 1990 - string 1991 - 'null' 1992 string: 1993 type: string 1994 number: 1995 type: number 1996 boolean: 1997 type: boolean 1998 reference: 1999 $ref: '#/components/schemas/ModelWithString' 2000 property with space: 2001 type: string 2002 default: 2003 type: string 2004 try: 2005 type: string 2006 '@namespace.string': 2007 type: string 2008 readOnly: true 2009 '@namespace.integer': 2010 type: integer 2011 readOnly: true 2012 ModelWithNestedProperties: 2013 description: This is a model with one nested property 2014 type: object 2015 required: 2016 - first 2017 properties: 2018 first: 2019 type: 2020 - object 2021 - 'null' 2022 required: 2023 - second 2024 readOnly: true 2025 properties: 2026 second: 2027 type: 2028 - object 2029 - 'null' 2030 required: 2031 - third 2032 readOnly: true 2033 properties: 2034 third: 2035 type: 2036 - string 2037 - 'null' 2038 required: true 2039 readOnly: true 2040 ModelWithDuplicateProperties: 2041 description: This is a model with duplicated properties 2042 type: object 2043 properties: 2044 prop: 2045 $ref: '#/components/schemas/ModelWithString' 2046 ModelWithOrderedProperties: 2047 description: This is a model with ordered properties 2048 type: object 2049 properties: 2050 zebra: 2051 type: string 2052 apple: 2053 type: string 2054 hawaii: 2055 type: string 2056 ModelWithDuplicateImports: 2057 description: This is a model with duplicated imports 2058 type: object 2059 properties: 2060 propA: 2061 $ref: '#/components/schemas/ModelWithString' 2062 propB: 2063 $ref: '#/components/schemas/ModelWithString' 2064 propC: 2065 $ref: '#/components/schemas/ModelWithString' 2066 ModelThatExtends: 2067 description: This is a model that extends another model 2068 type: object 2069 allOf: 2070 - $ref: '#/components/schemas/ModelWithString' 2071 - type: object 2072 properties: 2073 propExtendsA: 2074 type: string 2075 propExtendsB: 2076 $ref: '#/components/schemas/ModelWithString' 2077 ModelThatExtendsExtends: 2078 description: This is a model that extends another model 2079 type: object 2080 allOf: 2081 - $ref: '#/components/schemas/ModelWithString' 2082 - $ref: '#/components/schemas/ModelThatExtends' 2083 - type: object 2084 properties: 2085 propExtendsC: 2086 type: string 2087 propExtendsD: 2088 $ref: '#/components/schemas/ModelWithString' 2089 ModelWithPattern: 2090 description: This is a model that contains a some patterns 2091 type: object 2092 required: 2093 - key 2094 - name 2095 properties: 2096 key: 2097 maxLength: 64 2098 pattern: ^[a-zA-Z0-9_]*$ 2099 type: string 2100 name: 2101 maxLength: 255 2102 type: string 2103 enabled: 2104 type: boolean 2105 readOnly: true 2106 modified: 2107 type: string 2108 format: date-time 2109 readOnly: true 2110 id: 2111 type: string 2112 pattern: ^\d{2}-\d{3}-\d{4}$ 2113 text: 2114 type: string 2115 pattern: ^\w+$ 2116 patternWithSingleQuotes: 2117 type: string 2118 pattern: ^[a-zA-Z0-9']*$ 2119 patternWithNewline: 2120 type: string 2121 pattern: aaa\nbbb 2122 patternWithBacktick: 2123 type: string 2124 pattern: aaa`bbb 2125 File: 2126 required: 2127 - mime 2128 type: object 2129 properties: 2130 id: 2131 title: Id 2132 type: string 2133 readOnly: true 2134 minLength: 1 2135 updated_at: 2136 title: Updated at 2137 type: string 2138 format: date-time 2139 readOnly: true 2140 created_at: 2141 title: Created at 2142 type: string 2143 format: date-time 2144 readOnly: true 2145 mime: 2146 title: Mime 2147 type: string 2148 maxLength: 24 2149 minLength: 1 2150 file: 2151 title: File 2152 type: string 2153 readOnly: true 2154 format: uri 2155 default: 2156 type: object 2157 properties: 2158 name: 2159 type: string 2160 Pageable: 2161 type: object 2162 properties: 2163 page: 2164 minimum: 0 2165 type: integer 2166 format: int32 2167 default: 0 2168 size: 2169 minimum: 1 2170 type: integer 2171 format: int32 2172 sort: 2173 type: array 2174 items: 2175 type: string 2176 FreeFormObjectWithoutAdditionalProperties: 2177 description: This is a free-form object without additionalProperties. 2178 type: object 2179 FreeFormObjectWithAdditionalPropertiesEqTrue: 2180 description: 'This is a free-form object with additionalProperties: true.' 2181 type: object 2182 additionalProperties: true 2183 FreeFormObjectWithAdditionalPropertiesEqEmptyObject: 2184 description: 'This is a free-form object with additionalProperties: {}.' 2185 type: object 2186 additionalProperties: {} 2187 ModelWithConst: 2188 type: object 2189 properties: 2190 String: 2191 const: String 2192 number: 2193 const: 0 2194 'null': 2195 const: null 2196 withType: 2197 type: string 2198 const: Some string 2199 ModelWithAdditionalPropertiesEqTrue: 2200 description: 'This is a model with one property and additionalProperties: true' 2201 type: object 2202 properties: 2203 prop: 2204 description: This is a simple string property 2205 type: string 2206 additionalProperties: true 2207 NestedAnyOfArraysNullable: 2208 properties: 2209 nullableArray: 2210 anyOf: 2211 - items: 2212 anyOf: 2213 - type: string 2214 - type: boolean 2215 type: array 2216 - type: 'null' 2217 type: object 2218 CompositionWithOneOfAndProperties: 2219 type: object 2220 oneOf: 2221 - type: object 2222 required: 2223 - foo 2224 properties: 2225 foo: 2226 $ref: '#/components/parameters/SimpleParameter' 2227 additionalProperties: false 2228 - type: object 2229 required: 2230 - bar 2231 properties: 2232 bar: 2233 $ref: '#/components/schemas/NonAsciiStringæøåÆØÅöôêÊ字符串' 2234 additionalProperties: false 2235 required: 2236 - baz 2237 - qux 2238 properties: 2239 baz: 2240 type: 2241 - integer 2242 - 'null' 2243 format: uint16 2244 minimum: 0 2245 qux: 2246 type: integer 2247 format: uint8 2248 minimum: 0 2249 NullableObject: 2250 type: 2251 - object 2252 - 'null' 2253 description: An object that can be null 2254 properties: 2255 foo: 2256 type: string 2257 default: null 2258 CharactersInDescription: 2259 type: string 2260 description: Some % character 2261 ModelWithNullableObject: 2262 type: object 2263 properties: 2264 data: 2265 $ref: '#/components/schemas/NullableObject' 2266 ModelWithOneOfEnum: 2267 oneOf: 2268 - type: object 2269 required: 2270 - foo 2271 properties: 2272 foo: 2273 type: string 2274 enum: 2275 - Bar 2276 - type: object 2277 required: 2278 - foo 2279 properties: 2280 foo: 2281 type: string 2282 enum: 2283 - Baz 2284 - type: object 2285 required: 2286 - foo 2287 properties: 2288 foo: 2289 type: string 2290 enum: 2291 - Qux 2292 - type: object 2293 required: 2294 - content 2295 - foo 2296 properties: 2297 content: 2298 type: string 2299 format: date-time 2300 foo: 2301 type: string 2302 enum: 2303 - Quux 2304 - type: object 2305 required: 2306 - content 2307 - foo 2308 properties: 2309 content: 2310 type: array 2311 prefixItems: 2312 - type: string 2313 format: date-time 2314 - type: string 2315 maxItems: 2 2316 minItems: 2 2317 foo: 2318 type: string 2319 enum: 2320 - Corge 2321 ModelWithNestedArrayEnumsDataFoo: 2322 enum: 2323 - foo 2324 - bar 2325 type: string 2326 ModelWithNestedArrayEnumsDataBar: 2327 enum: 2328 - baz 2329 - qux 2330 type: string 2331 ModelWithNestedArrayEnumsData: 2332 type: object 2333 properties: 2334 foo: 2335 type: array 2336 items: 2337 $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo' 2338 bar: 2339 type: array 2340 items: 2341 $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataBar' 2342 ModelWithNestedArrayEnums: 2343 type: object 2344 properties: 2345 array_strings: 2346 type: array 2347 items: 2348 type: string 2349 data: 2350 allOf: 2351 - $ref: '#/components/schemas/ModelWithNestedArrayEnumsData' 2352 ModelWithNestedCompositionEnums: 2353 type: object 2354 properties: 2355 foo: 2356 allOf: 2357 - $ref: '#/components/schemas/ModelWithNestedArrayEnumsDataFoo' 2358 ModelWithReadOnlyAndWriteOnly: 2359 type: object 2360 required: 2361 - foo 2362 - bar 2363 - baz 2364 properties: 2365 foo: 2366 type: string 2367 bar: 2368 readOnly: true 2369 type: string 2370 baz: 2371 type: string 2372 writeOnly: true 2373 ModelWithConstantSizeArray: 2374 type: array 2375 items: 2376 type: number 2377 minItems: 2 2378 maxItems: 2 2379 ModelWithAnyOfConstantSizeArray: 2380 type: array 2381 items: 2382 oneOf: 2383 - type: number 2384 - type: string 2385 minItems: 3 2386 maxItems: 3 2387 ModelWithPrefixItemsConstantSizeArray: 2388 type: array 2389 prefixItems: 2390 - $ref: '#/components/schemas/ModelWithInteger' 2391 - oneOf: 2392 - type: number 2393 - type: string 2394 - type: string 2395 ModelWithAnyOfConstantSizeArrayNullable: 2396 type: 2397 - array 2398 items: 2399 oneOf: 2400 - type: 2401 - number 2402 - 'null' 2403 - type: string 2404 minItems: 3 2405 maxItems: 3 2406 ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions: 2407 type: array 2408 items: 2409 oneOf: 2410 - type: number 2411 - $ref: '#/components/schemas/import' 2412 minItems: 2 2413 maxItems: 2 2414 ModelWithAnyOfConstantSizeArrayAndIntersect: 2415 type: array 2416 items: 2417 allOf: 2418 - type: number 2419 - type: string 2420 minItems: 2 2421 maxItems: 2 2422 ModelWithNumericEnumUnion: 2423 type: object 2424 properties: 2425 value: 2426 type: number 2427 description: Период 2428 enum: 2429 - -10 2430 - -1 2431 - 0 2432 - 1 2433 - 3 2434 - 6 2435 - 12 2436 ModelWithBackticksInDescription: 2437 description: Some description with `back ticks` 2438 type: object 2439 properties: 2440 template: 2441 type: string 2442 description: >- 2443 The template `that` should be used for parsing and importing the 2444 contents of the CSV file. 2445 2446 2447 <br/><p>There is one placeholder currently 2448 supported:<ul> <li><b>${x}</b> - refers to the n-th column in 2449 the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct 2450 JSON template:</p> 2451 2452 <pre> 2453 2454 [ 2455 { 2456 "resourceType": "Asset", 2457 "identifier": { 2458 "name": "${1}", 2459 "domain": { 2460 "name": "${2}", 2461 "community": { 2462 "name": "Some Community" 2463 } 2464 } 2465 }, 2466 "attributes" : { 2467 "00000000-0000-0000-0000-000000003115" : [ { 2468 "value" : "${3}" 2469 } ], 2470 "00000000-0000-0000-0000-000000000222" : [ { 2471 "value" : "${4}" 2472 } ] 2473 } 2474 } 2475 ] 2476 2477 </pre> 2478 ModelWithOneOfAndProperties: 2479 type: object 2480 oneOf: 2481 - $ref: '#/components/parameters/SimpleParameter' 2482 - $ref: '#/components/schemas/NonAsciiStringæøåÆØÅöôêÊ字符串' 2483 required: 2484 - baz 2485 - qux 2486 properties: 2487 baz: 2488 type: 2489 - integer 2490 - 'null' 2491 format: uint16 2492 minimum: 0 2493 qux: 2494 type: integer 2495 format: uint8 2496 minimum: 0 2497 ParameterSimpleParameterUnused: 2498 description: Model used to test deduplication strategy (unused) 2499 type: string 2500 PostServiceWithEmptyTagResponse: 2501 description: Model used to test deduplication strategy 2502 type: string 2503 PostServiceWithEmptyTagResponse2: 2504 description: Model used to test deduplication strategy 2505 type: string 2506 DeleteFooData: 2507 description: Model used to test deduplication strategy 2508 type: string 2509 DeleteFooData2: 2510 description: Model used to test deduplication strategy 2511 type: string 2512 import: 2513 description: Model with restricted keyword name 2514 type: string 2515 SchemaWithFormRestrictedKeys: 2516 type: object 2517 properties: 2518 description: 2519 type: string 2520 x-enum-descriptions: 2521 type: string 2522 x-enum-varnames: 2523 type: string 2524 x-enumNames: 2525 type: string 2526 title: 2527 type: string 2528 object: 2529 type: object 2530 properties: 2531 description: 2532 type: string 2533 x-enum-descriptions: 2534 type: string 2535 x-enum-varnames: 2536 type: string 2537 x-enumNames: 2538 type: string 2539 title: 2540 type: string 2541 array: 2542 type: array 2543 items: 2544 type: object 2545 properties: 2546 description: 2547 type: string 2548 x-enum-descriptions: 2549 type: string 2550 x-enum-varnames: 2551 type: string 2552 x-enumNames: 2553 type: string 2554 title: 2555 type: string 2556 io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions: 2557 description: This schema was giving PascalCase transformations a hard time 2558 properties: 2559 preconditions: 2560 allOf: 2561 - $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions' 2562 description: 2563 Must be fulfilled before a deletion is carried out. If not 2564 possible, a 409 Conflict status will be returned. 2565 type: object 2566 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions: 2567 description: This schema was giving PascalCase transformations a hard time 2568 properties: 2569 resourceVersion: 2570 description: Specifies the target ResourceVersion 2571 type: string 2572 uid: 2573 description: Specifies the target UID. 2574 type: string 2575 type: object 2576 AdditionalPropertiesUnknownIssue: 2577 type: object 2578 properties: {} 2579 additionalProperties: 2580 anyOf: 2581 - type: string 2582 - type: number 2583 AdditionalPropertiesUnknownIssue2: 2584 type: object 2585 additionalProperties: 2586 anyOf: 2587 - type: string 2588 - type: number 2589 AdditionalPropertiesUnknownIssue3: 2590 type: object 2591 allOf: 2592 - type: string 2593 - type: object 2594 required: 2595 - entries 2596 properties: 2597 entries: 2598 type: object 2599 additionalProperties: 2600 $ref: '#/components/schemas/AdditionalPropertiesUnknownIssue' 2601 AdditionalPropertiesIntegerIssue: 2602 type: object 2603 required: 2604 - value 2605 properties: 2606 value: 2607 type: integer 2608 additionalProperties: 2609 type: integer 2610 OneOfAllOfIssue: 2611 oneOf: 2612 - allOf: 2613 - oneOf: 2614 - $ref: '#/components/schemas/ConstValue' 2615 - $ref: '#/components/schemas/Generic.Schema.Duplicate.Issue`1[System.Boolean]' 2616 - $ref: '#/components/schemas/3e-num_1Период' 2617 - $ref: '#/components/schemas/Generic.Schema.Duplicate.Issue`1[System.String]' 2618 Generic.Schema.Duplicate.Issue`1[System.Boolean]: 2619 type: object 2620 properties: 2621 item: 2622 type: boolean 2623 error: 2624 type: 2625 - string 2626 - 'null' 2627 hasError: 2628 type: boolean 2629 readOnly: true 2630 data: 2631 type: object 2632 properties: {} 2633 additionalProperties: false 2634 additionalProperties: false 2635 Generic.Schema.Duplicate.Issue`1[System.String]: 2636 type: object 2637 properties: 2638 item: 2639 type: 2640 - string 2641 - 'null' 2642 error: 2643 type: 2644 - string 2645 - 'null' 2646 hasError: 2647 type: boolean 2648 readOnly: true 2649 additionalProperties: false