rapipdf 2.2.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/README.md +66 -14
  2. package/dist/chunks/generate-BQLGaRvK.js +386 -0
  3. package/dist/chunks/generate-BQLGaRvK.js.LICENSE.txt +224 -0
  4. package/dist/chunks/localize-CRvDVkIz.js +8 -0
  5. package/dist/node.js +13096 -0
  6. package/dist/node.js.LICENSE.txt +195 -0
  7. package/dist/rapipdf-min.js +352 -90
  8. package/dist/rapipdf-min.js.LICENSE.txt +224 -0
  9. package/dist/rapipdf.js +69 -0
  10. package/package.json +58 -52
  11. package/src/node.d.ts +82 -0
  12. package/src/rapipdf.d.ts +50 -0
  13. package/.babelrc +0 -11
  14. package/.eslintrc +0 -28
  15. package/dist/index.html +0 -7
  16. package/dist/index.html.gz +0 -0
  17. package/dist/rapipdf-min.js.gz +0 -0
  18. package/dist/rapipdf-min.js.map +0 -1
  19. package/dist/rapipdf-min.js.map.gz +0 -0
  20. package/dist/report.html +0 -53
  21. package/docs/api.html +0 -285
  22. package/docs/examples/example1.html +0 -68
  23. package/docs/examples/list.html +0 -27
  24. package/docs/examples/rapidoc-regular.woff2 +0 -0
  25. package/docs/examples/rapidoc-semi-bold.woff2 +0 -0
  26. package/docs/examples/roboto-mono-bold.woff2 +0 -0
  27. package/docs/examples/roboto-mono-regular.woff2 +0 -0
  28. package/docs/highlight/CHANGES.md +0 -1803
  29. package/docs/highlight/LICENSE +0 -24
  30. package/docs/highlight/README.md +0 -188
  31. package/docs/highlight/README.ru.md +0 -142
  32. package/docs/highlight/highlight.pack.js +0 -2
  33. package/docs/highlight/styles/a11y-dark.css +0 -99
  34. package/docs/highlight/styles/a11y-light.css +0 -99
  35. package/docs/highlight/styles/agate.css +0 -108
  36. package/docs/highlight/styles/an-old-hope.css +0 -89
  37. package/docs/highlight/styles/androidstudio.css +0 -66
  38. package/docs/highlight/styles/arduino-light.css +0 -88
  39. package/docs/highlight/styles/arta.css +0 -73
  40. package/docs/highlight/styles/ascetic.css +0 -45
  41. package/docs/highlight/styles/atelier-cave-dark.css +0 -83
  42. package/docs/highlight/styles/atelier-cave-light.css +0 -85
  43. package/docs/highlight/styles/atelier-dune-dark.css +0 -69
  44. package/docs/highlight/styles/atelier-dune-light.css +0 -69
  45. package/docs/highlight/styles/atelier-estuary-dark.css +0 -84
  46. package/docs/highlight/styles/atelier-estuary-light.css +0 -84
  47. package/docs/highlight/styles/atelier-forest-dark.css +0 -69
  48. package/docs/highlight/styles/atelier-forest-light.css +0 -69
  49. package/docs/highlight/styles/atelier-heath-dark.css +0 -69
  50. package/docs/highlight/styles/atelier-heath-light.css +0 -69
  51. package/docs/highlight/styles/atelier-lakeside-dark.css +0 -69
  52. package/docs/highlight/styles/atelier-lakeside-light.css +0 -69
  53. package/docs/highlight/styles/atelier-plateau-dark.css +0 -84
  54. package/docs/highlight/styles/atelier-plateau-light.css +0 -84
  55. package/docs/highlight/styles/atelier-savanna-dark.css +0 -84
  56. package/docs/highlight/styles/atelier-savanna-light.css +0 -84
  57. package/docs/highlight/styles/atelier-seaside-dark.css +0 -69
  58. package/docs/highlight/styles/atelier-seaside-light.css +0 -69
  59. package/docs/highlight/styles/atelier-sulphurpool-dark.css +0 -69
  60. package/docs/highlight/styles/atelier-sulphurpool-light.css +0 -69
  61. package/docs/highlight/styles/atom-one-dark-reasonable.css +0 -77
  62. package/docs/highlight/styles/atom-one-dark.css +0 -96
  63. package/docs/highlight/styles/atom-one-light.css +0 -96
  64. package/docs/highlight/styles/brown-paper.css +0 -64
  65. package/docs/highlight/styles/brown-papersq.png +0 -0
  66. package/docs/highlight/styles/codepen-embed.css +0 -60
  67. package/docs/highlight/styles/color-brewer.css +0 -71
  68. package/docs/highlight/styles/darcula.css +0 -77
  69. package/docs/highlight/styles/dark.css +0 -63
  70. package/docs/highlight/styles/darkula.css +0 -6
  71. package/docs/highlight/styles/default.css +0 -99
  72. package/docs/highlight/styles/docco.css +0 -97
  73. package/docs/highlight/styles/dracula.css +0 -76
  74. package/docs/highlight/styles/far.css +0 -71
  75. package/docs/highlight/styles/foundation.css +0 -88
  76. package/docs/highlight/styles/github-gist.css +0 -71
  77. package/docs/highlight/styles/github.css +0 -99
  78. package/docs/highlight/styles/gml.css +0 -78
  79. package/docs/highlight/styles/googlecode.css +0 -89
  80. package/docs/highlight/styles/grayscale.css +0 -101
  81. package/docs/highlight/styles/gruvbox-dark.css +0 -108
  82. package/docs/highlight/styles/gruvbox-light.css +0 -108
  83. package/docs/highlight/styles/hopscotch.css +0 -83
  84. package/docs/highlight/styles/hybrid.css +0 -102
  85. package/docs/highlight/styles/idea.css +0 -97
  86. package/docs/highlight/styles/ir-black.css +0 -73
  87. package/docs/highlight/styles/isbl-editor-dark.css +0 -112
  88. package/docs/highlight/styles/isbl-editor-light.css +0 -112
  89. package/docs/highlight/styles/kimbie.dark.css +0 -74
  90. package/docs/highlight/styles/kimbie.light.css +0 -74
  91. package/docs/highlight/styles/lightfair.css +0 -87
  92. package/docs/highlight/styles/magula.css +0 -70
  93. package/docs/highlight/styles/mono-blue.css +0 -59
  94. package/docs/highlight/styles/monokai-sublime.css +0 -83
  95. package/docs/highlight/styles/monokai.css +0 -70
  96. package/docs/highlight/styles/nord.css +0 -309
  97. package/docs/highlight/styles/obsidian.css +0 -88
  98. package/docs/highlight/styles/ocean.css +0 -74
  99. package/docs/highlight/styles/paraiso-dark.css +0 -72
  100. package/docs/highlight/styles/paraiso-light.css +0 -72
  101. package/docs/highlight/styles/pojoaque.css +0 -83
  102. package/docs/highlight/styles/pojoaque.jpg +0 -0
  103. package/docs/highlight/styles/purebasic.css +0 -96
  104. package/docs/highlight/styles/qtcreator_dark.css +0 -83
  105. package/docs/highlight/styles/qtcreator_light.css +0 -83
  106. package/docs/highlight/styles/railscasts.css +0 -106
  107. package/docs/highlight/styles/rainbow.css +0 -85
  108. package/docs/highlight/styles/routeros.css +0 -108
  109. package/docs/highlight/styles/school-book.css +0 -72
  110. package/docs/highlight/styles/school-book.png +0 -0
  111. package/docs/highlight/styles/shades-of-purple.css +0 -97
  112. package/docs/highlight/styles/solarized-dark.css +0 -84
  113. package/docs/highlight/styles/solarized-light.css +0 -84
  114. package/docs/highlight/styles/sunburst.css +0 -102
  115. package/docs/highlight/styles/tomorrow-night-blue.css +0 -75
  116. package/docs/highlight/styles/tomorrow-night-bright.css +0 -74
  117. package/docs/highlight/styles/tomorrow-night-eighties.css +0 -74
  118. package/docs/highlight/styles/tomorrow-night.css +0 -75
  119. package/docs/highlight/styles/tomorrow.css +0 -72
  120. package/docs/highlight/styles/vs.css +0 -68
  121. package/docs/highlight/styles/vs2015.css +0 -115
  122. package/docs/highlight/styles/xcode.css +0 -104
  123. package/docs/highlight/styles/xt256.css +0 -92
  124. package/docs/highlight/styles/zenburn.css +0 -80
  125. package/docs/images/console.svg +0 -12
  126. package/docs/images/dark_ss.png +0 -0
  127. package/docs/images/easy.svg +0 -14
  128. package/docs/images/fast.svg +0 -8
  129. package/docs/images/gears.svg +0 -11
  130. package/docs/images/light_ss.png +0 -0
  131. package/docs/images/logo-outline.png +0 -0
  132. package/docs/images/logo.png +0 -0
  133. package/docs/images/love.svg +0 -8
  134. package/docs/images/mask.svg +0 -16
  135. package/docs/images/mouse.svg +0 -7
  136. package/docs/images/pdf_sample1.png +0 -0
  137. package/docs/images/pdf_sample2.png +0 -0
  138. package/docs/images/webcomponent.svg +0 -13
  139. package/docs/index.css +0 -257
  140. package/docs/index.html +0 -186
  141. package/docs/rapipdf-min.js +0 -95
  142. package/docs/specs/allof-primitives.json +0 -80
  143. package/docs/specs/allof.json +0 -73
  144. package/docs/specs/anyof.json +0 -84
  145. package/docs/specs/basic.json +0 -75
  146. package/docs/specs/bitbucket.json +0 -12916
  147. package/docs/specs/data-types.yaml +0 -168
  148. package/docs/specs/gcloud.json +0 -1347
  149. package/docs/specs/no-server.json +0 -1
  150. package/docs/specs/oneof.json +0 -64
  151. package/docs/specs/petstore.json +0 -1042
  152. package/docs/specs/petstore_extended.yaml +0 -889
  153. package/docs/specs/temp.json +0 -53
  154. package/docs/specs/test-specs/large-models.json +0 -5998
  155. package/docs/specs/test-specs/long-descriptions.json +0 -5443
  156. package/docs/specs/test-specs/long-paths.json +0 -9562
  157. package/docs/specs/test-specs/oneof-allof-nested.yaml +0 -105
  158. package/docs/specs/test-specs/partial-spec-main.json +0 -29
  159. package/docs/specs/test-specs/partial.json +0 -17
  160. package/docs/specs/test-specs/petstore_complex_request.yaml +0 -335
  161. package/docs/specs/test-specs/petstore_experimental.yaml +0 -167
  162. package/docs/specs/test-specs/xxx-of-with-primitives-and-recursive-model.yaml +0 -952
  163. package/docs/welcome.html +0 -186
  164. package/index.html +0 -48
  165. package/logo.png +0 -0
  166. package/src/index.js +0 -3
  167. package/src/markdown.js +0 -120
  168. package/src/object-tree-gen.js +0 -370
  169. package/src/pdf-gen.js +0 -113
  170. package/src/pdf-parts-gen.js +0 -488
  171. package/src/rapipdf.js +0 -246
  172. package/src/spec-parser.js +0 -178
  173. package/src/table-layouts.js +0 -35
  174. package/src/vfs_fonts.js +0 -7
  175. package/webpack.config.js +0 -118
@@ -1,889 +0,0 @@
1
- openapi: 3.0.0
2
- info:
3
- description: This is a sample server Petstore server.
4
- version: 1.0.0
5
- title: Swagger Petstore
6
- tags:
7
- - name: pet
8
- description: Everything about your Pets
9
- - name: store
10
- description: Access to Petstore orders
11
- - name: user
12
- description: Operations about user
13
- - name: pet_model
14
- x-displayName: The Pet Model
15
- description: |
16
- <SchemaDefinition schemaRef="#/components/schemas/Pet" />
17
- - name: store_model
18
- x-displayName: The Order Model
19
- description: |
20
- <SchemaDefinition schemaRef="#/components/schemas/Order" exampleRef="#/components/examples/Order" showReadOnly={true} showWriteOnly={true} />
21
- paths:
22
- /pet:
23
- parameters:
24
- - name: cookieParam
25
- in: cookie
26
- description: Some cookie
27
- required: true
28
- schema:
29
- type: integer
30
- format: int64
31
- post:
32
- tags:
33
- - pet
34
- summary: Add a new pet to the store
35
- description: Add new pet to the store inventory.
36
- operationId: addPet
37
- responses:
38
- '405':
39
- description: Invalid input
40
- security:
41
- - petstore_auth:
42
- - 'write:pets'
43
- - 'read:pets'
44
- x-code-samples:
45
- - lang: 'C#'
46
- source: |
47
- PetStore.v1.Pet pet = new PetStore.v1.Pet();
48
- pet.setApiKey("your api key");
49
- pet.petType = PetStore.v1.Pet.TYPE_DOG;
50
- pet.name = "Rex";
51
- // set other fields
52
- PetStoreResponse response = pet.create();
53
- if (response.statusCode == HttpStatusCode.Created)
54
- {
55
- // Successfully created
56
- }
57
- else
58
- {
59
- // Something wrong -- check response for errors
60
- Console.WriteLine(response.getRawResponse());
61
- }
62
- - lang: PHP
63
- source: |
64
- $form = new \PetStore\Entities\Pet();
65
- $form->setPetType("Dog");
66
- $form->setName("Rex");
67
- // set other fields
68
- try {
69
- $pet = $client->pets()->create($form);
70
- } catch (UnprocessableEntityException $e) {
71
- var_dump($e->getErrors());
72
- }
73
- requestBody:
74
- $ref: '#/components/requestBodies/Pet'
75
- put:
76
- tags:
77
- - pet
78
- summary: Update an existing pet
79
- description: ''
80
- operationId: updatePet
81
- responses:
82
- '400':
83
- description: Invalid ID supplied
84
- '404':
85
- description: Pet not found
86
- '405':
87
- description: Validation exception
88
- security:
89
- - petstore_auth:
90
- - 'write:pets'
91
- - 'read:pets'
92
- x-code-samples:
93
- - lang: PHP
94
- source: |
95
- $form = new \PetStore\Entities\Pet();
96
- $form->setPetId(1);
97
- $form->setPetType("Dog");
98
- $form->setName("Rex");
99
- // set other fields
100
- try {
101
- $pet = $client->pets()->update($form);
102
- } catch (UnprocessableEntityException $e) {
103
- var_dump($e->getErrors());
104
- }
105
- requestBody:
106
- $ref: '#/components/requestBodies/Pet'
107
- '/pet/{petId}':
108
- get:
109
- tags:
110
- - pet
111
- summary: Find pet by ID
112
- description: Returns a single pet
113
- operationId: getPetById
114
- parameters:
115
- - name: petId
116
- in: path
117
- description: ID of pet to return
118
- required: true
119
- deprecated: true
120
- schema:
121
- type: integer
122
- format: int64
123
- responses:
124
- '200':
125
- description: successful operation
126
- content:
127
- application/json:
128
- schema:
129
- $ref: '#/components/schemas/Pet'
130
- application/xml:
131
- schema:
132
- $ref: '#/components/schemas/Pet'
133
- '400':
134
- description: Invalid ID supplied
135
- '404':
136
- description: Pet not found
137
- security:
138
- - api_key: []
139
- post:
140
- tags:
141
- - pet
142
- summary: Updates a pet in the store with form data
143
- description: ''
144
- operationId: updatePetWithForm
145
- parameters:
146
- - name: petId
147
- in: path
148
- description: ID of pet that needs to be updated
149
- required: true
150
- schema:
151
- type: integer
152
- format: int64
153
- responses:
154
- '405':
155
- description: Invalid input
156
- security:
157
- - petstore_auth:
158
- - 'write:pets'
159
- - 'read:pets'
160
- requestBody:
161
- content:
162
- application/x-www-form-urlencoded:
163
- schema:
164
- type: object
165
- properties:
166
- name:
167
- description: Updated name of the pet
168
- type: string
169
- status:
170
- description: Updated status of the pet
171
- type: string
172
- delete:
173
- tags:
174
- - pet
175
- summary: Deletes a pet
176
- description: ''
177
- operationId: deletePet
178
- parameters:
179
- - name: api_key
180
- in: header
181
- required: false
182
- schema:
183
- type: string
184
- example: "Bearer <TOKEN>"
185
- - name: petId
186
- in: path
187
- description: Pet id to delete
188
- required: true
189
- schema:
190
- type: integer
191
- format: int64
192
- responses:
193
- '400':
194
- description: Invalid pet value
195
- security:
196
- - petstore_auth:
197
- - 'write:pets'
198
- - 'read:pets'
199
- '/pet/{petId}/uploadImage':
200
- post:
201
- tags:
202
- - pet
203
- summary: uploads an image
204
- description: ''
205
- operationId: uploadFile
206
- parameters:
207
- - name: petId
208
- in: path
209
- description: ID of pet to update
210
- required: true
211
- schema:
212
- type: integer
213
- format: int64
214
- responses:
215
- '200':
216
- description: successful operation
217
- content:
218
- application/json:
219
- schema:
220
- $ref: '#/components/schemas/ApiResponse'
221
- security:
222
- - petstore_auth:
223
- - 'write:pets'
224
- - 'read:pets'
225
- requestBody:
226
- content:
227
- application/octet-stream:
228
- schema:
229
- type: string
230
- format: binary
231
- /pet/findByStatus:
232
- get:
233
- tags:
234
- - pet
235
- summary: Finds Pets by status
236
- description: Multiple status values can be provided with comma seperated strings
237
- operationId: findPetsByStatus
238
- parameters:
239
- - name: status
240
- in: query
241
- description: Status values that need to be considered for filter
242
- required: true
243
- style: form
244
- schema:
245
- type: array
246
- minItems: 1
247
- maxItems: 3
248
- items:
249
- type: string
250
- enum:
251
- - available
252
- - pending
253
- - sold
254
- default: available
255
- responses:
256
- '200':
257
- description: successful operation
258
- content:
259
- application/json:
260
- schema:
261
- type: array
262
- items:
263
- $ref: '#/components/schemas/Pet'
264
- application/xml:
265
- schema:
266
- type: array
267
- items:
268
- $ref: '#/components/schemas/Pet'
269
- '400':
270
- description: Invalid status value
271
- security:
272
- - petstore_auth:
273
- - 'write:pets'
274
- - 'read:pets'
275
- /pet/findByTags:
276
- get:
277
- tags:
278
- - pet
279
- summary: Finds Pets by tags
280
- description: >-
281
- Muliple tags can be provided with comma seperated strings. Use tag1,
282
- tag2, tag3 for testing.
283
- operationId: findPetsByTags
284
- deprecated: true
285
- parameters:
286
- - name: tags
287
- in: query
288
- description: Tags to filter by
289
- required: true
290
- style: form
291
- schema:
292
- type: array
293
- items:
294
- type: string
295
- responses:
296
- '200':
297
- description: successful operation
298
- content:
299
- application/json:
300
- schema:
301
- type: array
302
- items:
303
- $ref: '#/components/schemas/Pet'
304
- application/xml:
305
- schema:
306
- type: array
307
- items:
308
- $ref: '#/components/schemas/Pet'
309
- '400':
310
- description: Invalid tag value
311
- security:
312
- - petstore_auth:
313
- - 'write:pets'
314
- - 'read:pets'
315
- /store/inventory:
316
- get:
317
- tags:
318
- - store
319
- summary: Returns pet inventories by status
320
- description: Returns a map of status codes to quantities
321
- operationId: getInventory
322
- responses:
323
- '200':
324
- description: successful operation
325
- content:
326
- application/json:
327
- schema:
328
- type: object
329
- additionalProperties:
330
- type: integer
331
- format: int32
332
- security:
333
- - api_key: []
334
- /store/order:
335
- post:
336
- tags:
337
- - store
338
- summary: Place an order for a pet
339
- description: ''
340
- operationId: placeOrder
341
- responses:
342
- '200':
343
- description: successful operation
344
- content:
345
- application/json:
346
- schema:
347
- $ref: '#/components/schemas/Order'
348
- application/xml:
349
- schema:
350
- $ref: '#/components/schemas/Order'
351
- '400':
352
- description: Invalid Order
353
- content:
354
- application/json:
355
- example:
356
- status: 400
357
- message: "Invalid Order"
358
- requestBody:
359
- content:
360
- application/json:
361
- schema:
362
- $ref: '#/components/schemas/Order'
363
- description: order placed for purchasing the pet
364
- required: true
365
- '/store/order/{orderId}':
366
- get:
367
- tags:
368
- - store
369
- summary: Find purchase order by ID
370
- description: >-
371
- For valid response try integer IDs with value <= 5 or > 10. Other values
372
- will generated exceptions
373
- operationId: getOrderById
374
- parameters:
375
- - name: orderId
376
- in: path
377
- description: ID of pet that needs to be fetched
378
- required: true
379
- schema:
380
- type: integer
381
- format: int64
382
- minimum: 1
383
- maximum: 5
384
- responses:
385
- '200':
386
- description: successful operation
387
- content:
388
- application/json:
389
- schema:
390
- $ref: '#/components/schemas/Order'
391
- application/xml:
392
- schema:
393
- $ref: '#/components/schemas/Order'
394
- '400':
395
- description: Invalid ID supplied
396
- '404':
397
- description: Order not found
398
- delete:
399
- tags:
400
- - store
401
- summary: Delete purchase order by ID
402
- description: >-
403
- For valid response try integer IDs with value < 1000. Anything above
404
- 1000 or nonintegers will generate API errors
405
- operationId: deleteOrder
406
- parameters:
407
- - name: orderId
408
- in: path
409
- description: ID of the order that needs to be deleted
410
- required: true
411
- schema:
412
- type: string
413
- minimum: 1
414
- responses:
415
- '400':
416
- description: Invalid ID supplied
417
- '404':
418
- description: Order not found
419
- /user:
420
- post:
421
- tags:
422
- - user
423
- summary: Create user
424
- description: This can only be done by the logged in user.
425
- operationId: createUser
426
- responses:
427
- default:
428
- description: successful operation
429
- requestBody:
430
- content:
431
- application/json:
432
- schema:
433
- $ref: '#/components/schemas/User'
434
- description: Created user object
435
- required: true
436
- '/user/{username}':
437
- get:
438
- tags:
439
- - user
440
- summary: Get user by user name
441
- description: ''
442
- operationId: getUserByName
443
- parameters:
444
- - name: username
445
- in: path
446
- description: 'The name that needs to be fetched. Use user1 for testing. '
447
- required: true
448
- schema:
449
- type: string
450
- responses:
451
- '200':
452
- description: successful operation
453
- content:
454
- application/json:
455
- schema:
456
- $ref: '#/components/schemas/User'
457
- application/xml:
458
- schema:
459
- $ref: '#/components/schemas/User'
460
- '400':
461
- description: Invalid username supplied
462
- '404':
463
- description: User not found
464
- put:
465
- tags:
466
- - user
467
- summary: Updated user
468
- description: This can only be done by the logged in user.
469
- operationId: updateUser
470
- parameters:
471
- - name: username
472
- in: path
473
- description: name that need to be deleted
474
- required: true
475
- schema:
476
- type: string
477
- responses:
478
- '400':
479
- description: Invalid user supplied
480
- '404':
481
- description: User not found
482
- requestBody:
483
- content:
484
- application/json:
485
- schema:
486
- $ref: '#/components/schemas/User'
487
- description: Updated user object
488
- required: true
489
- delete:
490
- tags:
491
- - user
492
- summary: Delete user
493
- description: This can only be done by the logged in user.
494
- operationId: deleteUser
495
- parameters:
496
- - name: username
497
- in: path
498
- description: The name that needs to be deleted
499
- required: true
500
- schema:
501
- type: string
502
- responses:
503
- '400':
504
- description: Invalid username supplied
505
- '404':
506
- description: User not found
507
- /user/createWithArray:
508
- post:
509
- tags:
510
- - user
511
- summary: Creates list of users with given input array
512
- description: ''
513
- operationId: createUsersWithArrayInput
514
- responses:
515
- default:
516
- description: successful operation
517
- requestBody:
518
- $ref: '#/components/requestBodies/UserArray'
519
- /user/createWithList:
520
- post:
521
- tags:
522
- - user
523
- summary: Creates list of users with given input array
524
- description: ''
525
- operationId: createUsersWithListInput
526
- responses:
527
- default:
528
- description: successful operation
529
- requestBody:
530
- $ref: '#/components/requestBodies/UserArray'
531
- /user/login:
532
- get:
533
- tags:
534
- - user
535
- summary: Logs user into the system
536
- description: ''
537
- operationId: loginUser
538
- parameters:
539
- - name: username
540
- in: query
541
- description: The user name for login
542
- required: true
543
- schema:
544
- type: string
545
- - name: password
546
- in: query
547
- description: The password for login in clear text
548
- required: true
549
- schema:
550
- type: string
551
- responses:
552
- '200':
553
- description: successful operation
554
- headers:
555
- X-Rate-Limit:
556
- description: calls per hour allowed by the user
557
- schema:
558
- type: integer
559
- format: int32
560
- X-Expires-After:
561
- description: date in UTC when toekn expires
562
- schema:
563
- type: string
564
- format: date-time
565
- content:
566
- application/json:
567
- schema:
568
- type: string
569
- examples:
570
- response:
571
- value: OK
572
- application/xml:
573
- schema:
574
- type: string
575
- examples:
576
- response:
577
- value: <Message> OK </Message>
578
- text/plain:
579
- examples:
580
- response:
581
- value: OK
582
- '400':
583
- description: Invalid username/password supplied
584
- /user/logout:
585
- get:
586
- tags:
587
- - user
588
- summary: Logs out current logged in user session
589
- description: ''
590
- operationId: logoutUser
591
- responses:
592
- default:
593
- description: successful operation
594
- components:
595
- schemas:
596
- ApiResponse:
597
- type: object
598
- properties:
599
- code:
600
- type: integer
601
- format: int32
602
- type:
603
- type: string
604
- message:
605
- type: string
606
- Cat:
607
- description: A representation of a cat
608
- allOf:
609
- - $ref: '#/components/schemas/Pet'
610
- - type: object
611
- properties:
612
- huntingSkill:
613
- type: string
614
- description: The measured skill for hunting
615
- default: lazy
616
- enum:
617
- - clueless
618
- - lazy
619
- - adventurous
620
- - aggressive
621
- required:
622
- - huntingSkill
623
- Category:
624
- type: object
625
- description: Classification Id and Name
626
- properties:
627
- id:
628
- description: Category ID
629
- allOf:
630
- - $ref: '#/components/schemas/Id'
631
- name:
632
- description: Category name
633
- type: string
634
- minLength: 1
635
- sub:
636
- description: Test Sub Category
637
- type: object
638
- properties:
639
- prop1:
640
- type: string
641
- description: Dumb Property
642
- xml:
643
- name: Category
644
- Dog:
645
- description: A representation of a dog
646
- allOf:
647
- - $ref: '#/components/schemas/Pet'
648
- - type: object
649
- properties:
650
- packSize:
651
- type: integer
652
- format: int32
653
- description: The size of the pack the dog is from
654
- default: 1
655
- minimum: 1
656
- required:
657
- - packSize
658
- HoneyBee:
659
- description: A representation of a honey bee
660
- allOf:
661
- - $ref: '#/components/schemas/Pet'
662
- - type: object
663
- properties:
664
- honeyPerDay:
665
- type: number
666
- description: Average amount of honey produced per day in ounces
667
- example: 3.14
668
- required:
669
- - honeyPerDay
670
- Id:
671
- type: integer
672
- format: int64
673
- readOnly: true
674
- Order:
675
- type: object
676
- properties:
677
- id:
678
- description: Order ID
679
- allOf:
680
- - $ref: '#/components/schemas/Id'
681
- petId:
682
- description: Pet ID
683
- allOf:
684
- - $ref: '#/components/schemas/Id'
685
- quantity:
686
- type: integer
687
- format: int32
688
- minimum: 1
689
- default: 1
690
- shipDate:
691
- description: Estimated ship date
692
- type: string
693
- format: date-time
694
- status:
695
- type: string
696
- description: Order Status
697
- enum:
698
- - placed
699
- - approved
700
- - delivered
701
- complete:
702
- description: Indicates whenever order was completed or not
703
- type: boolean
704
- default: false
705
- readOnly: true
706
- rqeuestId:
707
- description: Unique Request Id
708
- type: string
709
- writeOnly: true
710
- xml:
711
- name: Order
712
- Pet:
713
- type: object
714
- required:
715
- - name
716
- - photoUrls
717
- discriminator:
718
- propertyName: petType
719
- mapping:
720
- cat: '#/components/schemas/Cat'
721
- dog: '#/components/schemas/Dog'
722
- bee: '#/components/schemas/HoneyBee'
723
- properties:
724
- id:
725
- externalDocs:
726
- description: "Find more info here"
727
- url: "https://example.com"
728
- description: Pet ID
729
- allOf:
730
- - $ref: '#/components/schemas/Id'
731
- category:
732
- description: Categories this pet belongs to
733
- allOf:
734
- - $ref: '#/components/schemas/Category'
735
- name:
736
- description: The name given to a pet
737
- type: string
738
- example: Guru
739
- photoUrls:
740
- description: The list of URL to a cute photos featuring pet
741
- type: array
742
- maxItems: 20
743
- xml:
744
- name: photoUrl
745
- wrapped: true
746
- items:
747
- type: string
748
- format: url
749
- friend:
750
- allOf:
751
- - $ref: '#/components/schemas/Pet'
752
- tags:
753
- description: Tags attached to the pet
754
- type: array
755
- minItems: 1
756
- xml:
757
- name: tag
758
- wrapped: true
759
- items:
760
- $ref: '#/components/schemas/Tag'
761
- status:
762
- type: string
763
- description: Pet status in the store
764
- enum:
765
- - available
766
- - pending
767
- - sold
768
- petType:
769
- description: Type of a pet
770
- type: string
771
- xml:
772
- name: Pet
773
- Tag:
774
- type: object
775
- description: Used for taging resources
776
- properties:
777
- id:
778
- description: Tag ID
779
- allOf:
780
- - $ref: '#/components/schemas/Id'
781
- name:
782
- description: Tag name
783
- type: string
784
- minLength: 1
785
- xml:
786
- name: Tag
787
- User:
788
- type: object
789
- properties:
790
- id:
791
- $ref: '#/components/schemas/Id'
792
- pet:
793
- oneOf:
794
- - $ref: '#/components/schemas/Pet'
795
- - $ref: '#/components/schemas/Tag'
796
- username:
797
- description: User supplied username
798
- type: string
799
- minLength: 4
800
- example: John78
801
- firstName:
802
- description: User first name
803
- type: string
804
- minLength: 1
805
- example: John
806
- lastName:
807
- description: User last name
808
- type: string
809
- minLength: 1
810
- example: Smith
811
- email:
812
- description: User email address
813
- type: string
814
- format: email
815
- example: john.smith@example.com
816
- password:
817
- type: string
818
- description: >-
819
- User password, MUST contain a mix of upper and lower case letters,
820
- as well as digits
821
- format: password
822
- minLength: 8
823
- pattern: '/(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])/'
824
- example: drowssaP123
825
- phone:
826
- description: User phone number in international format
827
- type: string
828
- pattern: '/^\+(?:[0-9]-?){6,14}[0-9]$/'
829
- example: +1-202-555-0192
830
- nullable: true
831
- userStatus:
832
- description: User status
833
- type: integer
834
- format: int32
835
- xml:
836
- name: User
837
- requestBodies:
838
- Pet:
839
- content:
840
- application/json:
841
- schema:
842
- allOf:
843
- - description: My Pet
844
- title: Pettie
845
- - $ref: '#/components/schemas/Pet'
846
- application/xml:
847
- schema:
848
- type: 'object'
849
- properties:
850
- name:
851
- type: string
852
- description: hooray
853
- description: Pet object that needs to be added to the store
854
- required: true
855
- UserArray:
856
- content:
857
- application/json:
858
- schema:
859
- type: array
860
- items:
861
- $ref: '#/components/schemas/User'
862
- description: List of user object
863
- required: true
864
- securitySchemes:
865
- petstore_auth:
866
- description: |
867
- Get access to data while protecting your account credentials.
868
- OAuth2 is also a safer and more secure way to give you access.
869
- type: oauth2
870
- flows:
871
- implicit:
872
- authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
873
- scopes:
874
- 'write:pets': modify pets in your account
875
- 'read:pets': read your pets
876
- api_key:
877
- description: >
878
- For this sample, you can use the api key `special-key` to test the
879
- authorization filters.
880
- type: apiKey
881
- name: api_key
882
- in: header
883
- examples:
884
- Order:
885
- value:
886
- quantity: 1,
887
- shipDate: 2018-10-19T16:46:45Z,
888
- status: placed,
889
- complete: false