@budibase/server 1.0.99 → 1.0.102

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 (228) hide show
  1. package/builder/assets/index.7d3fac69.js +1291 -0
  2. package/builder/assets/{index.7c8961b4.css → index.ea3718aa.css} +2 -2
  3. package/builder/assets/{vendor.a7c6ad0a.js → vendor.8e34a169.js} +1 -1
  4. package/builder/index.html +3 -3
  5. package/coverage/clover.xml +267 -253
  6. package/coverage/coverage-final.json +13 -13
  7. package/coverage/lcov-report/api/controllers/analytics.js.html +1 -1
  8. package/coverage/lcov-report/api/controllers/apikeys.js.html +1 -1
  9. package/coverage/lcov-report/api/controllers/application.js.html +1 -1
  10. package/coverage/lcov-report/api/controllers/auth.js.html +1 -1
  11. package/coverage/lcov-report/api/controllers/automation.js.html +1 -1
  12. package/coverage/lcov-report/api/controllers/backup.js.html +1 -1
  13. package/coverage/lcov-report/api/controllers/cloud.js.html +1 -1
  14. package/coverage/lcov-report/api/controllers/component.js.html +4 -4
  15. package/coverage/lcov-report/api/controllers/datasource.js.html +1 -1
  16. package/coverage/lcov-report/api/controllers/dev.js.html +1 -1
  17. package/coverage/lcov-report/api/controllers/index.html +16 -16
  18. package/coverage/lcov-report/api/controllers/integration.js.html +59 -11
  19. package/coverage/lcov-report/api/controllers/layout.js.html +1 -1
  20. package/coverage/lcov-report/api/controllers/metadata.js.html +1 -1
  21. package/coverage/lcov-report/api/controllers/migrations.js.html +1 -1
  22. package/coverage/lcov-report/api/controllers/permission.js.html +1 -1
  23. package/coverage/lcov-report/api/controllers/query/index.html +1 -1
  24. package/coverage/lcov-report/api/controllers/query/index.js.html +1 -1
  25. package/coverage/lcov-report/api/controllers/query/validation.js.html +2 -2
  26. package/coverage/lcov-report/api/controllers/role.js.html +1 -1
  27. package/coverage/lcov-report/api/controllers/routing.js.html +1 -1
  28. package/coverage/lcov-report/api/controllers/row/external.js.html +1 -1
  29. package/coverage/lcov-report/api/controllers/row/index.html +10 -10
  30. package/coverage/lcov-report/api/controllers/row/index.js.html +1 -1
  31. package/coverage/lcov-report/api/controllers/row/internal.js.html +19 -7
  32. package/coverage/lcov-report/api/controllers/row/internalSearch.js.html +1 -1
  33. package/coverage/lcov-report/api/controllers/row/staticFormula.js.html +1 -1
  34. package/coverage/lcov-report/api/controllers/row/utils.js.html +6 -6
  35. package/coverage/lcov-report/api/controllers/screen.js.html +1 -1
  36. package/coverage/lcov-report/api/controllers/script.js.html +1 -1
  37. package/coverage/lcov-report/api/controllers/table/bulkFormula.js.html +1 -1
  38. package/coverage/lcov-report/api/controllers/table/external.js.html +1 -1
  39. package/coverage/lcov-report/api/controllers/table/index.html +1 -1
  40. package/coverage/lcov-report/api/controllers/table/index.js.html +1 -1
  41. package/coverage/lcov-report/api/controllers/table/internal.js.html +1 -1
  42. package/coverage/lcov-report/api/controllers/table/utils.js.html +1 -1
  43. package/coverage/lcov-report/api/controllers/templates.js.html +1 -1
  44. package/coverage/lcov-report/api/controllers/user.js.html +1 -1
  45. package/coverage/lcov-report/api/controllers/view/exporters.js.html +1 -1
  46. package/coverage/lcov-report/api/controllers/view/index.html +1 -1
  47. package/coverage/lcov-report/api/controllers/view/index.js.html +1 -1
  48. package/coverage/lcov-report/api/controllers/view/utils.js.html +1 -1
  49. package/coverage/lcov-report/api/controllers/view/viewBuilder.js.html +1 -1
  50. package/coverage/lcov-report/api/controllers/webhook.js.html +1 -1
  51. package/coverage/lcov-report/api/index.html +1 -1
  52. package/coverage/lcov-report/api/index.js.html +1 -1
  53. package/coverage/lcov-report/api/routes/analytics.js.html +3 -3
  54. package/coverage/lcov-report/api/routes/apikeys.js.html +1 -1
  55. package/coverage/lcov-report/api/routes/application.js.html +1 -1
  56. package/coverage/lcov-report/api/routes/auth.js.html +1 -1
  57. package/coverage/lcov-report/api/routes/automation.js.html +1 -1
  58. package/coverage/lcov-report/api/routes/backup.js.html +1 -1
  59. package/coverage/lcov-report/api/routes/cloud.js.html +1 -1
  60. package/coverage/lcov-report/api/routes/component.js.html +1 -1
  61. package/coverage/lcov-report/api/routes/datasource.js.html +1 -1
  62. package/coverage/lcov-report/api/routes/deploy.js.html +1 -1
  63. package/coverage/lcov-report/api/routes/dev.js.html +1 -1
  64. package/coverage/lcov-report/api/routes/index.html +1 -1
  65. package/coverage/lcov-report/api/routes/index.js.html +1 -1
  66. package/coverage/lcov-report/api/routes/integration.js.html +1 -1
  67. package/coverage/lcov-report/api/routes/layout.js.html +1 -1
  68. package/coverage/lcov-report/api/routes/metadata.js.html +1 -1
  69. package/coverage/lcov-report/api/routes/migrations.js.html +1 -1
  70. package/coverage/lcov-report/api/routes/permission.js.html +1 -1
  71. package/coverage/lcov-report/api/routes/query.js.html +1 -1
  72. package/coverage/lcov-report/api/routes/role.js.html +1 -1
  73. package/coverage/lcov-report/api/routes/routing.js.html +1 -1
  74. package/coverage/lcov-report/api/routes/row.js.html +1 -1
  75. package/coverage/lcov-report/api/routes/screen.js.html +1 -1
  76. package/coverage/lcov-report/api/routes/script.js.html +1 -1
  77. package/coverage/lcov-report/api/routes/static.js.html +1 -1
  78. package/coverage/lcov-report/api/routes/table.js.html +1 -1
  79. package/coverage/lcov-report/api/routes/templates.js.html +1 -1
  80. package/coverage/lcov-report/api/routes/user.js.html +1 -1
  81. package/coverage/lcov-report/api/routes/utils/index.html +1 -1
  82. package/coverage/lcov-report/api/routes/utils/validators.js.html +1 -1
  83. package/coverage/lcov-report/api/routes/view.js.html +1 -1
  84. package/coverage/lcov-report/api/routes/webhook.js.html +1 -1
  85. package/coverage/lcov-report/automations/actions.js.html +1 -1
  86. package/coverage/lcov-report/automations/automationUtils.js.html +1 -1
  87. package/coverage/lcov-report/automations/bullboard.js.html +1 -1
  88. package/coverage/lcov-report/automations/index.html +12 -12
  89. package/coverage/lcov-report/automations/index.js.html +1 -1
  90. package/coverage/lcov-report/automations/steps/bash.js.html +1 -1
  91. package/coverage/lcov-report/automations/steps/createRow.js.html +1 -1
  92. package/coverage/lcov-report/automations/steps/delay.js.html +1 -1
  93. package/coverage/lcov-report/automations/steps/deleteRow.js.html +1 -1
  94. package/coverage/lcov-report/automations/steps/discord.js.html +1 -1
  95. package/coverage/lcov-report/automations/steps/executeQuery.js.html +1 -1
  96. package/coverage/lcov-report/automations/steps/executeScript.js.html +1 -1
  97. package/coverage/lcov-report/automations/steps/filter.js.html +1 -1
  98. package/coverage/lcov-report/automations/steps/index.html +1 -1
  99. package/coverage/lcov-report/automations/steps/integromat.js.html +1 -1
  100. package/coverage/lcov-report/automations/steps/outgoingWebhook.js.html +1 -1
  101. package/coverage/lcov-report/automations/steps/queryRows.js.html +1 -1
  102. package/coverage/lcov-report/automations/steps/sendSmtpEmail.js.html +1 -1
  103. package/coverage/lcov-report/automations/steps/serverLog.js.html +1 -1
  104. package/coverage/lcov-report/automations/steps/slack.js.html +1 -1
  105. package/coverage/lcov-report/automations/steps/updateRow.js.html +1 -1
  106. package/coverage/lcov-report/automations/steps/utils.js.html +1 -1
  107. package/coverage/lcov-report/automations/steps/zapier.js.html +1 -1
  108. package/coverage/lcov-report/automations/triggerInfo/app.js.html +1 -1
  109. package/coverage/lcov-report/automations/triggerInfo/cron.js.html +1 -1
  110. package/coverage/lcov-report/automations/triggerInfo/index.html +1 -1
  111. package/coverage/lcov-report/automations/triggerInfo/index.js.html +1 -1
  112. package/coverage/lcov-report/automations/triggerInfo/rowDeleted.js.html +1 -1
  113. package/coverage/lcov-report/automations/triggerInfo/rowSaved.js.html +1 -1
  114. package/coverage/lcov-report/automations/triggerInfo/rowUpdated.js.html +1 -1
  115. package/coverage/lcov-report/automations/triggerInfo/webhook.js.html +1 -1
  116. package/coverage/lcov-report/automations/triggers.js.html +1 -1
  117. package/coverage/lcov-report/automations/utils.js.html +20 -8
  118. package/coverage/lcov-report/constants/index.html +1 -1
  119. package/coverage/lcov-report/constants/index.js.html +1 -1
  120. package/coverage/lcov-report/constants/layouts.js.html +1 -1
  121. package/coverage/lcov-report/constants/screens.js.html +1 -1
  122. package/coverage/lcov-report/db/client.js.html +1 -1
  123. package/coverage/lcov-report/db/inMemoryView.js.html +1 -1
  124. package/coverage/lcov-report/db/index.html +1 -1
  125. package/coverage/lcov-report/db/index.js.html +1 -1
  126. package/coverage/lcov-report/db/linkedRows/LinkController.js.html +1 -1
  127. package/coverage/lcov-report/db/linkedRows/index.html +1 -1
  128. package/coverage/lcov-report/db/linkedRows/index.js.html +10 -10
  129. package/coverage/lcov-report/db/linkedRows/linkUtils.js.html +7 -7
  130. package/coverage/lcov-report/db/newid.js.html +2 -2
  131. package/coverage/lcov-report/db/utils.js.html +2 -2
  132. package/coverage/lcov-report/events/AutomationEmitter.js.html +1 -1
  133. package/coverage/lcov-report/events/index.html +1 -1
  134. package/coverage/lcov-report/events/index.js.html +1 -1
  135. package/coverage/lcov-report/events/utils.js.html +1 -1
  136. package/coverage/lcov-report/index.html +24 -24
  137. package/coverage/lcov-report/integrations/tests/TestConfiguration.js.html +1 -1
  138. package/coverage/lcov-report/integrations/tests/index.html +1 -1
  139. package/coverage/lcov-report/middleware/appInfo.js.html +1 -1
  140. package/coverage/lcov-report/middleware/authorized.js.html +1 -1
  141. package/coverage/lcov-report/middleware/builder.js.html +1 -1
  142. package/coverage/lcov-report/middleware/currentapp.js.html +1 -1
  143. package/coverage/lcov-report/middleware/index.html +1 -1
  144. package/coverage/lcov-report/middleware/joi-validator.js.html +1 -1
  145. package/coverage/lcov-report/middleware/publicApi.js.html +1 -1
  146. package/coverage/lcov-report/middleware/resourceId.js.html +1 -1
  147. package/coverage/lcov-report/middleware/selfhost.js.html +1 -1
  148. package/coverage/lcov-report/middleware/usageQuota.js.html +1 -1
  149. package/coverage/lcov-report/middleware/utils.js.html +1 -1
  150. package/coverage/lcov-report/threads/automation.js.html +1 -1
  151. package/coverage/lcov-report/threads/index.html +1 -1
  152. package/coverage/lcov-report/threads/index.js.html +1 -1
  153. package/coverage/lcov-report/threads/query.js.html +1 -1
  154. package/coverage/lcov-report/threads/utils.js.html +1 -1
  155. package/coverage/lcov-report/utilities/bcrypt.js.html +1 -1
  156. package/coverage/lcov-report/utilities/budibaseDir.js.html +1 -1
  157. package/coverage/lcov-report/utilities/centralPath.js.html +1 -1
  158. package/coverage/lcov-report/utilities/csvParser.js.html +1 -1
  159. package/coverage/lcov-report/utilities/global.js.html +1 -1
  160. package/coverage/lcov-report/utilities/index.html +1 -1
  161. package/coverage/lcov-report/utilities/index.js.html +1 -1
  162. package/coverage/lcov-report/utilities/queue/inMemoryQueue.js.html +1 -1
  163. package/coverage/lcov-report/utilities/queue/index.html +1 -1
  164. package/coverage/lcov-report/utilities/routing/index.html +1 -1
  165. package/coverage/lcov-report/utilities/routing/index.js.html +1 -1
  166. package/coverage/lcov-report/utilities/rowProcessor/index.html +1 -1
  167. package/coverage/lcov-report/utilities/rowProcessor/index.js.html +12 -12
  168. package/coverage/lcov-report/utilities/rowProcessor/utils.js.html +8 -8
  169. package/coverage/lcov-report/utilities/scriptRunner.js.html +1 -1
  170. package/coverage/lcov-report/utilities/security.js.html +1 -1
  171. package/coverage/lcov-report/utilities/statusCodes.js.html +1 -1
  172. package/coverage/lcov-report/utilities/usageQuota/index.html +1 -1
  173. package/coverage/lcov-report/utilities/usageQuota/index.js.html +1 -1
  174. package/coverage/lcov-report/utilities/usageQuota/rows.js.html +1 -1
  175. package/coverage/lcov-report/utilities/usageQuota/usageQuoteReset.js.html +1 -1
  176. package/coverage/lcov-report/utilities/users.js.html +1 -1
  177. package/coverage/lcov-report/utilities/workerRequests.js.html +1 -1
  178. package/coverage/lcov.info +409 -391
  179. package/dist/api/controllers/integration.js +15 -1
  180. package/dist/api/controllers/query/import/index.js +2 -1
  181. package/dist/api/controllers/query/import/sources/base/index.js +12 -1
  182. package/dist/api/controllers/query/import/sources/curl.js +2 -2
  183. package/dist/api/controllers/query/import/sources/openapi3.js +174 -0
  184. package/dist/api/controllers/query/import/sources/tests/openapi3/data/crud/crud.json +253 -0
  185. package/dist/api/controllers/query/import/sources/tests/openapi3/data/petstore/petstore.json +1225 -0
  186. package/dist/api/controllers/row/internal.js +2 -1
  187. package/dist/api/routes/analytics.js +2 -2
  188. package/dist/automations/utils.js +3 -1
  189. package/dist/definitions/datasource.js +1 -0
  190. package/dist/environment.js +2 -0
  191. package/dist/integrations/base/sql.js +16 -9
  192. package/dist/integrations/dynamodb.js +3 -1
  193. package/dist/integrations/firebase.js +192 -0
  194. package/dist/integrations/googlesheets.js +17 -1
  195. package/dist/integrations/index.js +3 -1
  196. package/dist/integrations/mysql.js +14 -1
  197. package/dist/integrations/rest.js +2 -1
  198. package/dist/package.json +7 -4
  199. package/dist/tsconfig.tsbuildinfo +1 -1
  200. package/package.json +8 -5
  201. package/scripts/dev/manage.js +2 -1
  202. package/src/api/controllers/integration.js +17 -1
  203. package/src/api/controllers/query/import/index.ts +2 -1
  204. package/src/api/controllers/query/import/sources/base/index.ts +12 -2
  205. package/src/api/controllers/query/import/sources/curl.ts +2 -2
  206. package/src/api/controllers/query/import/sources/openapi3.ts +205 -0
  207. package/src/api/controllers/query/import/sources/tests/openapi3/data/crud/crud.json +253 -0
  208. package/src/api/controllers/query/import/sources/tests/openapi3/data/crud/crud.yaml +153 -0
  209. package/src/api/controllers/query/import/sources/tests/openapi3/data/petstore/petstore.json +1225 -0
  210. package/src/api/controllers/query/import/sources/tests/openapi3/data/petstore/petstore.yaml +804 -0
  211. package/src/api/controllers/query/import/sources/tests/openapi3/openapi3.spec.js +240 -0
  212. package/src/api/controllers/query/import/tests/index.spec.js +43 -0
  213. package/src/api/controllers/row/internal.js +5 -1
  214. package/src/api/routes/analytics.js +2 -2
  215. package/src/api/routes/tests/misc.spec.js +2 -2
  216. package/src/automations/utils.js +5 -1
  217. package/src/definitions/datasource.ts +2 -5
  218. package/src/definitions/openapi.ts +468 -468
  219. package/src/environment.js +2 -0
  220. package/src/integrations/base/sql.ts +14 -9
  221. package/src/integrations/dynamodb.ts +3 -1
  222. package/src/integrations/firebase.ts +205 -0
  223. package/src/integrations/googlesheets.ts +16 -1
  224. package/src/integrations/index.ts +3 -1
  225. package/src/integrations/mysql.ts +15 -1
  226. package/src/integrations/rest.ts +2 -1
  227. package/src/integrations/tests/sql.spec.js +51 -0
  228. package/builder/assets/index.44b5c19a.js +0 -1291
@@ -0,0 +1,1225 @@
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
+ }