mokkenstorm.dev
fork of hey-api/openapi-ts because I need some additional things
1swagger: '2.0'
2info:
3 title: swagger
4 version: v1.0
5host: localhost:3000
6basePath: /base
7schemes:
8 - http
9paths:
10 /api/v{api-version}/no+tag:
11 tags: []
12 get:
13 operationId: ServiceWithEmptyTag
14 patch:
15 responses:
16 default:
17 description: OK
18 put:
19 operationId: foo+Wow
20 responses:
21 default:
22 description: OK
23 /api/v{api-version}/simple:
24 get:
25 tags:
26 - Simple
27 operationId: GetCallWithoutParametersAndResponse
28 put:
29 tags:
30 - Simple
31 operationId: PutCallWithoutParametersAndResponse
32 post:
33 tags:
34 - Simple
35 operationId: PostCallWithoutParametersAndResponse
36 delete:
37 tags:
38 - Simple
39 operationId: DeleteCallWithoutParametersAndResponse
40 options:
41 tags:
42 - Simple
43 operationId: OptionsCallWithoutParametersAndResponse
44 head:
45 tags:
46 - Simple
47 operationId: HeadCallWithoutParametersAndResponse
48 patch:
49 tags:
50 - Simple
51 operationId: PatchCallWithoutParametersAndResponse
52 /api/v{api-version}/descriptions/:
53 post:
54 tags:
55 - Descriptions
56 operationId: CallWithDescriptions
57 parameters:
58 - description: |-
59 Testing multiline comments in string: First line
60 Second line
61
62 Fourth line
63 name: parameterWithBreaks
64 in: query
65 type: string
66 - description: 'Testing backticks in string: `backticks` and ```multiple
67 backticks``` should work'
68 name: parameterWithBackticks
69 in: query
70 type: string
71 - description:
72 "Testing slashes in string: \\backwards\\\\\\ and /forwards///
73 should work"
74 name: parameterWithSlashes
75 in: query
76 type: string
77 - description:
78 'Testing expression placeholders in string: ${expression} should
79 work'
80 name: parameterWithExpressionPlaceholders
81 in: query
82 type: string
83 - description:
84 'Testing quotes in string: ''single quote'''''' and "double
85 quotes""" should work'
86 name: parameterWithQuotes
87 in: query
88 type: string
89 - description:
90 'Testing reserved characters in string: /* inline */ and /** inline
91 **/ should work'
92 name: parameterWithReservedCharacters
93 in: query
94 type: string
95 /api/v{api-version}/parameters/{parameterPath}:
96 post:
97 tags:
98 - Parameters
99 operationId: CallWithParameters
100 parameters:
101 - description: This is the parameter that goes into the header
102 name: parameterHeader
103 in: header
104 type: string
105 required: true
106 - description: This is the parameter that goes into the query params
107 name: parameterQuery
108 in: query
109 type: string
110 required: true
111 - description: This is the parameter that goes into the form data
112 name: parameterForm
113 in: formData
114 type: string
115 required: true
116 - description: This is the parameter that goes into the path
117 name: parameterPath
118 in: path
119 type: string
120 required: true
121 - description: api-version should be required in standalone clients
122 name: api-version
123 in: path
124 type: string
125 required: true
126 /api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}:
127 post:
128 tags:
129 - Parameters
130 operationId: CallWithWeirdParameterNames
131 parameters:
132 - description: This is the parameter that goes into the path
133 name: parameter.path.1
134 in: path
135 type: string
136 required: false
137 - description: This is the parameter that goes into the path
138 name: parameter-path-2
139 in: path
140 type: string
141 required: false
142 - description: This is the parameter that goes into the path
143 name: PARAMETER-PATH-3
144 in: path
145 type: string
146 required: false
147 - description: This is the parameter with a reserved keyword
148 name: default
149 in: query
150 type: string
151 required: false
152 - description: This is the parameter that goes into the request header
153 name: parameter.header
154 in: header
155 type: string
156 required: true
157 - description: This is the parameter that goes into the request query params
158 name: parameter-query
159 in: query
160 type: string
161 required: true
162 - description: This is the parameter that is sent as request body
163 name: PARAMETER-BODY
164 in: body
165 required: true
166 schema:
167 type: string
168 - description: api-version should be required in standalone clients
169 name: api-version
170 in: path
171 type: string
172 required: true
173 /api/v{api-version}/defaults:
174 get:
175 tags:
176 - Defaults
177 operationId: CallWithDefaultParameters
178 parameters:
179 - description: This is a simple string with default value
180 name: parameterString
181 in: query
182 required: true
183 default: Hello World!
184 type: string
185 - description: This is a simple number with default value
186 name: parameterNumber
187 in: query
188 required: true
189 default: 123
190 type: number
191 - description: This is a simple boolean with default value
192 name: parameterBoolean
193 in: query
194 required: true
195 default: true
196 type: boolean
197 - description: This is a simple enum with default value
198 name: parameterEnum
199 in: query
200 required: true
201 default: 0
202 enum:
203 - Success
204 - Warning
205 - Error
206 - description: This is a simple model with default value
207 name: parameterModel
208 in: query
209 required: true
210 default:
211 prop: Hello World!
212 $ref: '#/definitions/ModelWithString'
213 post:
214 tags:
215 - Defaults
216 operationId: CallWithDefaultOptionalParameters
217 parameters:
218 - description: This is a simple string that is optional with default value
219 name: parameterString
220 in: query
221 default: Hello World!
222 type: string
223 - description: This is a simple number that is optional with default value
224 name: parameterNumber
225 in: query
226 default: 123
227 type: number
228 - description: This is a simple boolean that is optional with default value
229 name: parameterBoolean
230 in: query
231 default: true
232 type: boolean
233 - description: This is a simple enum that is optional with default value
234 name: parameterEnum
235 in: query
236 default: 0
237 enum:
238 - Success
239 - Warning
240 - Error
241 put:
242 tags:
243 - Defaults
244 operationId: CallToTestOrderOfParams
245 parameters:
246 - description: This is a optional string with default
247 name: parameterOptionalStringWithDefault
248 in: query
249 required: false
250 default: Hello World!
251 type: string
252 - description: This is a optional string with empty default
253 name: parameterOptionalStringWithEmptyDefault
254 in: query
255 required: false
256 default: ''
257 type: string
258 - description: This is a optional string with no default
259 name: parameterOptionalStringWithNoDefault
260 in: query
261 required: false
262 type: string
263 - description: This is a string with default
264 name: parameterStringWithDefault
265 in: query
266 required: true
267 default: Hello World!
268 type: string
269 - description: This is a string with empty default
270 name: parameterStringWithEmptyDefault
271 in: query
272 required: true
273 default: ''
274 type: string
275 - description: This is a string with no default
276 name: parameterStringWithNoDefault
277 in: query
278 required: true
279 type: string
280 - x-nullable: true
281 description: This is a string that can be null with no default
282 name: parameterStringNullableWithNoDefault
283 in: query
284 required: false
285 type: string
286 - x-nullable: true
287 description: This is a string that can be null with default
288 name: parameterStringNullableWithDefault
289 in: query
290 required: false
291 type: string
292 default: null
293 /api/v{api-version}/duplicate:
294 delete:
295 tags:
296 - Duplicate
297 operationId: DuplicateName
298 get:
299 tags:
300 - Duplicate
301 operationId: DuplicateName2
302 post:
303 tags:
304 - Duplicate
305 operationId: DuplicateName3
306 put:
307 tags:
308 - Duplicate
309 operationId: DuplicateName4
310 /api/v{api-version}/no-content:
311 get:
312 tags:
313 - NoContent
314 operationId: CallWithNoContentResponse
315 responses:
316 '204':
317 description: Success
318 /api/v{api-version}/multiple-tags/response-and-no-content:
319 get:
320 tags:
321 - Response
322 - NoContent
323 operationId: CallWithResponseAndNoContentResponse
324 produces:
325 - application/json
326 responses:
327 '200':
328 description: Response is a simple number
329 schema:
330 type: number
331 '204':
332 description: Success
333 /api/v{api-version}/multiple-tags/a:
334 get:
335 tags:
336 - MultipleTags1
337 - MultipleTags2
338 operationId: DummyA
339 responses:
340 '204':
341 description: Success
342 /api/v{api-version}/multiple-tags/b:
343 get:
344 tags:
345 - MultipleTags1
346 - MultipleTags2
347 - MultipleTags3
348 operationId: DummyB
349 responses:
350 '204':
351 description: Success
352 /api/v{api-version}/response:
353 get:
354 tags:
355 - Response
356 operationId: CallWithResponse
357 responses:
358 default:
359 description: Message for default response
360 schema:
361 $ref: '#/definitions/ModelWithString'
362 post:
363 tags:
364 - Response
365 operationId: CallWithDuplicateResponses
366 responses:
367 '201':
368 description: Message for 201 response
369 schema:
370 $ref: '#/definitions/ModelWithString'
371 '202':
372 description: Message for 202 response
373 schema:
374 $ref: '#/definitions/ModelWithString'
375 '500':
376 description: Message for 500 error
377 schema:
378 $ref: '#/definitions/ModelWithStringError'
379 '501':
380 description: Message for 501 error
381 schema:
382 $ref: '#/definitions/ModelWithStringError'
383 '502':
384 description: Message for 502 error
385 schema:
386 $ref: '#/definitions/ModelWithStringError'
387 default:
388 description: Message for default response
389 schema:
390 $ref: '#/definitions/ModelWithString'
391 put:
392 tags:
393 - Response
394 operationId: CallWithResponses
395 responses:
396 '200':
397 description: Message for 200 response
398 schema:
399 type: object
400 properties:
401 '@namespace.string':
402 type: string
403 readOnly: true
404 '@namespace.integer':
405 type: integer
406 readOnly: true
407 value:
408 type: array
409 items:
410 $ref: '#/definitions/ModelWithString'
411 readOnly: true
412 '201':
413 description: Message for 201 response
414 schema:
415 $ref: '#/definitions/ModelThatExtends'
416 '202':
417 description: Message for 202 response
418 schema:
419 $ref: '#/definitions/ModelThatExtendsExtends'
420 '500':
421 description: Message for 500 error
422 schema:
423 $ref: '#/definitions/ModelWithStringError'
424 '501':
425 description: Message for 501 error
426 schema:
427 $ref: '#/definitions/ModelWithStringError'
428 '502':
429 description: Message for 502 error
430 schema:
431 $ref: '#/definitions/ModelWithStringError'
432 default:
433 description: Message for default response
434 schema:
435 $ref: '#/definitions/ModelWithString'
436 /api/v{api-version}/collectionFormat:
437 get:
438 tags:
439 - CollectionFormat
440 operationId: CollectionFormat
441 parameters:
442 - description: This is an array parameter that is sent as csv format
443 (comma-separated values)
444 name: parameterArrayCSV
445 in: query
446 required: true
447 type: array
448 items:
449 type: string
450 collectionFormat: csv
451 - description: This is an array parameter that is sent as ssv format
452 (space-separated values)
453 name: parameterArraySSV
454 in: query
455 required: true
456 type: array
457 items:
458 type: string
459 collectionFormat: ssv
460 - description: This is an array parameter that is sent as tsv format
461 (tab-separated values)
462 name: parameterArrayTSV
463 in: query
464 required: true
465 type: array
466 items:
467 type: string
468 collectionFormat: tsv
469 - description: This is an array parameter that is sent as pipes format
470 (pipe-separated values)
471 name: parameterArrayPipes
472 in: query
473 required: true
474 type: array
475 items:
476 type: string
477 collectionFormat: pipes
478 - description:
479 This is an array parameter that is sent as multi format (multiple
480 parameter instances)
481 name: parameterArrayMulti
482 in: query
483 required: true
484 type: array
485 items:
486 type: string
487 collectionFormat: multi
488 /api/v{api-version}/types:
489 get:
490 tags:
491 - Types
492 operationId: Types
493 parameters:
494 - description: This is a number parameter
495 name: parameterNumber
496 in: query
497 required: true
498 default: 123
499 type: number
500 - description: This is a string parameter
501 name: parameterString
502 in: query
503 required: true
504 default: default
505 type: string
506 - description: This is a boolean parameter
507 name: parameterBoolean
508 in: query
509 required: true
510 default: true
511 type: boolean
512 - description: This is an array parameter
513 name: parameterArray
514 in: query
515 required: true
516 type: array
517 items:
518 type: string
519 - description: This is a dictionary parameter
520 name: parameterDictionary
521 in: query
522 required: true
523 type: object
524 items:
525 type: string
526 - description: This is an enum parameter
527 name: parameterEnum
528 in: query
529 required: true
530 enum:
531 - Success
532 - Warning
533 - Error
534 - description: This is a number parameter
535 name: id
536 in: path
537 type: integer
538 format: int32
539 responses:
540 '200':
541 description: Response is a simple number
542 schema:
543 type: number
544 '201':
545 description: Response is a simple string
546 schema:
547 type: string
548 '202':
549 description: Response is a simple boolean
550 schema:
551 type: boolean
552 '203':
553 description: Response is a simple object
554 default: null
555 schema:
556 type: object
557 /api/v{api-version}/complex:
558 get:
559 tags:
560 - Complex
561 operationId: ComplexTypes
562 parameters:
563 - description: Parameter containing object
564 name: parameterObject
565 in: query
566 required: true
567 type: object
568 properties:
569 first:
570 type: object
571 properties:
572 second:
573 type: object
574 properties:
575 third:
576 type: string
577 - description: Parameter containing reference
578 name: parameterReference
579 in: query
580 required: true
581 $ref: '#/definitions/ModelWithString'
582 responses:
583 '200':
584 description: Successful response
585 schema:
586 type: array
587 items:
588 $ref: '#/definitions/ModelWithString'
589 '400':
590 description: 400 server error
591 '500':
592 description: 500 server error
593 /api/v{api-version}/header:
594 post:
595 tags:
596 - Header
597 operationId: CallWithResultFromHeader
598 responses:
599 '200':
600 description: Successful response
601 headers:
602 operation-location:
603 type: string
604 '400':
605 description: 400 server error
606 '500':
607 description: 500 server error
608 /api/v{api-version}/error:
609 post:
610 tags:
611 - Error
612 operationId: testErrorCode
613 parameters:
614 - description: Status code to return
615 name: status
616 in: query
617 type: string
618 required: true
619 responses:
620 '200':
621 description: 'Custom message: Successful response'
622 '500':
623 description: 'Custom message: Internal Server Error'
624 '501':
625 description: 'Custom message: Not Implemented'
626 '502':
627 description: 'Custom message: Bad Gateway'
628 '503':
629 description: 'Custom message: Service Unavailable'
630 /api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串:
631 post:
632 tags:
633 - Non-Ascii-æøåÆØÅöôêÊ
634 operationId: nonAsciiæøåÆØÅöôêÊ字符串
635 parameters:
636 - description: Dummy input param
637 name: nonAsciiParamæøåÆØÅöôêÊ
638 in: query
639 required: true
640 type: integer
641 responses:
642 '200':
643 description: Successful response
644 schema:
645 $ref: '#/definitions/NonAsciiStringæøåÆØÅöôêÊ字符串'
646 /api/v{api-version}/body:
647 post:
648 description: Body should not be unknown
649 consumes:
650 - application/json
651 produces:
652 - application/json
653 summary: Body should not be unknown
654 parameters:
655 - description: Body should not be unknown
656 name: request
657 in: body
658 required: true
659 schema:
660 $ref: '#/definitions/parameter.ActivityParams'
661 responses:
662 '200':
663 description: OK
664 schema:
665 $ref: '#/definitions/response.PostActivityResponse'
666 '400':
667 description: Bad Request
668 schema:
669 $ref: '#/definitions/failure.Failure'
670 '500':
671 description: Internal Server Error
672 schema:
673 $ref: '#/definitions/failure.Failure'
674definitions:
675 ExternalRefA:
676 description: External ref to shared model (A)
677 $ref: './external-shared.json#/definitions/ExternalSharedModel'
678 ExternalRefB:
679 description: External ref to shared model (B)
680 $ref: './external-shared.json#/definitions/ExternalSharedModel'
681 CommentWithBreaks:
682 description: |-
683 Testing multiline comments in string: First line
684 Second line
685
686 Fourth line
687 type: integer
688 CommentWithBackticks:
689 description: 'Testing backticks in string: `backticks` and ```multiple
690 backticks``` should work'
691 type: integer
692 CommentWithBackticksAndQuotes:
693 description:
694 'Testing backticks and quotes in string: `backticks`, ''quotes'',
695 "double quotes" and ```multiple backticks``` should work'
696 type: integer
697 CommentWithSlashes:
698 description: "Testing slashes in string: \\backwards\\\\\\ and /forwards/// should work"
699 type: integer
700 CommentWithExpressionPlaceholders:
701 description: 'Testing expression placeholders in string: ${expression} should work'
702 type: integer
703 CommentWithQuotes:
704 description: 'Testing quotes in string: ''single quote'''''' and "double
705 quotes""" should work'
706 type: integer
707 CommentWithReservedCharacters:
708 description:
709 'Testing reserved characters in string: /* inline */ and /** inline
710 **/ should work'
711 type: integer
712 SimpleInteger:
713 description: This is a simple number
714 type: integer
715 SimpleBoolean:
716 description: This is a simple boolean
717 type: boolean
718 SimpleString:
719 description: This is a simple string
720 type: string
721 NonAsciiStringæøåÆØÅöôêÊ字符串:
722 description:
723 A string with non-ascii (unicode) characters valid in typescript
724 identifiers (æøåÆØÅöÔèÈ字符串)
725 type: string
726 SimpleFile:
727 description: This is a simple file
728 format: binary
729 type: string
730 SimpleReference:
731 description: This is a simple reference
732 $ref: '#/definitions/ModelWithString'
733 SimpleStringWithPattern:
734 description: This is a simple string
735 type: string
736 maxLength: 64
737 pattern: ^[a-zA-Z0-9_]*$
738 EnumWithStrings:
739 description: This is a simple enum with strings
740 enum:
741 - Success
742 - Warning
743 - Error
744 - "'Single Quote'"
745 - '"Double Quotes"'
746 - 'Non-ascii: øæåôöØÆÅÔÖ字符串'
747 EnumWithNumbers:
748 description: This is a simple enum with numbers
749 enum:
750 - 1
751 - 2
752 - 3
753 - 1.1
754 - 1.2
755 - 1.3
756 - 100
757 - 200
758 - 300
759 - -100
760 - -200
761 - -300
762 - -1.1
763 - -1.2
764 - -1.3
765 EnumFromDescription:
766 description: Success=1,Warning=2,Error=3
767 type: number
768 EnumWithExtensions:
769 description: This is a simple enum with numbers
770 enum:
771 - 200
772 - 400
773 - 500
774 x-enum-varnames:
775 - CUSTOM_SUCCESS
776 - CUSTOM_WARNING
777 - CUSTOM_ERROR
778 x-enum-descriptions:
779 - Used when the status of something is successful
780 - Used when the status of something has a warning
781 - Used when the status of something has an error
782 ArrayWithNumbers:
783 description: This is a simple array with numbers
784 type: array
785 items:
786 type: integer
787 ArrayWithBooleans:
788 description: This is a simple array with booleans
789 type: array
790 items:
791 type: boolean
792 ArrayWithStrings:
793 description: This is a simple array with strings
794 type: array
795 items:
796 type: string
797 ArrayWithReferences:
798 description: This is a simple array with references
799 type: array
800 items:
801 $ref: '#/definitions/ModelWithString'
802 ArrayWithArray:
803 description: This is a simple array containing an array
804 type: array
805 items:
806 type: array
807 items:
808 $ref: '#/definitions/ModelWithString'
809 ArrayWithProperties:
810 description: This is a simple array with properties
811 type: array
812 items:
813 type: object
814 properties:
815 foo:
816 type: string
817 bar:
818 type: string
819 DictionaryWithString:
820 description: This is a string dictionary
821 type: object
822 additionalProperties:
823 type: string
824 DictionaryWithReference:
825 description: This is a string reference
826 type: object
827 additionalProperties:
828 $ref: '#/definitions/ModelWithString'
829 DictionaryWithArray:
830 description: This is a complex dictionary
831 type: object
832 additionalProperties:
833 type: array
834 items:
835 $ref: '#/definitions/ModelWithString'
836 DictionaryWithDictionary:
837 description: This is a string dictionary
838 type: object
839 additionalProperties:
840 type: object
841 additionalProperties:
842 type: string
843 DictionaryWithProperties:
844 description: This is a complex dictionary
845 type: object
846 additionalProperties:
847 type: object
848 properties:
849 foo:
850 type: string
851 bar:
852 type: string
853 Date:
854 description: This is a type-only model that defines Date as a string
855 type: string
856 ModelWithInteger:
857 description: This is a model with one number property
858 type: object
859 properties:
860 prop:
861 description: This is a simple number property
862 type: integer
863 ModelWithBoolean:
864 description: This is a model with one boolean property
865 type: object
866 properties:
867 prop:
868 description: This is a simple boolean property
869 type: boolean
870 ModelWithString:
871 description: This is a model with one string property
872 type: object
873 properties:
874 prop:
875 description: This is a simple string property
876 type: string
877 ModelWithStringError:
878 description: This is a model with one string property
879 type: object
880 properties:
881 prop:
882 description: This is a simple string property
883 type: string
884 ModelWithNullableString:
885 description: This is a model with one string property
886 type: object
887 required:
888 - nullableRequiredProp
889 properties:
890 nullableProp:
891 description: This is a simple string property
892 type: string
893 x-nullable: true
894 nullableRequiredProp:
895 description: This is a simple string property
896 type: string
897 x-nullable: true
898 ModelWithEnum:
899 description: This is a model with one enum
900 type: object
901 properties:
902 test:
903 description: This is a simple enum with strings
904 enum:
905 - Success
906 - Warning
907 - Error
908 - ØÆÅ字符串
909 statusCode:
910 description: These are the HTTP error code enums
911 enum:
912 - '100'
913 - 200 FOO
914 - 300 FOO_BAR
915 - 400 foo-bar
916 - 500 foo.bar
917 - 600 foo&bar
918 bool:
919 description: Simple boolean enum
920 type: boolean
921 enum:
922 - true
923 ModelWithEnumFromDescription:
924 description: This is a model with one enum
925 type: object
926 properties:
927 test:
928 type: integer
929 description: Success=1,Warning=2,Error=3
930 ModelWithNestedEnums:
931 description: This is a model with nested enums
932 type: object
933 properties:
934 dictionaryWithEnum:
935 type: object
936 additionalProperties:
937 enum:
938 - Success
939 - Warning
940 - Error
941 dictionaryWithEnumFromDescription:
942 type: object
943 additionalProperties:
944 type: integer
945 description: Success=1,Warning=2,Error=3
946 arrayWithEnum:
947 type: array
948 items:
949 enum:
950 - Success
951 - Warning
952 - Error
953 arrayWithDescription:
954 type: array
955 items:
956 type: integer
957 description: Success=1,Warning=2,Error=3
958 ModelWithReference:
959 description: This is a model with one property containing a reference
960 type: object
961 properties:
962 prop:
963 $ref: '#/definitions/ModelWithProperties'
964 ModelWithArray:
965 description: This is a model with one property containing an array
966 type: object
967 properties:
968 prop:
969 type: array
970 items:
971 $ref: '#/definitions/ModelWithString'
972 propWithFile:
973 type: array
974 items:
975 format: binary
976 type: string
977 propWithNumber:
978 type: array
979 items:
980 type: number
981 ModelWithDictionary:
982 description: This is a model with one property containing a dictionary
983 type: object
984 properties:
985 prop:
986 type: object
987 additionalProperties:
988 type: string
989 ModelWithCircularReference:
990 description: This is a model with one property containing a circular reference
991 type: object
992 properties:
993 prop:
994 $ref: '#/definitions/ModelWithCircularReference'
995 ModelWithProperties:
996 description: This is a model with one nested property
997 type: object
998 required:
999 - required
1000 - requiredAndReadOnly
1001 properties:
1002 required:
1003 type: string
1004 requiredAndReadOnly:
1005 type: string
1006 readOnly: true
1007 string:
1008 type: string
1009 number:
1010 type: number
1011 boolean:
1012 type: boolean
1013 reference:
1014 $ref: '#/definitions/ModelWithString'
1015 property with space:
1016 type: string
1017 default:
1018 type: string
1019 try:
1020 type: string
1021 '@namespace.string':
1022 type: string
1023 readOnly: true
1024 '@namespace.integer':
1025 type: integer
1026 readOnly: true
1027 ModelWithNestedProperties:
1028 description: This is a model with one nested property
1029 type: object
1030 required:
1031 - first
1032 properties:
1033 first:
1034 type: object
1035 required:
1036 - second
1037 readOnly: true
1038 properties:
1039 second:
1040 type: object
1041 required:
1042 - third
1043 readOnly: true
1044 properties:
1045 third:
1046 type: string
1047 readOnly: true
1048 ModelWithDuplicateProperties:
1049 description: This is a model with duplicated properties
1050 type: object
1051 properties:
1052 prop:
1053 $ref: '#/definitions/ModelWithString'
1054 ModelWithOrderedProperties:
1055 description: This is a model with ordered properties
1056 type: object
1057 properties:
1058 zebra:
1059 type: string
1060 apple:
1061 type: string
1062 hawaii:
1063 type: string
1064 ModelWithDuplicateImports:
1065 description: This is a model with duplicated imports
1066 type: object
1067 properties:
1068 propA:
1069 $ref: '#/definitions/ModelWithString'
1070 propB:
1071 $ref: '#/definitions/ModelWithString'
1072 propC:
1073 $ref: '#/definitions/ModelWithString'
1074 ModelThatExtends:
1075 description: This is a model that extends another model
1076 type: object
1077 allOf:
1078 - $ref: '#/definitions/ModelWithString'
1079 - type: object
1080 properties:
1081 propExtendsA:
1082 type: string
1083 propExtendsB:
1084 $ref: '#/definitions/ModelWithString'
1085 ModelThatExtendsExtends:
1086 description: This is a model that extends another model
1087 type: object
1088 allOf:
1089 - $ref: '#/definitions/ModelWithString'
1090 - $ref: '#/definitions/ModelThatExtends'
1091 - type: object
1092 properties:
1093 propExtendsC:
1094 type: string
1095 propExtendsD:
1096 $ref: '#/definitions/ModelWithString'
1097 default:
1098 type: object
1099 properties:
1100 name:
1101 type: string
1102 ModelWithPattern:
1103 description: This is a model that contains a some patterns
1104 type: object
1105 required:
1106 - key
1107 - name
1108 properties:
1109 key:
1110 maxLength: 64
1111 pattern: ^[a-zA-Z0-9_]*$
1112 type: string
1113 name:
1114 maxLength: 255
1115 type: string
1116 enabled:
1117 type: boolean
1118 readOnly: true
1119 modified:
1120 type: string
1121 format: date-time
1122 readOnly: true
1123 id:
1124 type: string
1125 pattern: ^\d{2}-\d{3}-\d{4}$
1126 text:
1127 type: string
1128 pattern: ^\w+$
1129 patternWithSingleQuotes:
1130 type: string
1131 pattern: ^[a-zA-Z0-9']*$
1132 patternWithNewline:
1133 type: string
1134 pattern: aaa\nbbb
1135 patternWithBacktick:
1136 type: string
1137 pattern: aaa`bbb
1138 parameter.ActivityParams:
1139 type: object
1140 properties:
1141 description:
1142 type: string
1143 graduate_id:
1144 type: integer
1145 organization_id:
1146 type: integer
1147 parent_activity:
1148 type: integer
1149 post_id:
1150 type: integer
1151 response.PostActivityResponse:
1152 type: object
1153 properties:
1154 description:
1155 type: string
1156 graduate_id:
1157 type: integer
1158 organization_id:
1159 type: integer
1160 parent_activity_id:
1161 type: integer
1162 post_id:
1163 type: integer
1164 failure.Failure:
1165 type: object
1166 properties:
1167 error:
1168 type: string
1169 message:
1170 type: string
1171 reference_code:
1172 type: string