@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,1054 +0,0 @@
1
- {
2
- "swagger": "2.0",
3
- "info": {
4
- "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
5
- "version": "1.0.5",
6
- "title": "Swagger Petstore",
7
- "termsOfService": "http://swagger.io/terms/",
8
- "contact": {
9
- "email": "apiteam@swagger.io"
10
- },
11
- "license": {
12
- "name": "Apache 2.0",
13
- "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
14
- }
15
- },
16
- "host": "petstore.swagger.io",
17
- "basePath": "/v2",
18
- "tags": [
19
- {
20
- "name": "pet",
21
- "description": "Everything about your Pets",
22
- "externalDocs": {
23
- "description": "Find out more",
24
- "url": "http://swagger.io"
25
- }
26
- },
27
- {
28
- "name": "store",
29
- "description": "Access to Petstore orders"
30
- },
31
- {
32
- "name": "user",
33
- "description": "Operations about user",
34
- "externalDocs": {
35
- "description": "Find out more about our store",
36
- "url": "http://swagger.io"
37
- }
38
- }
39
- ],
40
- "schemes": [
41
- "https",
42
- "http"
43
- ],
44
- "paths": {
45
- "/pet/{petId}/uploadImage": {
46
- "post": {
47
- "tags": [
48
- "pet"
49
- ],
50
- "summary": "uploads an image",
51
- "description": "",
52
- "operationId": "uploadFile",
53
- "consumes": [
54
- "multipart/form-data"
55
- ],
56
- "produces": [
57
- "application/json"
58
- ],
59
- "parameters": [
60
- {
61
- "name": "petId",
62
- "in": "path",
63
- "description": "ID of pet to update",
64
- "required": true,
65
- "type": "integer",
66
- "format": "int64"
67
- },
68
- {
69
- "name": "additionalMetadata",
70
- "in": "formData",
71
- "description": "Additional data to pass to server",
72
- "required": false,
73
- "type": "string"
74
- },
75
- {
76
- "name": "file",
77
- "in": "formData",
78
- "description": "file to upload",
79
- "required": false,
80
- "type": "file"
81
- }
82
- ],
83
- "responses": {
84
- "200": {
85
- "description": "successful operation",
86
- "schema": {
87
- "$ref": "#/definitions/ApiResponse"
88
- }
89
- }
90
- },
91
- "security": [
92
- {
93
- "petstore_auth": [
94
- "write:pets",
95
- "read:pets"
96
- ]
97
- }
98
- ]
99
- }
100
- },
101
- "/pet": {
102
- "post": {
103
- "tags": [
104
- "pet"
105
- ],
106
- "summary": "Add a new pet to the store",
107
- "description": "",
108
- "operationId": "addPet",
109
- "consumes": [
110
- "application/json",
111
- "application/xml"
112
- ],
113
- "produces": [
114
- "application/json",
115
- "application/xml"
116
- ],
117
- "parameters": [
118
- {
119
- "in": "body",
120
- "name": "body",
121
- "description": "Pet object that needs to be added to the store",
122
- "required": true,
123
- "schema": {
124
- "$ref": "#/definitions/Pet"
125
- }
126
- }
127
- ],
128
- "responses": {
129
- "405": {
130
- "description": "Invalid input"
131
- }
132
- },
133
- "security": [
134
- {
135
- "petstore_auth": [
136
- "write:pets",
137
- "read:pets"
138
- ]
139
- }
140
- ]
141
- },
142
- "put": {
143
- "tags": [
144
- "pet"
145
- ],
146
- "summary": "Update an existing pet",
147
- "description": "",
148
- "operationId": "updatePet",
149
- "consumes": [
150
- "application/json",
151
- "application/xml"
152
- ],
153
- "produces": [
154
- "application/json",
155
- "application/xml"
156
- ],
157
- "parameters": [
158
- {
159
- "in": "body",
160
- "name": "body",
161
- "description": "Pet object that needs to be added to the store",
162
- "required": true,
163
- "schema": {
164
- "$ref": "#/definitions/Pet"
165
- }
166
- }
167
- ],
168
- "responses": {
169
- "400": {
170
- "description": "Invalid ID supplied"
171
- },
172
- "404": {
173
- "description": "Pet not found"
174
- },
175
- "405": {
176
- "description": "Validation exception"
177
- }
178
- },
179
- "security": [
180
- {
181
- "petstore_auth": [
182
- "write:pets",
183
- "read:pets"
184
- ]
185
- }
186
- ]
187
- }
188
- },
189
- "/pet/findByStatus": {
190
- "get": {
191
- "tags": [
192
- "pet"
193
- ],
194
- "summary": "Finds Pets by status",
195
- "description": "Multiple status values can be provided with comma separated strings",
196
- "operationId": "findPetsByStatus",
197
- "produces": [
198
- "application/json",
199
- "application/xml"
200
- ],
201
- "parameters": [
202
- {
203
- "name": "status",
204
- "in": "query",
205
- "description": "Status values that need to be considered for filter",
206
- "required": true,
207
- "type": "array",
208
- "items": {
209
- "type": "string",
210
- "enum": [
211
- "available",
212
- "pending",
213
- "sold"
214
- ],
215
- "default": "available"
216
- },
217
- "collectionFormat": "multi"
218
- }
219
- ],
220
- "responses": {
221
- "200": {
222
- "description": "successful operation",
223
- "schema": {
224
- "type": "array",
225
- "items": {
226
- "$ref": "#/definitions/Pet"
227
- }
228
- }
229
- },
230
- "400": {
231
- "description": "Invalid status value"
232
- }
233
- },
234
- "security": [
235
- {
236
- "petstore_auth": [
237
- "write:pets",
238
- "read:pets"
239
- ]
240
- }
241
- ]
242
- }
243
- },
244
- "/pet/findByTags": {
245
- "get": {
246
- "tags": [
247
- "pet"
248
- ],
249
- "summary": "Finds Pets by tags",
250
- "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
251
- "operationId": "findPetsByTags",
252
- "produces": [
253
- "application/json",
254
- "application/xml"
255
- ],
256
- "parameters": [
257
- {
258
- "name": "tags",
259
- "in": "query",
260
- "description": "Tags to filter by",
261
- "required": true,
262
- "type": "array",
263
- "items": {
264
- "type": "string"
265
- },
266
- "collectionFormat": "multi"
267
- }
268
- ],
269
- "responses": {
270
- "200": {
271
- "description": "successful operation",
272
- "schema": {
273
- "type": "array",
274
- "items": {
275
- "$ref": "#/definitions/Pet"
276
- }
277
- }
278
- },
279
- "400": {
280
- "description": "Invalid tag value"
281
- }
282
- },
283
- "security": [
284
- {
285
- "petstore_auth": [
286
- "write:pets",
287
- "read:pets"
288
- ]
289
- }
290
- ],
291
- "deprecated": true
292
- }
293
- },
294
- "/pet/{petId}": {
295
- "get": {
296
- "tags": [
297
- "pet"
298
- ],
299
- "summary": "Find pet by ID",
300
- "description": "Returns a single pet",
301
- "operationId": "getPetById",
302
- "produces": [
303
- "application/json",
304
- "application/xml"
305
- ],
306
- "parameters": [
307
- {
308
- "name": "petId",
309
- "in": "path",
310
- "description": "ID of pet to return",
311
- "required": true,
312
- "type": "integer",
313
- "format": "int64"
314
- }
315
- ],
316
- "responses": {
317
- "200": {
318
- "description": "successful operation",
319
- "schema": {
320
- "$ref": "#/definitions/Pet"
321
- }
322
- },
323
- "400": {
324
- "description": "Invalid ID supplied"
325
- },
326
- "404": {
327
- "description": "Pet not found"
328
- }
329
- },
330
- "security": [
331
- {
332
- "api_key": []
333
- }
334
- ]
335
- },
336
- "post": {
337
- "tags": [
338
- "pet"
339
- ],
340
- "summary": "Updates a pet in the store with form data",
341
- "description": "",
342
- "operationId": "updatePetWithForm",
343
- "consumes": [
344
- "application/x-www-form-urlencoded"
345
- ],
346
- "produces": [
347
- "application/json",
348
- "application/xml"
349
- ],
350
- "parameters": [
351
- {
352
- "name": "petId",
353
- "in": "path",
354
- "description": "ID of pet that needs to be updated",
355
- "required": true,
356
- "type": "integer",
357
- "format": "int64"
358
- },
359
- {
360
- "name": "name",
361
- "in": "formData",
362
- "description": "Updated name of the pet",
363
- "required": false,
364
- "type": "string"
365
- },
366
- {
367
- "name": "status",
368
- "in": "formData",
369
- "description": "Updated status of the pet",
370
- "required": false,
371
- "type": "string"
372
- }
373
- ],
374
- "responses": {
375
- "405": {
376
- "description": "Invalid input"
377
- }
378
- },
379
- "security": [
380
- {
381
- "petstore_auth": [
382
- "write:pets",
383
- "read:pets"
384
- ]
385
- }
386
- ]
387
- },
388
- "delete": {
389
- "tags": [
390
- "pet"
391
- ],
392
- "summary": "Deletes a pet",
393
- "description": "",
394
- "operationId": "deletePet",
395
- "produces": [
396
- "application/json",
397
- "application/xml"
398
- ],
399
- "parameters": [
400
- {
401
- "name": "api_key",
402
- "in": "header",
403
- "required": false,
404
- "type": "string"
405
- },
406
- {
407
- "name": "petId",
408
- "in": "path",
409
- "description": "Pet id to delete",
410
- "required": true,
411
- "type": "integer",
412
- "format": "int64"
413
- }
414
- ],
415
- "responses": {
416
- "400": {
417
- "description": "Invalid ID supplied"
418
- },
419
- "404": {
420
- "description": "Pet not found"
421
- }
422
- },
423
- "security": [
424
- {
425
- "petstore_auth": [
426
- "write:pets",
427
- "read:pets"
428
- ]
429
- }
430
- ]
431
- }
432
- },
433
- "/store/inventory": {
434
- "get": {
435
- "tags": [
436
- "store"
437
- ],
438
- "summary": "Returns pet inventories by status",
439
- "description": "Returns a map of status codes to quantities",
440
- "operationId": "getInventory",
441
- "produces": [
442
- "application/json"
443
- ],
444
- "parameters": [],
445
- "responses": {
446
- "200": {
447
- "description": "successful operation",
448
- "schema": {
449
- "type": "object",
450
- "additionalProperties": {
451
- "type": "integer",
452
- "format": "int32"
453
- }
454
- }
455
- }
456
- },
457
- "security": [
458
- {
459
- "api_key": []
460
- }
461
- ]
462
- }
463
- },
464
- "/store/order": {
465
- "post": {
466
- "tags": [
467
- "store"
468
- ],
469
- "summary": "Place an order for a pet",
470
- "description": "",
471
- "operationId": "placeOrder",
472
- "consumes": [
473
- "application/json"
474
- ],
475
- "produces": [
476
- "application/json",
477
- "application/xml"
478
- ],
479
- "parameters": [
480
- {
481
- "in": "body",
482
- "name": "body",
483
- "description": "order placed for purchasing the pet",
484
- "required": true,
485
- "schema": {
486
- "$ref": "#/definitions/Order"
487
- }
488
- }
489
- ],
490
- "responses": {
491
- "200": {
492
- "description": "successful operation",
493
- "schema": {
494
- "$ref": "#/definitions/Order"
495
- }
496
- },
497
- "400": {
498
- "description": "Invalid Order"
499
- }
500
- }
501
- }
502
- },
503
- "/store/order/{orderId}": {
504
- "get": {
505
- "tags": [
506
- "store"
507
- ],
508
- "summary": "Find purchase order by ID",
509
- "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
510
- "operationId": "getOrderById",
511
- "produces": [
512
- "application/json",
513
- "application/xml"
514
- ],
515
- "parameters": [
516
- {
517
- "name": "orderId",
518
- "in": "path",
519
- "description": "ID of pet that needs to be fetched",
520
- "required": true,
521
- "type": "integer",
522
- "maximum": 10,
523
- "minimum": 1,
524
- "format": "int64"
525
- }
526
- ],
527
- "responses": {
528
- "200": {
529
- "description": "successful operation",
530
- "schema": {
531
- "$ref": "#/definitions/Order"
532
- }
533
- },
534
- "400": {
535
- "description": "Invalid ID supplied"
536
- },
537
- "404": {
538
- "description": "Order not found"
539
- }
540
- }
541
- },
542
- "delete": {
543
- "tags": [
544
- "store"
545
- ],
546
- "summary": "Delete purchase order by ID",
547
- "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
548
- "operationId": "deleteOrder",
549
- "produces": [
550
- "application/json",
551
- "application/xml"
552
- ],
553
- "parameters": [
554
- {
555
- "name": "orderId",
556
- "in": "path",
557
- "description": "ID of the order that needs to be deleted",
558
- "required": true,
559
- "type": "integer",
560
- "minimum": 1,
561
- "format": "int64"
562
- }
563
- ],
564
- "responses": {
565
- "400": {
566
- "description": "Invalid ID supplied"
567
- },
568
- "404": {
569
- "description": "Order not found"
570
- }
571
- }
572
- }
573
- },
574
- "/user/createWithList": {
575
- "post": {
576
- "tags": [
577
- "user"
578
- ],
579
- "summary": "Creates list of users with given input array",
580
- "description": "",
581
- "operationId": "createUsersWithListInput",
582
- "consumes": [
583
- "application/json"
584
- ],
585
- "produces": [
586
- "application/json",
587
- "application/xml"
588
- ],
589
- "parameters": [
590
- {
591
- "in": "body",
592
- "name": "body",
593
- "description": "List of user object",
594
- "required": true,
595
- "schema": {
596
- "type": "array",
597
- "items": {
598
- "$ref": "#/definitions/User"
599
- }
600
- }
601
- }
602
- ],
603
- "responses": {
604
- "default": {
605
- "description": "successful operation"
606
- }
607
- }
608
- }
609
- },
610
- "/user/{username}": {
611
- "get": {
612
- "tags": [
613
- "user"
614
- ],
615
- "summary": "Get user by user name",
616
- "description": "",
617
- "operationId": "getUserByName",
618
- "produces": [
619
- "application/json",
620
- "application/xml"
621
- ],
622
- "parameters": [
623
- {
624
- "name": "username",
625
- "in": "path",
626
- "description": "The name that needs to be fetched. Use user1 for testing. ",
627
- "required": true,
628
- "type": "string"
629
- }
630
- ],
631
- "responses": {
632
- "200": {
633
- "description": "successful operation",
634
- "schema": {
635
- "$ref": "#/definitions/User"
636
- }
637
- },
638
- "400": {
639
- "description": "Invalid username supplied"
640
- },
641
- "404": {
642
- "description": "User not found"
643
- }
644
- }
645
- },
646
- "put": {
647
- "tags": [
648
- "user"
649
- ],
650
- "summary": "Updated user",
651
- "description": "This can only be done by the logged in user.",
652
- "operationId": "updateUser",
653
- "consumes": [
654
- "application/json"
655
- ],
656
- "produces": [
657
- "application/json",
658
- "application/xml"
659
- ],
660
- "parameters": [
661
- {
662
- "name": "username",
663
- "in": "path",
664
- "description": "name that need to be updated",
665
- "required": true,
666
- "type": "string"
667
- },
668
- {
669
- "in": "body",
670
- "name": "body",
671
- "description": "Updated user object",
672
- "required": true,
673
- "schema": {
674
- "$ref": "#/definitions/User"
675
- }
676
- }
677
- ],
678
- "responses": {
679
- "400": {
680
- "description": "Invalid user supplied"
681
- },
682
- "404": {
683
- "description": "User not found"
684
- }
685
- }
686
- },
687
- "delete": {
688
- "tags": [
689
- "user"
690
- ],
691
- "summary": "Delete user",
692
- "description": "This can only be done by the logged in user.",
693
- "operationId": "deleteUser",
694
- "produces": [
695
- "application/json",
696
- "application/xml"
697
- ],
698
- "parameters": [
699
- {
700
- "name": "username",
701
- "in": "path",
702
- "description": "The name that needs to be deleted",
703
- "required": true,
704
- "type": "string"
705
- }
706
- ],
707
- "responses": {
708
- "400": {
709
- "description": "Invalid username supplied"
710
- },
711
- "404": {
712
- "description": "User not found"
713
- }
714
- }
715
- }
716
- },
717
- "/user/login": {
718
- "get": {
719
- "tags": [
720
- "user"
721
- ],
722
- "summary": "Logs user into the system",
723
- "description": "",
724
- "operationId": "loginUser",
725
- "produces": [
726
- "application/json",
727
- "application/xml"
728
- ],
729
- "parameters": [
730
- {
731
- "name": "username",
732
- "in": "query",
733
- "description": "The user name for login",
734
- "required": true,
735
- "type": "string"
736
- },
737
- {
738
- "name": "password",
739
- "in": "query",
740
- "description": "The password for login in clear text",
741
- "required": true,
742
- "type": "string"
743
- }
744
- ],
745
- "responses": {
746
- "200": {
747
- "description": "successful operation",
748
- "headers": {
749
- "X-Expires-After": {
750
- "type": "string",
751
- "format": "date-time",
752
- "description": "date in UTC when token expires"
753
- },
754
- "X-Rate-Limit": {
755
- "type": "integer",
756
- "format": "int32",
757
- "description": "calls per hour allowed by the user"
758
- }
759
- },
760
- "schema": {
761
- "type": "string"
762
- }
763
- },
764
- "400": {
765
- "description": "Invalid username/password supplied"
766
- }
767
- }
768
- }
769
- },
770
- "/user/logout": {
771
- "get": {
772
- "tags": [
773
- "user"
774
- ],
775
- "summary": "Logs out current logged in user session",
776
- "description": "",
777
- "operationId": "logoutUser",
778
- "produces": [
779
- "application/json",
780
- "application/xml"
781
- ],
782
- "parameters": [],
783
- "responses": {
784
- "default": {
785
- "description": "successful operation"
786
- }
787
- }
788
- }
789
- },
790
- "/user/createWithArray": {
791
- "post": {
792
- "tags": [
793
- "user"
794
- ],
795
- "summary": "Creates list of users with given input array",
796
- "description": "",
797
- "operationId": "createUsersWithArrayInput",
798
- "consumes": [
799
- "application/json"
800
- ],
801
- "produces": [
802
- "application/json",
803
- "application/xml"
804
- ],
805
- "parameters": [
806
- {
807
- "in": "body",
808
- "name": "body",
809
- "description": "List of user object",
810
- "required": true,
811
- "schema": {
812
- "type": "array",
813
- "items": {
814
- "$ref": "#/definitions/User"
815
- }
816
- }
817
- }
818
- ],
819
- "responses": {
820
- "default": {
821
- "description": "successful operation"
822
- }
823
- }
824
- }
825
- },
826
- "/user": {
827
- "post": {
828
- "tags": [
829
- "user"
830
- ],
831
- "summary": "Create user",
832
- "description": "This can only be done by the logged in user.",
833
- "operationId": "createUser",
834
- "consumes": [
835
- "application/json"
836
- ],
837
- "produces": [
838
- "application/json",
839
- "application/xml"
840
- ],
841
- "parameters": [
842
- {
843
- "in": "body",
844
- "name": "body",
845
- "description": "Created user object",
846
- "required": true,
847
- "schema": {
848
- "$ref": "#/definitions/User"
849
- }
850
- }
851
- ],
852
- "responses": {
853
- "default": {
854
- "description": "successful operation"
855
- }
856
- }
857
- }
858
- }
859
- },
860
- "securityDefinitions": {
861
- "api_key": {
862
- "type": "apiKey",
863
- "name": "api_key",
864
- "in": "header"
865
- },
866
- "petstore_auth": {
867
- "type": "oauth2",
868
- "authorizationUrl": "https://petstore.swagger.io/oauth/authorize",
869
- "flow": "implicit",
870
- "scopes": {
871
- "read:pets": "read your pets",
872
- "write:pets": "modify pets in your account"
873
- }
874
- }
875
- },
876
- "definitions": {
877
- "ApiResponse": {
878
- "type": "object",
879
- "properties": {
880
- "code": {
881
- "type": "integer",
882
- "format": "int32"
883
- },
884
- "type": {
885
- "type": "string"
886
- },
887
- "message": {
888
- "type": "string"
889
- }
890
- }
891
- },
892
- "Category": {
893
- "type": "object",
894
- "properties": {
895
- "id": {
896
- "type": "integer",
897
- "format": "int64"
898
- },
899
- "name": {
900
- "type": "string"
901
- }
902
- },
903
- "xml": {
904
- "name": "Category"
905
- }
906
- },
907
- "Pet": {
908
- "type": "object",
909
- "required": [
910
- "name",
911
- "photoUrls"
912
- ],
913
- "properties": {
914
- "id": {
915
- "type": "integer",
916
- "format": "int64"
917
- },
918
- "category": {
919
- "$ref": "#/definitions/Category"
920
- },
921
- "name": {
922
- "type": "string",
923
- "example": "doggie"
924
- },
925
- "photoUrls": {
926
- "type": "array",
927
- "xml": {
928
- "wrapped": true
929
- },
930
- "items": {
931
- "type": "string",
932
- "xml": {
933
- "name": "photoUrl"
934
- }
935
- }
936
- },
937
- "tags": {
938
- "type": "array",
939
- "xml": {
940
- "wrapped": true
941
- },
942
- "items": {
943
- "xml": {
944
- "name": "tag"
945
- },
946
- "$ref": "#/definitions/Tag"
947
- }
948
- },
949
- "status": {
950
- "type": "string",
951
- "description": "pet status in the store",
952
- "enum": [
953
- "available",
954
- "pending",
955
- "sold"
956
- ]
957
- }
958
- },
959
- "xml": {
960
- "name": "Pet"
961
- }
962
- },
963
- "Tag": {
964
- "type": "object",
965
- "properties": {
966
- "id": {
967
- "type": "integer",
968
- "format": "int64"
969
- },
970
- "name": {
971
- "type": "string"
972
- }
973
- },
974
- "xml": {
975
- "name": "Tag"
976
- }
977
- },
978
- "Order": {
979
- "type": "object",
980
- "properties": {
981
- "id": {
982
- "type": "integer",
983
- "format": "int64"
984
- },
985
- "petId": {
986
- "type": "integer",
987
- "format": "int64"
988
- },
989
- "quantity": {
990
- "type": "integer",
991
- "format": "int32"
992
- },
993
- "shipDate": {
994
- "type": "string",
995
- "format": "date-time"
996
- },
997
- "status": {
998
- "type": "string",
999
- "description": "Order Status",
1000
- "enum": [
1001
- "placed",
1002
- "approved",
1003
- "delivered"
1004
- ]
1005
- },
1006
- "complete": {
1007
- "type": "boolean"
1008
- }
1009
- },
1010
- "xml": {
1011
- "name": "Order"
1012
- }
1013
- },
1014
- "User": {
1015
- "type": "object",
1016
- "properties": {
1017
- "id": {
1018
- "type": "integer",
1019
- "format": "int64"
1020
- },
1021
- "username": {
1022
- "type": "string"
1023
- },
1024
- "firstName": {
1025
- "type": "string"
1026
- },
1027
- "lastName": {
1028
- "type": "string"
1029
- },
1030
- "email": {
1031
- "type": "string"
1032
- },
1033
- "password": {
1034
- "type": "string"
1035
- },
1036
- "phone": {
1037
- "type": "string"
1038
- },
1039
- "userStatus": {
1040
- "type": "integer",
1041
- "format": "int32",
1042
- "description": "User Status"
1043
- }
1044
- },
1045
- "xml": {
1046
- "name": "User"
1047
- }
1048
- }
1049
- },
1050
- "externalDocs": {
1051
- "description": "Find out more about Swagger",
1052
- "url": "http://swagger.io"
1053
- }
1054
- }