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