@budibase/server 2.6.19-alpha.2 → 2.6.19-alpha.21

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 (387) hide show
  1. package/.dockerignore +7 -6
  2. package/Dockerfile +16 -8
  3. package/builder/assets/{index.6c1171e2.js → index.47cc7efc.js} +343 -334
  4. package/builder/assets/{index.07382a47.css → index.ffb6a106.css} +2 -2
  5. package/builder/index.html +2 -2
  6. package/client/manifest.json +5229 -0
  7. package/dist/automation.js +32364 -0
  8. package/dist/automation.js.map +7 -0
  9. package/dist/index.js +44582 -13
  10. package/dist/index.js.map +7 -0
  11. package/dist/query.js +24345 -0
  12. package/dist/query.js.map +7 -0
  13. package/jest.config.ts +3 -0
  14. package/nodemon.json +1 -1
  15. package/package.json +30 -13
  16. package/pm2.config.js +1 -1
  17. package/scripts/build.js +48 -0
  18. package/src/api/controllers/automation.ts +37 -9
  19. package/src/api/controllers/datasource.ts +16 -0
  20. package/src/api/controllers/row/internal.ts +1 -1
  21. package/src/api/controllers/static/index.ts +3 -3
  22. package/src/api/controllers/table/internal.ts +2 -6
  23. package/src/api/controllers/table/utils.ts +32 -1
  24. package/src/api/controllers/webhook.ts +33 -9
  25. package/src/api/routes/automation.ts +0 -1
  26. package/src/api/routes/datasource.ts +5 -0
  27. package/src/api/routes/static.ts +3 -1
  28. package/src/api/routes/tests/{automation.spec.js → automation.spec.ts} +106 -31
  29. package/src/api/routes/tests/datasource.spec.ts +1 -1
  30. package/src/api/routes/tests/{webhook.spec.js → webhook.spec.ts} +33 -11
  31. package/src/automations/actions.ts +8 -0
  32. package/src/automations/steps/bash.ts +4 -0
  33. package/src/automations/steps/collect.ts +58 -0
  34. package/src/automations/steps/createRow.ts +4 -0
  35. package/src/automations/steps/delay.ts +1 -0
  36. package/src/automations/steps/deleteRow.ts +4 -0
  37. package/src/automations/steps/discord.ts +4 -0
  38. package/src/automations/steps/executeQuery.ts +4 -0
  39. package/src/automations/steps/executeScript.ts +4 -0
  40. package/src/automations/steps/filter.ts +1 -0
  41. package/src/automations/steps/loop.ts +1 -0
  42. package/src/automations/steps/make.ts +4 -0
  43. package/src/automations/steps/openai.ts +106 -0
  44. package/src/automations/steps/outgoingWebhook.ts +4 -0
  45. package/src/automations/steps/queryRows.ts +4 -0
  46. package/src/automations/steps/sendSmtpEmail.ts +4 -0
  47. package/src/automations/steps/serverLog.ts +4 -0
  48. package/src/automations/steps/slack.ts +4 -0
  49. package/src/automations/steps/updateRow.ts +4 -0
  50. package/src/automations/steps/zapier.ts +4 -0
  51. package/src/automations/tests/openai.spec.ts +86 -0
  52. package/src/automations/triggers.ts +3 -2
  53. package/src/constants/index.ts +17 -16
  54. package/src/db/inMemoryView.ts +1 -0
  55. package/src/environment.ts +2 -0
  56. package/src/integration-test/postgres.spec.ts +47 -4
  57. package/src/integrations/airtable.ts +3 -1
  58. package/src/integrations/arangodb.ts +3 -1
  59. package/src/integrations/base/sqlTable.ts +0 -1
  60. package/src/integrations/couchdb.ts +3 -1
  61. package/src/integrations/dynamodb.ts +3 -1
  62. package/src/integrations/elasticsearch.ts +3 -1
  63. package/src/integrations/firebase.ts +3 -1
  64. package/src/integrations/googlesheets.ts +11 -3
  65. package/src/integrations/microsoftSqlServer.ts +18 -2
  66. package/src/integrations/mongodb.ts +3 -1
  67. package/src/integrations/mysql.ts +27 -11
  68. package/src/integrations/oracle.ts +11 -1
  69. package/src/integrations/postgres.ts +27 -10
  70. package/src/integrations/redis.ts +3 -1
  71. package/src/integrations/s3.ts +3 -1
  72. package/src/integrations/snowflake.ts +3 -1
  73. package/src/integrations/tests/googlesheets.spec.ts +41 -9
  74. package/src/sdk/app/automations/index.ts +2 -0
  75. package/src/sdk/app/automations/utils.ts +7 -0
  76. package/src/tests/utilities/TestConfiguration.ts +4 -2
  77. package/src/tests/utilities/structures.ts +42 -0
  78. package/src/threads/automation.ts +39 -0
  79. package/src/utilities/fileSystem/app.ts +1 -1
  80. package/src/utilities/fileSystem/clientLibrary.ts +8 -3
  81. package/src/utilities/fileSystem/filesystem.ts +3 -1
  82. package/tsconfig.build.json +9 -1
  83. package/tsconfig.json +1 -14
  84. package/dist/api/controllers/analytics.js +0 -46
  85. package/dist/api/controllers/apikeys.js +0 -72
  86. package/dist/api/controllers/application.js +0 -574
  87. package/dist/api/controllers/auth.js +0 -80
  88. package/dist/api/controllers/automation.js +0 -303
  89. package/dist/api/controllers/backup.js +0 -37
  90. package/dist/api/controllers/component.js +0 -59
  91. package/dist/api/controllers/datasource.js +0 -337
  92. package/dist/api/controllers/deploy/Deployment.js +0 -53
  93. package/dist/api/controllers/deploy/index.js +0 -198
  94. package/dist/api/controllers/dev.js +0 -146
  95. package/dist/api/controllers/integration.js +0 -28
  96. package/dist/api/controllers/layout.js +0 -49
  97. package/dist/api/controllers/metadata.js +0 -63
  98. package/dist/api/controllers/migrations.js +0 -29
  99. package/dist/api/controllers/ops.js +0 -40
  100. package/dist/api/controllers/permission.js +0 -162
  101. package/dist/api/controllers/plugin/file.js +0 -24
  102. package/dist/api/controllers/plugin/github.js +0 -69
  103. package/dist/api/controllers/plugin/index.js +0 -112
  104. package/dist/api/controllers/plugin/npm.js +0 -58
  105. package/dist/api/controllers/plugin/uploaders.js +0 -11
  106. package/dist/api/controllers/plugin/url.js +0 -24
  107. package/dist/api/controllers/plugin/utils.js +0 -27
  108. package/dist/api/controllers/public/applications.js +0 -146
  109. package/dist/api/controllers/public/mapping/applications.js +0 -29
  110. package/dist/api/controllers/public/mapping/index.js +0 -11
  111. package/dist/api/controllers/public/mapping/queries.js +0 -36
  112. package/dist/api/controllers/public/mapping/rows.js +0 -24
  113. package/dist/api/controllers/public/mapping/tables.js +0 -23
  114. package/dist/api/controllers/public/mapping/types.js +0 -2
  115. package/dist/api/controllers/public/mapping/users.js +0 -29
  116. package/dist/api/controllers/public/metrics.js +0 -113
  117. package/dist/api/controllers/public/queries.js +0 -58
  118. package/dist/api/controllers/public/rows.js +0 -120
  119. package/dist/api/controllers/public/tables.js +0 -95
  120. package/dist/api/controllers/public/users.js +0 -93
  121. package/dist/api/controllers/public/utils.js +0 -56
  122. package/dist/api/controllers/query/import/index.js +0 -87
  123. package/dist/api/controllers/query/import/sources/base/index.js +0 -75
  124. package/dist/api/controllers/query/import/sources/base/openapi.js +0 -42
  125. package/dist/api/controllers/query/import/sources/curl.js +0 -99
  126. package/dist/api/controllers/query/import/sources/openapi2.js +0 -145
  127. package/dist/api/controllers/query/import/sources/openapi3.js +0 -177
  128. package/dist/api/controllers/query/import/sources/tests/openapi2/data/crud/crud.json +0 -253
  129. package/dist/api/controllers/query/import/sources/tests/openapi2/data/petstore/petstore.json +0 -1054
  130. package/dist/api/controllers/query/import/sources/tests/openapi3/data/crud/crud.json +0 -253
  131. package/dist/api/controllers/query/import/sources/tests/openapi3/data/petstore/petstore.json +0 -1225
  132. package/dist/api/controllers/query/index.js +0 -299
  133. package/dist/api/controllers/query/validation.js +0 -53
  134. package/dist/api/controllers/role.js +0 -109
  135. package/dist/api/controllers/routing.js +0 -105
  136. package/dist/api/controllers/row/ExternalRequest.js +0 -683
  137. package/dist/api/controllers/row/external.js +0 -339
  138. package/dist/api/controllers/row/index.js +0 -203
  139. package/dist/api/controllers/row/internal.js +0 -509
  140. package/dist/api/controllers/row/internalSearch.js +0 -28
  141. package/dist/api/controllers/row/staticFormula.js +0 -165
  142. package/dist/api/controllers/row/utils.js +0 -183
  143. package/dist/api/controllers/screen.js +0 -110
  144. package/dist/api/controllers/script.js +0 -30
  145. package/dist/api/controllers/static/index.js +0 -268
  146. package/dist/api/controllers/table/bulkFormula.js +0 -173
  147. package/dist/api/controllers/table/external.js +0 -279
  148. package/dist/api/controllers/table/index.js +0 -179
  149. package/dist/api/controllers/table/internal.js +0 -197
  150. package/dist/api/controllers/table/utils.js +0 -379
  151. package/dist/api/controllers/templates.js +0 -56
  152. package/dist/api/controllers/user.js +0 -124
  153. package/dist/api/controllers/view/exporters.js +0 -46
  154. package/dist/api/controllers/view/index.js +0 -193
  155. package/dist/api/controllers/view/utils.js +0 -177
  156. package/dist/api/controllers/view/viewBuilder.js +0 -158
  157. package/dist/api/controllers/webhook.js +0 -134
  158. package/dist/api/index.js +0 -55
  159. package/dist/api/routes/analytics.js +0 -34
  160. package/dist/api/routes/apikeys.js +0 -37
  161. package/dist/api/routes/application.js +0 -48
  162. package/dist/api/routes/auth.js +0 -33
  163. package/dist/api/routes/automation.js +0 -50
  164. package/dist/api/routes/backup.js +0 -35
  165. package/dist/api/routes/component.js +0 -35
  166. package/dist/api/routes/datasource.js +0 -44
  167. package/dist/api/routes/deploy.js +0 -37
  168. package/dist/api/routes/dev.js +0 -49
  169. package/dist/api/routes/index.js +0 -75
  170. package/dist/api/routes/integration.js +0 -37
  171. package/dist/api/routes/layout.js +0 -37
  172. package/dist/api/routes/metadata.js +0 -40
  173. package/dist/api/routes/migrations.js +0 -36
  174. package/dist/api/routes/ops.js +0 -52
  175. package/dist/api/routes/permission.js +0 -44
  176. package/dist/api/routes/plugin.js +0 -39
  177. package/dist/api/routes/public/applications.js +0 -174
  178. package/dist/api/routes/public/index.js +0 -140
  179. package/dist/api/routes/public/metrics.js +0 -30
  180. package/dist/api/routes/public/middleware/mapper.js +0 -97
  181. package/dist/api/routes/public/queries.js +0 -72
  182. package/dist/api/routes/public/rows.js +0 -158
  183. package/dist/api/routes/public/tables.js +0 -152
  184. package/dist/api/routes/public/users.js +0 -135
  185. package/dist/api/routes/public/utils/Endpoint.js +0 -36
  186. package/dist/api/routes/query.js +0 -47
  187. package/dist/api/routes/role.js +0 -40
  188. package/dist/api/routes/routing.js +0 -39
  189. package/dist/api/routes/row.js +0 -239
  190. package/dist/api/routes/screen.js +0 -39
  191. package/dist/api/routes/script.js +0 -35
  192. package/dist/api/routes/static.js +0 -80
  193. package/dist/api/routes/table.js +0 -163
  194. package/dist/api/routes/templates.js +0 -37
  195. package/dist/api/routes/user.js +0 -43
  196. package/dist/api/routes/utils/validators.js +0 -238
  197. package/dist/api/routes/view.js +0 -42
  198. package/dist/api/routes/webhook.js +0 -43
  199. package/dist/app.js +0 -132
  200. package/dist/automations/actions.js +0 -137
  201. package/dist/automations/automationUtils.js +0 -173
  202. package/dist/automations/bullboard.js +0 -71
  203. package/dist/automations/index.js +0 -43
  204. package/dist/automations/logging/index.js +0 -53
  205. package/dist/automations/steps/bash.js +0 -111
  206. package/dist/automations/steps/createRow.js +0 -108
  207. package/dist/automations/steps/delay.js +0 -53
  208. package/dist/automations/steps/deleteRow.js +0 -96
  209. package/dist/automations/steps/discord.js +0 -116
  210. package/dist/automations/steps/executeQuery.js +0 -134
  211. package/dist/automations/steps/executeScript.js +0 -106
  212. package/dist/automations/steps/filter.js +0 -112
  213. package/dist/automations/steps/loop.js +0 -54
  214. package/dist/automations/steps/make.js +0 -134
  215. package/dist/automations/steps/outgoingWebhook.js +0 -166
  216. package/dist/automations/steps/queryRows.js +0 -216
  217. package/dist/automations/steps/sendSmtpEmail.js +0 -115
  218. package/dist/automations/steps/serverLog.js +0 -65
  219. package/dist/automations/steps/slack.js +0 -98
  220. package/dist/automations/steps/updateRow.js +0 -144
  221. package/dist/automations/steps/utils.js +0 -56
  222. package/dist/automations/steps/zapier.js +0 -130
  223. package/dist/automations/triggerInfo/app.js +0 -36
  224. package/dist/automations/triggerInfo/cron.js +0 -35
  225. package/dist/automations/triggerInfo/index.js +0 -40
  226. package/dist/automations/triggerInfo/rowDeleted.js +0 -36
  227. package/dist/automations/triggerInfo/rowSaved.js +0 -44
  228. package/dist/automations/triggerInfo/rowUpdated.js +0 -44
  229. package/dist/automations/triggerInfo/webhook.js +0 -40
  230. package/dist/automations/triggers.js +0 -181
  231. package/dist/automations/utils.js +0 -275
  232. package/dist/constants/definitions.js +0 -2
  233. package/dist/constants/index.js +0 -181
  234. package/dist/constants/layouts.js +0 -148
  235. package/dist/constants/screens.js +0 -51
  236. package/dist/db/defaultData/datasource_bb_default.js +0 -574
  237. package/dist/db/defaultData/employeeImport.js +0 -155
  238. package/dist/db/defaultData/expensesImport.js +0 -117
  239. package/dist/db/defaultData/inventoryImport.js +0 -109
  240. package/dist/db/defaultData/jobsImport.js +0 -152
  241. package/dist/db/dynamoClient.js +0 -124
  242. package/dist/db/inMemoryView.js +0 -62
  243. package/dist/db/index.js +0 -43
  244. package/dist/db/linkedRows/LinkController.js +0 -392
  245. package/dist/db/linkedRows/LinkDocument.js +0 -33
  246. package/dist/db/linkedRows/index.js +0 -206
  247. package/dist/db/linkedRows/linkUtils.js +0 -131
  248. package/dist/db/newid.js +0 -7
  249. package/dist/db/utils.js +0 -248
  250. package/dist/db/views/staticViews.js +0 -144
  251. package/dist/ddApm.js +0 -11
  252. package/dist/definitions/automations.js +0 -8
  253. package/dist/definitions/common.js +0 -2
  254. package/dist/definitions/datasource.js +0 -7
  255. package/dist/definitions/openapi.js +0 -6
  256. package/dist/environment.js +0 -109
  257. package/dist/events/AutomationEmitter.js +0 -53
  258. package/dist/events/BudibaseEmitter.js +0 -25
  259. package/dist/events/docUpdates/index.js +0 -17
  260. package/dist/events/docUpdates/processors.js +0 -18
  261. package/dist/events/docUpdates/syncUsers.js +0 -49
  262. package/dist/events/index.js +0 -11
  263. package/dist/events/utils.js +0 -43
  264. package/dist/integrations/airtable.js +0 -173
  265. package/dist/integrations/arangodb.js +0 -119
  266. package/dist/integrations/base/query.js +0 -32
  267. package/dist/integrations/base/sql.js +0 -600
  268. package/dist/integrations/base/sqlTable.js +0 -167
  269. package/dist/integrations/base/types.js +0 -2
  270. package/dist/integrations/couchdb.js +0 -140
  271. package/dist/integrations/dynamodb.js +0 -210
  272. package/dist/integrations/elasticsearch.js +0 -201
  273. package/dist/integrations/firebase.js +0 -189
  274. package/dist/integrations/googlesheets.js +0 -484
  275. package/dist/integrations/index.js +0 -138
  276. package/dist/integrations/microsoftSqlServer.js +0 -289
  277. package/dist/integrations/mongodb.js +0 -630
  278. package/dist/integrations/mysql.js +0 -272
  279. package/dist/integrations/oracle.js +0 -404
  280. package/dist/integrations/postgres.js +0 -319
  281. package/dist/integrations/queries/sql.js +0 -84
  282. package/dist/integrations/redis.js +0 -187
  283. package/dist/integrations/rest.js +0 -400
  284. package/dist/integrations/s3.js +0 -256
  285. package/dist/integrations/snowflake.js +0 -114
  286. package/dist/integrations/utils.js +0 -295
  287. package/dist/middleware/appInfo.js +0 -22
  288. package/dist/middleware/authorized.js +0 -112
  289. package/dist/middleware/builder.js +0 -93
  290. package/dist/middleware/currentapp.js +0 -103
  291. package/dist/middleware/joi-validator.js +0 -43
  292. package/dist/middleware/publicApi.js +0 -25
  293. package/dist/middleware/resourceId.js +0 -59
  294. package/dist/middleware/selfhost.js +0 -24
  295. package/dist/middleware/utils.js +0 -8
  296. package/dist/migrations/functions/appUrls.js +0 -42
  297. package/dist/migrations/functions/backfill/app/automations.js +0 -31
  298. package/dist/migrations/functions/backfill/app/datasources.js +0 -28
  299. package/dist/migrations/functions/backfill/app/layouts.js +0 -33
  300. package/dist/migrations/functions/backfill/app/queries.js +0 -49
  301. package/dist/migrations/functions/backfill/app/roles.js +0 -28
  302. package/dist/migrations/functions/backfill/app/screens.js +0 -28
  303. package/dist/migrations/functions/backfill/app/tables.js +0 -37
  304. package/dist/migrations/functions/backfill/app.js +0 -176
  305. package/dist/migrations/functions/backfill/global/configs.js +0 -67
  306. package/dist/migrations/functions/backfill/global/quotas.js +0 -60
  307. package/dist/migrations/functions/backfill/global/users.js +0 -50
  308. package/dist/migrations/functions/backfill/global.js +0 -205
  309. package/dist/migrations/functions/backfill/index.js +0 -32
  310. package/dist/migrations/functions/backfill/installation.js +0 -80
  311. package/dist/migrations/functions/syncQuotas.js +0 -52
  312. package/dist/migrations/functions/tableSettings.js +0 -130
  313. package/dist/migrations/functions/usageQuotas/index.js +0 -16
  314. package/dist/migrations/functions/usageQuotas/syncApps.js +0 -24
  315. package/dist/migrations/functions/usageQuotas/syncPlugins.js +0 -23
  316. package/dist/migrations/functions/usageQuotas/syncRows.js +0 -33
  317. package/dist/migrations/functions/usageQuotas/syncUsers.js +0 -21
  318. package/dist/migrations/functions/userEmailViewCasing.js +0 -24
  319. package/dist/migrations/index.js +0 -111
  320. package/dist/migrations/tests/helpers.js +0 -72
  321. package/dist/migrations/tests/structures.js +0 -37
  322. package/dist/sdk/app/applications/index.js +0 -28
  323. package/dist/sdk/app/applications/sync.js +0 -164
  324. package/dist/sdk/app/applications/utils.js +0 -21
  325. package/dist/sdk/app/automations/index.js +0 -29
  326. package/dist/sdk/app/automations/webhook.js +0 -54
  327. package/dist/sdk/app/backups/constants.js +0 -6
  328. package/dist/sdk/app/backups/exports.js +0 -160
  329. package/dist/sdk/app/backups/imports.js +0 -170
  330. package/dist/sdk/app/backups/index.js +0 -29
  331. package/dist/sdk/app/backups/statistics.js +0 -73
  332. package/dist/sdk/app/datasources/datasources.js +0 -173
  333. package/dist/sdk/app/datasources/index.js +0 -27
  334. package/dist/sdk/app/queries/index.js +0 -27
  335. package/dist/sdk/app/queries/queries.js +0 -60
  336. package/dist/sdk/app/rows/attachments.js +0 -61
  337. package/dist/sdk/app/rows/index.js +0 -28
  338. package/dist/sdk/app/rows/rows.js +0 -30
  339. package/dist/sdk/app/tables/index.js +0 -65
  340. package/dist/sdk/index.js +0 -27
  341. package/dist/sdk/plugins/index.js +0 -27
  342. package/dist/sdk/plugins/plugins.js +0 -53
  343. package/dist/sdk/users/index.js +0 -27
  344. package/dist/sdk/users/utils.js +0 -87
  345. package/dist/sdk/utils/index.js +0 -29
  346. package/dist/startup.js +0 -158
  347. package/dist/threads/automation.js +0 -450
  348. package/dist/threads/definitions.js +0 -2
  349. package/dist/threads/index.js +0 -140
  350. package/dist/threads/query.js +0 -265
  351. package/dist/threads/utils.js +0 -120
  352. package/dist/tsconfig.build.tsbuildinfo +0 -1
  353. package/dist/utilities/appDirectoryTemplate/package.json +0 -10
  354. package/dist/utilities/budibaseDir.js +0 -5
  355. package/dist/utilities/centralPath.js +0 -27
  356. package/dist/utilities/csv.js +0 -33
  357. package/dist/utilities/fileSystem/app.js +0 -88
  358. package/dist/utilities/fileSystem/clientLibrary.js +0 -138
  359. package/dist/utilities/fileSystem/filesystem.js +0 -180
  360. package/dist/utilities/fileSystem/index.js +0 -21
  361. package/dist/utilities/fileSystem/plugin.js +0 -76
  362. package/dist/utilities/fileSystem/processor.js +0 -34
  363. package/dist/utilities/fileSystem/template.js +0 -47
  364. package/dist/utilities/global.js +0 -149
  365. package/dist/utilities/index.js +0 -143
  366. package/dist/utilities/redis.js +0 -117
  367. package/dist/utilities/retry.js +0 -30
  368. package/dist/utilities/routing/index.js +0 -39
  369. package/dist/utilities/rowProcessor/index.js +0 -282
  370. package/dist/utilities/rowProcessor/map.js +0 -116
  371. package/dist/utilities/rowProcessor/utils.js +0 -87
  372. package/dist/utilities/schema.js +0 -112
  373. package/dist/utilities/scriptRunner.js +0 -26
  374. package/dist/utilities/security.js +0 -57
  375. package/dist/utilities/statusCodes.js +0 -9
  376. package/dist/utilities/usageQuota/rows.js +0 -88
  377. package/dist/utilities/usageQuota/usageQuoteReset.js +0 -16
  378. package/dist/utilities/users.js +0 -57
  379. package/dist/utilities/workerRequests.js +0 -171
  380. package/dist/watch.js +0 -53
  381. package/dist/websockets/client.js +0 -14
  382. package/dist/websockets/grid.js +0 -60
  383. package/dist/websockets/index.js +0 -17
  384. package/dist/websockets/websocket.js +0 -78
  385. /package/dist/{api/controllers/static/templates/BudibaseApp.svelte → BudibaseApp-Y5NZEDTC.svelte} +0 -0
  386. /package/dist/{api/controllers/static/templates/app.hbs → app.hbs} +0 -0
  387. /package/dist/{api/controllers/static/templates/preview.hbs → preview.hbs} +0 -0
@@ -1,1225 +0,0 @@
1
- {
2
- "openapi": "3.0.2",
3
- "info": {
4
- "title": "Swagger Petstore - OpenAPI 3.0",
5
- "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",
6
- "termsOfService": "http://swagger.io/terms/",
7
- "contact": {
8
- "email": "apiteam@swagger.io"
9
- },
10
- "license": {
11
- "name": "Apache 2.0",
12
- "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
13
- },
14
- "version": "1.0.11"
15
- },
16
- "externalDocs": {
17
- "description": "Find out more about Swagger",
18
- "url": "http://swagger.io"
19
- },
20
- "servers": [
21
- {
22
- "url": "/api/v3"
23
- }
24
- ],
25
- "tags": [
26
- {
27
- "name": "pet",
28
- "description": "Everything about your Pets",
29
- "externalDocs": {
30
- "description": "Find out more",
31
- "url": "http://swagger.io"
32
- }
33
- },
34
- {
35
- "name": "store",
36
- "description": "Access to Petstore orders",
37
- "externalDocs": {
38
- "description": "Find out more about our store",
39
- "url": "http://swagger.io"
40
- }
41
- },
42
- {
43
- "name": "user",
44
- "description": "Operations about user"
45
- }
46
- ],
47
- "paths": {
48
- "/pet": {
49
- "put": {
50
- "tags": [
51
- "pet"
52
- ],
53
- "summary": "Update an existing pet",
54
- "description": "Update an existing pet by Id",
55
- "operationId": "updatePet",
56
- "requestBody": {
57
- "description": "Update an existent pet in the store",
58
- "content": {
59
- "application/json": {
60
- "schema": {
61
- "$ref": "#/components/schemas/Pet"
62
- }
63
- },
64
- "application/xml": {
65
- "schema": {
66
- "$ref": "#/components/schemas/Pet"
67
- }
68
- },
69
- "application/x-www-form-urlencoded": {
70
- "schema": {
71
- "$ref": "#/components/schemas/Pet"
72
- }
73
- }
74
- },
75
- "required": true
76
- },
77
- "responses": {
78
- "200": {
79
- "description": "Successful operation",
80
- "content": {
81
- "application/xml": {
82
- "schema": {
83
- "$ref": "#/components/schemas/Pet"
84
- }
85
- },
86
- "application/json": {
87
- "schema": {
88
- "$ref": "#/components/schemas/Pet"
89
- }
90
- }
91
- }
92
- },
93
- "400": {
94
- "description": "Invalid ID supplied"
95
- },
96
- "404": {
97
- "description": "Pet not found"
98
- },
99
- "405": {
100
- "description": "Validation exception"
101
- }
102
- },
103
- "security": [
104
- {
105
- "petstore_auth": [
106
- "write:pets",
107
- "read:pets"
108
- ]
109
- }
110
- ]
111
- },
112
- "post": {
113
- "tags": [
114
- "pet"
115
- ],
116
- "summary": "Add a new pet to the store",
117
- "description": "Add a new pet to the store",
118
- "operationId": "addPet",
119
- "requestBody": {
120
- "description": "Create a new pet in the store",
121
- "content": {
122
- "application/json": {
123
- "schema": {
124
- "$ref": "#/components/schemas/Pet"
125
- }
126
- },
127
- "application/xml": {
128
- "schema": {
129
- "$ref": "#/components/schemas/Pet"
130
- }
131
- },
132
- "application/x-www-form-urlencoded": {
133
- "schema": {
134
- "$ref": "#/components/schemas/Pet"
135
- }
136
- }
137
- },
138
- "required": true
139
- },
140
- "responses": {
141
- "200": {
142
- "description": "Successful operation",
143
- "content": {
144
- "application/xml": {
145
- "schema": {
146
- "$ref": "#/components/schemas/Pet"
147
- }
148
- },
149
- "application/json": {
150
- "schema": {
151
- "$ref": "#/components/schemas/Pet"
152
- }
153
- }
154
- }
155
- },
156
- "405": {
157
- "description": "Invalid input"
158
- }
159
- },
160
- "security": [
161
- {
162
- "petstore_auth": [
163
- "write:pets",
164
- "read:pets"
165
- ]
166
- }
167
- ]
168
- }
169
- },
170
- "/pet/findByStatus": {
171
- "get": {
172
- "tags": [
173
- "pet"
174
- ],
175
- "summary": "Finds Pets by status",
176
- "description": "Multiple status values can be provided with comma separated strings",
177
- "operationId": "findPetsByStatus",
178
- "parameters": [
179
- {
180
- "name": "status",
181
- "in": "query",
182
- "description": "Status values that need to be considered for filter",
183
- "required": false,
184
- "explode": true,
185
- "schema": {
186
- "type": "string",
187
- "default": "available",
188
- "enum": [
189
- "available",
190
- "pending",
191
- "sold"
192
- ]
193
- }
194
- }
195
- ],
196
- "responses": {
197
- "200": {
198
- "description": "successful operation",
199
- "content": {
200
- "application/xml": {
201
- "schema": {
202
- "type": "array",
203
- "items": {
204
- "$ref": "#/components/schemas/Pet"
205
- }
206
- }
207
- },
208
- "application/json": {
209
- "schema": {
210
- "type": "array",
211
- "items": {
212
- "$ref": "#/components/schemas/Pet"
213
- }
214
- }
215
- }
216
- }
217
- },
218
- "400": {
219
- "description": "Invalid status value"
220
- }
221
- },
222
- "security": [
223
- {
224
- "petstore_auth": [
225
- "write:pets",
226
- "read:pets"
227
- ]
228
- }
229
- ]
230
- }
231
- },
232
- "/pet/findByTags": {
233
- "get": {
234
- "tags": [
235
- "pet"
236
- ],
237
- "summary": "Finds Pets by tags",
238
- "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
239
- "operationId": "findPetsByTags",
240
- "parameters": [
241
- {
242
- "name": "tags",
243
- "in": "query",
244
- "description": "Tags to filter by",
245
- "required": false,
246
- "explode": true,
247
- "schema": {
248
- "type": "array",
249
- "items": {
250
- "type": "string"
251
- }
252
- }
253
- }
254
- ],
255
- "responses": {
256
- "200": {
257
- "description": "successful operation",
258
- "content": {
259
- "application/xml": {
260
- "schema": {
261
- "type": "array",
262
- "items": {
263
- "$ref": "#/components/schemas/Pet"
264
- }
265
- }
266
- },
267
- "application/json": {
268
- "schema": {
269
- "type": "array",
270
- "items": {
271
- "$ref": "#/components/schemas/Pet"
272
- }
273
- }
274
- }
275
- }
276
- },
277
- "400": {
278
- "description": "Invalid tag value"
279
- }
280
- },
281
- "security": [
282
- {
283
- "petstore_auth": [
284
- "write:pets",
285
- "read:pets"
286
- ]
287
- }
288
- ]
289
- }
290
- },
291
- "/pet/{petId}": {
292
- "get": {
293
- "tags": [
294
- "pet"
295
- ],
296
- "summary": "Find pet by ID",
297
- "description": "Returns a single pet",
298
- "operationId": "getPetById",
299
- "parameters": [
300
- {
301
- "name": "petId",
302
- "in": "path",
303
- "description": "ID of pet to return",
304
- "required": true,
305
- "schema": {
306
- "type": "integer",
307
- "format": "int64"
308
- }
309
- }
310
- ],
311
- "responses": {
312
- "200": {
313
- "description": "successful operation",
314
- "content": {
315
- "application/xml": {
316
- "schema": {
317
- "$ref": "#/components/schemas/Pet"
318
- }
319
- },
320
- "application/json": {
321
- "schema": {
322
- "$ref": "#/components/schemas/Pet"
323
- }
324
- }
325
- }
326
- },
327
- "400": {
328
- "description": "Invalid ID supplied"
329
- },
330
- "404": {
331
- "description": "Pet not found"
332
- }
333
- },
334
- "security": [
335
- {
336
- "api_key": []
337
- },
338
- {
339
- "petstore_auth": [
340
- "write:pets",
341
- "read:pets"
342
- ]
343
- }
344
- ]
345
- },
346
- "post": {
347
- "tags": [
348
- "pet"
349
- ],
350
- "summary": "Updates a pet in the store with form data",
351
- "description": "",
352
- "operationId": "updatePetWithForm",
353
- "parameters": [
354
- {
355
- "name": "petId",
356
- "in": "path",
357
- "description": "ID of pet that needs to be updated",
358
- "required": true,
359
- "schema": {
360
- "type": "integer",
361
- "format": "int64"
362
- }
363
- },
364
- {
365
- "name": "name",
366
- "in": "query",
367
- "description": "Name of pet that needs to be updated",
368
- "schema": {
369
- "type": "string"
370
- }
371
- },
372
- {
373
- "name": "status",
374
- "in": "query",
375
- "description": "Status of pet that needs to be updated",
376
- "schema": {
377
- "type": "string"
378
- }
379
- }
380
- ],
381
- "responses": {
382
- "405": {
383
- "description": "Invalid input"
384
- }
385
- },
386
- "security": [
387
- {
388
- "petstore_auth": [
389
- "write:pets",
390
- "read:pets"
391
- ]
392
- }
393
- ]
394
- },
395
- "delete": {
396
- "tags": [
397
- "pet"
398
- ],
399
- "summary": "Deletes a pet",
400
- "description": "",
401
- "operationId": "deletePet",
402
- "parameters": [
403
- {
404
- "name": "api_key",
405
- "in": "header",
406
- "description": "",
407
- "required": false,
408
- "schema": {
409
- "type": "string"
410
- }
411
- },
412
- {
413
- "name": "petId",
414
- "in": "path",
415
- "description": "Pet id to delete",
416
- "required": true,
417
- "schema": {
418
- "type": "integer",
419
- "format": "int64"
420
- }
421
- }
422
- ],
423
- "responses": {
424
- "400": {
425
- "description": "Invalid pet value"
426
- }
427
- },
428
- "security": [
429
- {
430
- "petstore_auth": [
431
- "write:pets",
432
- "read:pets"
433
- ]
434
- }
435
- ]
436
- }
437
- },
438
- "/pet/{petId}/uploadImage": {
439
- "post": {
440
- "tags": [
441
- "pet"
442
- ],
443
- "summary": "uploads an image",
444
- "description": "",
445
- "operationId": "uploadFile",
446
- "parameters": [
447
- {
448
- "name": "petId",
449
- "in": "path",
450
- "description": "ID of pet to update",
451
- "required": true,
452
- "schema": {
453
- "type": "integer",
454
- "format": "int64"
455
- }
456
- },
457
- {
458
- "name": "additionalMetadata",
459
- "in": "query",
460
- "description": "Additional Metadata",
461
- "required": false,
462
- "schema": {
463
- "type": "string"
464
- }
465
- }
466
- ],
467
- "requestBody": {
468
- "content": {
469
- "application/octet-stream": {
470
- "schema": {
471
- "type": "string",
472
- "format": "binary"
473
- }
474
- }
475
- }
476
- },
477
- "responses": {
478
- "200": {
479
- "description": "successful operation",
480
- "content": {
481
- "application/json": {
482
- "schema": {
483
- "$ref": "#/components/schemas/ApiResponse"
484
- }
485
- }
486
- }
487
- }
488
- },
489
- "security": [
490
- {
491
- "petstore_auth": [
492
- "write:pets",
493
- "read:pets"
494
- ]
495
- }
496
- ]
497
- }
498
- },
499
- "/store/inventory": {
500
- "get": {
501
- "tags": [
502
- "store"
503
- ],
504
- "summary": "Returns pet inventories by status",
505
- "description": "Returns a map of status codes to quantities",
506
- "operationId": "getInventory",
507
- "responses": {
508
- "200": {
509
- "description": "successful operation",
510
- "content": {
511
- "application/json": {
512
- "schema": {
513
- "type": "object",
514
- "additionalProperties": {
515
- "type": "integer",
516
- "format": "int32"
517
- }
518
- }
519
- }
520
- }
521
- }
522
- },
523
- "security": [
524
- {
525
- "api_key": []
526
- }
527
- ]
528
- }
529
- },
530
- "/store/order": {
531
- "post": {
532
- "tags": [
533
- "store"
534
- ],
535
- "summary": "Place an order for a pet",
536
- "description": "Place a new order in the store",
537
- "operationId": "placeOrder",
538
- "requestBody": {
539
- "content": {
540
- "application/json": {
541
- "schema": {
542
- "$ref": "#/components/schemas/Order"
543
- }
544
- },
545
- "application/xml": {
546
- "schema": {
547
- "$ref": "#/components/schemas/Order"
548
- }
549
- },
550
- "application/x-www-form-urlencoded": {
551
- "schema": {
552
- "$ref": "#/components/schemas/Order"
553
- }
554
- }
555
- }
556
- },
557
- "responses": {
558
- "200": {
559
- "description": "successful operation",
560
- "content": {
561
- "application/json": {
562
- "schema": {
563
- "$ref": "#/components/schemas/Order"
564
- }
565
- }
566
- }
567
- },
568
- "405": {
569
- "description": "Invalid input"
570
- }
571
- }
572
- }
573
- },
574
- "/store/order/{orderId}": {
575
- "get": {
576
- "tags": [
577
- "store"
578
- ],
579
- "summary": "Find purchase order by ID",
580
- "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.",
581
- "operationId": "getOrderById",
582
- "parameters": [
583
- {
584
- "name": "orderId",
585
- "in": "path",
586
- "description": "ID of order that needs to be fetched",
587
- "required": true,
588
- "schema": {
589
- "type": "integer",
590
- "format": "int64"
591
- }
592
- }
593
- ],
594
- "responses": {
595
- "200": {
596
- "description": "successful operation",
597
- "content": {
598
- "application/xml": {
599
- "schema": {
600
- "$ref": "#/components/schemas/Order"
601
- }
602
- },
603
- "application/json": {
604
- "schema": {
605
- "$ref": "#/components/schemas/Order"
606
- }
607
- }
608
- }
609
- },
610
- "400": {
611
- "description": "Invalid ID supplied"
612
- },
613
- "404": {
614
- "description": "Order not found"
615
- }
616
- }
617
- },
618
- "delete": {
619
- "tags": [
620
- "store"
621
- ],
622
- "summary": "Delete purchase order by ID",
623
- "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
624
- "operationId": "deleteOrder",
625
- "parameters": [
626
- {
627
- "name": "orderId",
628
- "in": "path",
629
- "description": "ID of the order that needs to be deleted",
630
- "required": true,
631
- "schema": {
632
- "type": "integer",
633
- "format": "int64"
634
- }
635
- }
636
- ],
637
- "responses": {
638
- "400": {
639
- "description": "Invalid ID supplied"
640
- },
641
- "404": {
642
- "description": "Order not found"
643
- }
644
- }
645
- }
646
- },
647
- "/user": {
648
- "post": {
649
- "tags": [
650
- "user"
651
- ],
652
- "summary": "Create user",
653
- "description": "This can only be done by the logged in user.",
654
- "operationId": "createUser",
655
- "requestBody": {
656
- "description": "Created user object",
657
- "content": {
658
- "application/json": {
659
- "schema": {
660
- "$ref": "#/components/schemas/User"
661
- }
662
- },
663
- "application/xml": {
664
- "schema": {
665
- "$ref": "#/components/schemas/User"
666
- }
667
- },
668
- "application/x-www-form-urlencoded": {
669
- "schema": {
670
- "$ref": "#/components/schemas/User"
671
- }
672
- }
673
- }
674
- },
675
- "responses": {
676
- "default": {
677
- "description": "successful operation",
678
- "content": {
679
- "application/json": {
680
- "schema": {
681
- "$ref": "#/components/schemas/User"
682
- }
683
- },
684
- "application/xml": {
685
- "schema": {
686
- "$ref": "#/components/schemas/User"
687
- }
688
- }
689
- }
690
- }
691
- }
692
- }
693
- },
694
- "/user/createWithList": {
695
- "post": {
696
- "tags": [
697
- "user"
698
- ],
699
- "summary": "Creates list of users with given input array",
700
- "description": "Creates list of users with given input array",
701
- "operationId": "createUsersWithListInput",
702
- "requestBody": {
703
- "content": {
704
- "application/json": {
705
- "schema": {
706
- "type": "array",
707
- "items": {
708
- "$ref": "#/components/schemas/User"
709
- }
710
- }
711
- }
712
- }
713
- },
714
- "responses": {
715
- "200": {
716
- "description": "Successful operation",
717
- "content": {
718
- "application/xml": {
719
- "schema": {
720
- "$ref": "#/components/schemas/User"
721
- }
722
- },
723
- "application/json": {
724
- "schema": {
725
- "$ref": "#/components/schemas/User"
726
- }
727
- }
728
- }
729
- },
730
- "default": {
731
- "description": "successful operation"
732
- }
733
- }
734
- }
735
- },
736
- "/user/login": {
737
- "get": {
738
- "tags": [
739
- "user"
740
- ],
741
- "summary": "Logs user into the system",
742
- "description": "",
743
- "operationId": "loginUser",
744
- "parameters": [
745
- {
746
- "name": "username",
747
- "in": "query",
748
- "description": "The user name for login",
749
- "required": false,
750
- "schema": {
751
- "type": "string"
752
- }
753
- },
754
- {
755
- "name": "password",
756
- "in": "query",
757
- "description": "The password for login in clear text",
758
- "required": false,
759
- "schema": {
760
- "type": "string"
761
- }
762
- }
763
- ],
764
- "responses": {
765
- "200": {
766
- "description": "successful operation",
767
- "headers": {
768
- "X-Rate-Limit": {
769
- "description": "calls per hour allowed by the user",
770
- "schema": {
771
- "type": "integer",
772
- "format": "int32"
773
- }
774
- },
775
- "X-Expires-After": {
776
- "description": "date in UTC when token expires",
777
- "schema": {
778
- "type": "string",
779
- "format": "date-time"
780
- }
781
- }
782
- },
783
- "content": {
784
- "application/xml": {
785
- "schema": {
786
- "type": "string"
787
- }
788
- },
789
- "application/json": {
790
- "schema": {
791
- "type": "string"
792
- }
793
- }
794
- }
795
- },
796
- "400": {
797
- "description": "Invalid username/password supplied"
798
- }
799
- }
800
- }
801
- },
802
- "/user/logout": {
803
- "get": {
804
- "tags": [
805
- "user"
806
- ],
807
- "summary": "Logs out current logged in user session",
808
- "description": "",
809
- "operationId": "logoutUser",
810
- "parameters": [],
811
- "responses": {
812
- "default": {
813
- "description": "successful operation"
814
- }
815
- }
816
- }
817
- },
818
- "/user/{username}": {
819
- "get": {
820
- "tags": [
821
- "user"
822
- ],
823
- "summary": "Get user by user name",
824
- "description": "",
825
- "operationId": "getUserByName",
826
- "parameters": [
827
- {
828
- "name": "username",
829
- "in": "path",
830
- "description": "The name that needs to be fetched. Use user1 for testing. ",
831
- "required": true,
832
- "schema": {
833
- "type": "string"
834
- }
835
- }
836
- ],
837
- "responses": {
838
- "200": {
839
- "description": "successful operation",
840
- "content": {
841
- "application/xml": {
842
- "schema": {
843
- "$ref": "#/components/schemas/User"
844
- }
845
- },
846
- "application/json": {
847
- "schema": {
848
- "$ref": "#/components/schemas/User"
849
- }
850
- }
851
- }
852
- },
853
- "400": {
854
- "description": "Invalid username supplied"
855
- },
856
- "404": {
857
- "description": "User not found"
858
- }
859
- }
860
- },
861
- "put": {
862
- "tags": [
863
- "user"
864
- ],
865
- "summary": "Update user",
866
- "description": "This can only be done by the logged in user.",
867
- "operationId": "updateUser",
868
- "parameters": [
869
- {
870
- "name": "username",
871
- "in": "path",
872
- "description": "name that need to be deleted",
873
- "required": true,
874
- "schema": {
875
- "type": "string"
876
- }
877
- }
878
- ],
879
- "requestBody": {
880
- "description": "Update an existent user in the store",
881
- "content": {
882
- "application/json": {
883
- "schema": {
884
- "$ref": "#/components/schemas/User"
885
- }
886
- },
887
- "application/xml": {
888
- "schema": {
889
- "$ref": "#/components/schemas/User"
890
- }
891
- },
892
- "application/x-www-form-urlencoded": {
893
- "schema": {
894
- "$ref": "#/components/schemas/User"
895
- }
896
- }
897
- }
898
- },
899
- "responses": {
900
- "default": {
901
- "description": "successful operation"
902
- }
903
- }
904
- },
905
- "delete": {
906
- "tags": [
907
- "user"
908
- ],
909
- "summary": "Delete user",
910
- "description": "This can only be done by the logged in user.",
911
- "operationId": "deleteUser",
912
- "parameters": [
913
- {
914
- "name": "username",
915
- "in": "path",
916
- "description": "The name that needs to be deleted",
917
- "required": true,
918
- "schema": {
919
- "type": "string"
920
- }
921
- }
922
- ],
923
- "responses": {
924
- "400": {
925
- "description": "Invalid username supplied"
926
- },
927
- "404": {
928
- "description": "User not found"
929
- }
930
- }
931
- }
932
- }
933
- },
934
- "components": {
935
- "schemas": {
936
- "Order": {
937
- "type": "object",
938
- "properties": {
939
- "id": {
940
- "type": "integer",
941
- "format": "int64",
942
- "example": 10
943
- },
944
- "petId": {
945
- "type": "integer",
946
- "format": "int64",
947
- "example": 198772
948
- },
949
- "quantity": {
950
- "type": "integer",
951
- "format": "int32",
952
- "example": 7
953
- },
954
- "shipDate": {
955
- "type": "string",
956
- "format": "date-time"
957
- },
958
- "status": {
959
- "type": "string",
960
- "description": "Order Status",
961
- "example": "approved",
962
- "enum": [
963
- "placed",
964
- "approved",
965
- "delivered"
966
- ]
967
- },
968
- "complete": {
969
- "type": "boolean"
970
- }
971
- },
972
- "xml": {
973
- "name": "order"
974
- }
975
- },
976
- "Customer": {
977
- "type": "object",
978
- "properties": {
979
- "id": {
980
- "type": "integer",
981
- "format": "int64",
982
- "example": 100000
983
- },
984
- "username": {
985
- "type": "string",
986
- "example": "fehguy"
987
- },
988
- "address": {
989
- "type": "array",
990
- "xml": {
991
- "name": "addresses",
992
- "wrapped": true
993
- },
994
- "items": {
995
- "$ref": "#/components/schemas/Address"
996
- }
997
- }
998
- },
999
- "xml": {
1000
- "name": "customer"
1001
- }
1002
- },
1003
- "Address": {
1004
- "type": "object",
1005
- "properties": {
1006
- "street": {
1007
- "type": "string",
1008
- "example": "437 Lytton"
1009
- },
1010
- "city": {
1011
- "type": "string",
1012
- "example": "Palo Alto"
1013
- },
1014
- "state": {
1015
- "type": "string",
1016
- "example": "CA"
1017
- },
1018
- "zip": {
1019
- "type": "string",
1020
- "example": "94301"
1021
- }
1022
- },
1023
- "xml": {
1024
- "name": "address"
1025
- }
1026
- },
1027
- "Category": {
1028
- "type": "object",
1029
- "properties": {
1030
- "id": {
1031
- "type": "integer",
1032
- "format": "int64",
1033
- "example": 1
1034
- },
1035
- "name": {
1036
- "type": "string",
1037
- "example": "Dogs"
1038
- }
1039
- },
1040
- "xml": {
1041
- "name": "category"
1042
- }
1043
- },
1044
- "User": {
1045
- "type": "object",
1046
- "properties": {
1047
- "id": {
1048
- "type": "integer",
1049
- "format": "int64",
1050
- "example": 10
1051
- },
1052
- "username": {
1053
- "type": "string",
1054
- "example": "theUser"
1055
- },
1056
- "firstName": {
1057
- "type": "string",
1058
- "example": "John"
1059
- },
1060
- "lastName": {
1061
- "type": "string",
1062
- "example": "James"
1063
- },
1064
- "email": {
1065
- "type": "string",
1066
- "example": "john@email.com"
1067
- },
1068
- "password": {
1069
- "type": "string",
1070
- "example": "12345"
1071
- },
1072
- "phone": {
1073
- "type": "string",
1074
- "example": "12345"
1075
- },
1076
- "userStatus": {
1077
- "type": "integer",
1078
- "description": "User Status",
1079
- "format": "int32",
1080
- "example": 1
1081
- }
1082
- },
1083
- "xml": {
1084
- "name": "user"
1085
- }
1086
- },
1087
- "Tag": {
1088
- "type": "object",
1089
- "properties": {
1090
- "id": {
1091
- "type": "integer",
1092
- "format": "int64"
1093
- },
1094
- "name": {
1095
- "type": "string"
1096
- }
1097
- },
1098
- "xml": {
1099
- "name": "tag"
1100
- }
1101
- },
1102
- "Pet": {
1103
- "required": [
1104
- "name",
1105
- "photoUrls"
1106
- ],
1107
- "type": "object",
1108
- "properties": {
1109
- "id": {
1110
- "type": "integer",
1111
- "format": "int64",
1112
- "example": 10
1113
- },
1114
- "name": {
1115
- "type": "string",
1116
- "example": "doggie"
1117
- },
1118
- "category": {
1119
- "$ref": "#/components/schemas/Category"
1120
- },
1121
- "photoUrls": {
1122
- "type": "array",
1123
- "xml": {
1124
- "wrapped": true
1125
- },
1126
- "items": {
1127
- "type": "string",
1128
- "xml": {
1129
- "name": "photoUrl"
1130
- }
1131
- }
1132
- },
1133
- "tags": {
1134
- "type": "array",
1135
- "xml": {
1136
- "wrapped": true
1137
- },
1138
- "items": {
1139
- "$ref": "#/components/schemas/Tag"
1140
- }
1141
- },
1142
- "status": {
1143
- "type": "string",
1144
- "description": "pet status in the store",
1145
- "enum": [
1146
- "available",
1147
- "pending",
1148
- "sold"
1149
- ]
1150
- }
1151
- },
1152
- "xml": {
1153
- "name": "pet"
1154
- }
1155
- },
1156
- "ApiResponse": {
1157
- "type": "object",
1158
- "properties": {
1159
- "code": {
1160
- "type": "integer",
1161
- "format": "int32"
1162
- },
1163
- "type": {
1164
- "type": "string"
1165
- },
1166
- "message": {
1167
- "type": "string"
1168
- }
1169
- },
1170
- "xml": {
1171
- "name": "##default"
1172
- }
1173
- }
1174
- },
1175
- "requestBodies": {
1176
- "Pet": {
1177
- "description": "Pet object that needs to be added to the store",
1178
- "content": {
1179
- "application/json": {
1180
- "schema": {
1181
- "$ref": "#/components/schemas/Pet"
1182
- }
1183
- },
1184
- "application/xml": {
1185
- "schema": {
1186
- "$ref": "#/components/schemas/Pet"
1187
- }
1188
- }
1189
- }
1190
- },
1191
- "UserArray": {
1192
- "description": "List of user object",
1193
- "content": {
1194
- "application/json": {
1195
- "schema": {
1196
- "type": "array",
1197
- "items": {
1198
- "$ref": "#/components/schemas/User"
1199
- }
1200
- }
1201
- }
1202
- }
1203
- }
1204
- },
1205
- "securitySchemes": {
1206
- "petstore_auth": {
1207
- "type": "oauth2",
1208
- "flows": {
1209
- "implicit": {
1210
- "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize",
1211
- "scopes": {
1212
- "write:pets": "modify pets in your account",
1213
- "read:pets": "read your pets"
1214
- }
1215
- }
1216
- }
1217
- },
1218
- "api_key": {
1219
- "type": "apiKey",
1220
- "name": "api_key",
1221
- "in": "header"
1222
- }
1223
- }
1224
- }
1225
- }