@budibase/server 1.0.82 → 1.0.83
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.
- package/builder/assets/{index.5d245850.js → index.b0d624a0.js} +1 -1
- package/builder/index.html +1 -1
- package/coverage/clover.xml +2 -2
- package/coverage/lcov-report/api/controllers/analytics.js.html +1 -1
- package/coverage/lcov-report/api/controllers/apikeys.js.html +1 -1
- package/coverage/lcov-report/api/controllers/application.js.html +1 -1
- package/coverage/lcov-report/api/controllers/auth.js.html +1 -1
- package/coverage/lcov-report/api/controllers/automation.js.html +1 -1
- package/coverage/lcov-report/api/controllers/backup.js.html +1 -1
- package/coverage/lcov-report/api/controllers/cloud.js.html +1 -1
- package/coverage/lcov-report/api/controllers/component.js.html +1 -1
- package/coverage/lcov-report/api/controllers/datasource.js.html +1 -1
- package/coverage/lcov-report/api/controllers/dev.js.html +1 -1
- package/coverage/lcov-report/api/controllers/index.html +1 -1
- package/coverage/lcov-report/api/controllers/integration.js.html +1 -1
- package/coverage/lcov-report/api/controllers/layout.js.html +1 -1
- package/coverage/lcov-report/api/controllers/metadata.js.html +1 -1
- package/coverage/lcov-report/api/controllers/migrations.js.html +1 -1
- package/coverage/lcov-report/api/controllers/permission.js.html +1 -1
- package/coverage/lcov-report/api/controllers/query/index.html +1 -1
- package/coverage/lcov-report/api/controllers/query/index.js.html +1 -1
- package/coverage/lcov-report/api/controllers/query/validation.js.html +1 -1
- package/coverage/lcov-report/api/controllers/role.js.html +1 -1
- package/coverage/lcov-report/api/controllers/routing.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/external.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/index.html +1 -1
- package/coverage/lcov-report/api/controllers/row/index.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/internal.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/internalSearch.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/staticFormula.js.html +1 -1
- package/coverage/lcov-report/api/controllers/row/utils.js.html +1 -1
- package/coverage/lcov-report/api/controllers/screen.js.html +1 -1
- package/coverage/lcov-report/api/controllers/script.js.html +1 -1
- package/coverage/lcov-report/api/controllers/table/bulkFormula.js.html +1 -1
- package/coverage/lcov-report/api/controllers/table/external.js.html +1 -1
- package/coverage/lcov-report/api/controllers/table/index.html +1 -1
- package/coverage/lcov-report/api/controllers/table/index.js.html +1 -1
- package/coverage/lcov-report/api/controllers/table/internal.js.html +1 -1
- package/coverage/lcov-report/api/controllers/table/utils.js.html +1 -1
- package/coverage/lcov-report/api/controllers/templates.js.html +1 -1
- package/coverage/lcov-report/api/controllers/user.js.html +1 -1
- package/coverage/lcov-report/api/controllers/view/exporters.js.html +1 -1
- package/coverage/lcov-report/api/controllers/view/index.html +1 -1
- package/coverage/lcov-report/api/controllers/view/index.js.html +1 -1
- package/coverage/lcov-report/api/controllers/view/utils.js.html +1 -1
- package/coverage/lcov-report/api/controllers/view/viewBuilder.js.html +1 -1
- package/coverage/lcov-report/api/controllers/webhook.js.html +1 -1
- package/coverage/lcov-report/api/index.html +1 -1
- package/coverage/lcov-report/api/index.js.html +1 -1
- package/coverage/lcov-report/api/routes/analytics.js.html +1 -1
- package/coverage/lcov-report/api/routes/apikeys.js.html +1 -1
- package/coverage/lcov-report/api/routes/application.js.html +1 -1
- package/coverage/lcov-report/api/routes/auth.js.html +1 -1
- package/coverage/lcov-report/api/routes/automation.js.html +1 -1
- package/coverage/lcov-report/api/routes/backup.js.html +1 -1
- package/coverage/lcov-report/api/routes/cloud.js.html +1 -1
- package/coverage/lcov-report/api/routes/component.js.html +1 -1
- package/coverage/lcov-report/api/routes/datasource.js.html +1 -1
- package/coverage/lcov-report/api/routes/deploy.js.html +1 -1
- package/coverage/lcov-report/api/routes/dev.js.html +1 -1
- package/coverage/lcov-report/api/routes/index.html +1 -1
- package/coverage/lcov-report/api/routes/index.js.html +1 -1
- package/coverage/lcov-report/api/routes/integration.js.html +1 -1
- package/coverage/lcov-report/api/routes/layout.js.html +1 -1
- package/coverage/lcov-report/api/routes/metadata.js.html +1 -1
- package/coverage/lcov-report/api/routes/migrations.js.html +1 -1
- package/coverage/lcov-report/api/routes/permission.js.html +1 -1
- package/coverage/lcov-report/api/routes/query.js.html +1 -1
- package/coverage/lcov-report/api/routes/role.js.html +1 -1
- package/coverage/lcov-report/api/routes/routing.js.html +1 -1
- package/coverage/lcov-report/api/routes/row.js.html +1 -1
- package/coverage/lcov-report/api/routes/screen.js.html +1 -1
- package/coverage/lcov-report/api/routes/script.js.html +1 -1
- package/coverage/lcov-report/api/routes/static.js.html +1 -1
- package/coverage/lcov-report/api/routes/table.js.html +1 -1
- package/coverage/lcov-report/api/routes/templates.js.html +1 -1
- package/coverage/lcov-report/api/routes/user.js.html +1 -1
- package/coverage/lcov-report/api/routes/utils/index.html +1 -1
- package/coverage/lcov-report/api/routes/utils/validators.js.html +1 -1
- package/coverage/lcov-report/api/routes/view.js.html +1 -1
- package/coverage/lcov-report/api/routes/webhook.js.html +1 -1
- package/coverage/lcov-report/automations/actions.js.html +1 -1
- package/coverage/lcov-report/automations/automationUtils.js.html +1 -1
- package/coverage/lcov-report/automations/bullboard.js.html +1 -1
- package/coverage/lcov-report/automations/index.html +1 -1
- package/coverage/lcov-report/automations/index.js.html +1 -1
- package/coverage/lcov-report/automations/steps/bash.js.html +1 -1
- package/coverage/lcov-report/automations/steps/createRow.js.html +1 -1
- package/coverage/lcov-report/automations/steps/delay.js.html +1 -1
- package/coverage/lcov-report/automations/steps/deleteRow.js.html +1 -1
- package/coverage/lcov-report/automations/steps/discord.js.html +1 -1
- package/coverage/lcov-report/automations/steps/executeQuery.js.html +1 -1
- package/coverage/lcov-report/automations/steps/executeScript.js.html +1 -1
- package/coverage/lcov-report/automations/steps/filter.js.html +1 -1
- package/coverage/lcov-report/automations/steps/index.html +1 -1
- package/coverage/lcov-report/automations/steps/integromat.js.html +1 -1
- package/coverage/lcov-report/automations/steps/outgoingWebhook.js.html +1 -1
- package/coverage/lcov-report/automations/steps/queryRows.js.html +1 -1
- package/coverage/lcov-report/automations/steps/sendSmtpEmail.js.html +1 -1
- package/coverage/lcov-report/automations/steps/serverLog.js.html +1 -1
- package/coverage/lcov-report/automations/steps/slack.js.html +1 -1
- package/coverage/lcov-report/automations/steps/updateRow.js.html +1 -1
- package/coverage/lcov-report/automations/steps/utils.js.html +1 -1
- package/coverage/lcov-report/automations/steps/zapier.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/app.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/cron.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/index.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/index.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/rowDeleted.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/rowSaved.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/rowUpdated.js.html +1 -1
- package/coverage/lcov-report/automations/triggerInfo/webhook.js.html +1 -1
- package/coverage/lcov-report/automations/triggers.js.html +1 -1
- package/coverage/lcov-report/automations/utils.js.html +1 -1
- package/coverage/lcov-report/constants/index.html +1 -1
- package/coverage/lcov-report/constants/index.js.html +1 -1
- package/coverage/lcov-report/constants/layouts.js.html +1 -1
- package/coverage/lcov-report/constants/screens.js.html +1 -1
- package/coverage/lcov-report/db/client.js.html +1 -1
- package/coverage/lcov-report/db/inMemoryView.js.html +1 -1
- package/coverage/lcov-report/db/index.html +1 -1
- package/coverage/lcov-report/db/index.js.html +1 -1
- package/coverage/lcov-report/db/linkedRows/LinkController.js.html +1 -1
- package/coverage/lcov-report/db/linkedRows/index.html +1 -1
- package/coverage/lcov-report/db/linkedRows/index.js.html +1 -1
- package/coverage/lcov-report/db/linkedRows/linkUtils.js.html +1 -1
- package/coverage/lcov-report/db/newid.js.html +1 -1
- package/coverage/lcov-report/db/utils.js.html +1 -1
- package/coverage/lcov-report/events/AutomationEmitter.js.html +1 -1
- package/coverage/lcov-report/events/index.html +1 -1
- package/coverage/lcov-report/events/index.js.html +1 -1
- package/coverage/lcov-report/events/utils.js.html +1 -1
- package/coverage/lcov-report/index.html +1 -1
- package/coverage/lcov-report/integrations/tests/TestConfiguration.js.html +1 -1
- package/coverage/lcov-report/integrations/tests/index.html +1 -1
- package/coverage/lcov-report/middleware/appInfo.js.html +1 -1
- package/coverage/lcov-report/middleware/authorized.js.html +1 -1
- package/coverage/lcov-report/middleware/builder.js.html +1 -1
- package/coverage/lcov-report/middleware/currentapp.js.html +1 -1
- package/coverage/lcov-report/middleware/index.html +1 -1
- package/coverage/lcov-report/middleware/joi-validator.js.html +1 -1
- package/coverage/lcov-report/middleware/resourceId.js.html +1 -1
- package/coverage/lcov-report/middleware/selfhost.js.html +1 -1
- package/coverage/lcov-report/middleware/usageQuota.js.html +1 -1
- package/coverage/lcov-report/middleware/utils.js.html +1 -1
- package/coverage/lcov-report/threads/automation.js.html +1 -1
- package/coverage/lcov-report/threads/index.html +1 -1
- package/coverage/lcov-report/threads/index.js.html +1 -1
- package/coverage/lcov-report/threads/query.js.html +1 -1
- package/coverage/lcov-report/threads/utils.js.html +1 -1
- package/coverage/lcov-report/utilities/bcrypt.js.html +1 -1
- package/coverage/lcov-report/utilities/budibaseDir.js.html +1 -1
- package/coverage/lcov-report/utilities/centralPath.js.html +1 -1
- package/coverage/lcov-report/utilities/csvParser.js.html +1 -1
- package/coverage/lcov-report/utilities/global.js.html +1 -1
- package/coverage/lcov-report/utilities/index.html +1 -1
- package/coverage/lcov-report/utilities/index.js.html +1 -1
- package/coverage/lcov-report/utilities/queue/inMemoryQueue.js.html +1 -1
- package/coverage/lcov-report/utilities/queue/index.html +1 -1
- package/coverage/lcov-report/utilities/routing/index.html +1 -1
- package/coverage/lcov-report/utilities/routing/index.js.html +1 -1
- package/coverage/lcov-report/utilities/rowProcessor/index.html +1 -1
- package/coverage/lcov-report/utilities/rowProcessor/index.js.html +1 -1
- package/coverage/lcov-report/utilities/rowProcessor/utils.js.html +1 -1
- package/coverage/lcov-report/utilities/scriptRunner.js.html +1 -1
- package/coverage/lcov-report/utilities/security.js.html +1 -1
- package/coverage/lcov-report/utilities/statusCodes.js.html +1 -1
- package/coverage/lcov-report/utilities/usageQuota/index.html +1 -1
- package/coverage/lcov-report/utilities/usageQuota/index.js.html +1 -1
- package/coverage/lcov-report/utilities/usageQuota/rows.js.html +1 -1
- package/coverage/lcov-report/utilities/usageQuota/usageQuoteReset.js.html +1 -1
- package/coverage/lcov-report/utilities/users.js.html +1 -1
- package/coverage/lcov-report/utilities/workerRequests.js.html +1 -1
- package/dist/api/routes/public/applications.js +0 -2
- package/dist/package.json +4 -4
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +5 -5
- package/specs/openapi.json +1 -7
- package/specs/openapi.yaml +0 -3
- package/specs/resources/application.js +1 -1
- package/src/api/routes/public/applications.ts +0 -2
- package/src/definitions/openapi.ts +472 -478
|
@@ -9,279 +9,273 @@ export interface paths {
|
|
|
9
9
|
parameters: {
|
|
10
10
|
header: {
|
|
11
11
|
/** The ID of the app which this request is targeting. */
|
|
12
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
13
|
-
}
|
|
14
|
-
}
|
|
12
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
15
|
responses: {
|
|
16
16
|
/** Returns the created application. */
|
|
17
17
|
200: {
|
|
18
18
|
content: {
|
|
19
|
-
"application/json": components["schemas"]["applicationOutput"]
|
|
20
|
-
}
|
|
21
|
-
}
|
|
22
|
-
}
|
|
19
|
+
"application/json": components["schemas"]["applicationOutput"];
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
23
|
requestBody: {
|
|
24
24
|
content: {
|
|
25
|
-
"application/json": components["schemas"]["application"]
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
}
|
|
25
|
+
"application/json": components["schemas"]["application"];
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
30
|
"/applications/{appId}": {
|
|
31
31
|
get: {
|
|
32
32
|
parameters: {
|
|
33
33
|
path: {
|
|
34
34
|
/** The ID of the app which this request is targeting. */
|
|
35
|
-
appId: components["parameters"]["appIdUrl"]
|
|
36
|
-
}
|
|
37
|
-
}
|
|
35
|
+
appId: components["parameters"]["appIdUrl"];
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
38
|
responses: {
|
|
39
39
|
/** Returns the retrieved application. */
|
|
40
40
|
200: {
|
|
41
41
|
content: {
|
|
42
|
-
"application/json": components["schemas"]["applicationOutput"]
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
}
|
|
42
|
+
"application/json": components["schemas"]["applicationOutput"];
|
|
43
|
+
};
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
47
|
put: {
|
|
48
48
|
parameters: {
|
|
49
49
|
path: {
|
|
50
50
|
/** The ID of the app which this request is targeting. */
|
|
51
|
-
appId: components["parameters"]["appIdUrl"]
|
|
52
|
-
}
|
|
53
|
-
}
|
|
51
|
+
appId: components["parameters"]["appIdUrl"];
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
54
|
responses: {
|
|
55
55
|
/** Returns the updated application. */
|
|
56
56
|
200: {
|
|
57
57
|
content: {
|
|
58
|
-
"application/json": components["schemas"]["applicationOutput"]
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
}
|
|
58
|
+
"application/json": components["schemas"]["applicationOutput"];
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
};
|
|
62
62
|
requestBody: {
|
|
63
63
|
content: {
|
|
64
|
-
"application/json": components["schemas"]["application"]
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
}
|
|
64
|
+
"application/json": components["schemas"]["application"];
|
|
65
|
+
};
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
68
|
delete: {
|
|
69
69
|
parameters: {
|
|
70
70
|
path: {
|
|
71
71
|
/** The ID of the app which this request is targeting. */
|
|
72
|
-
appId: components["parameters"]["appIdUrl"]
|
|
73
|
-
}
|
|
74
|
-
}
|
|
72
|
+
appId: components["parameters"]["appIdUrl"];
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
75
|
responses: {
|
|
76
76
|
/** Returns the deleted application. */
|
|
77
77
|
200: {
|
|
78
78
|
content: {
|
|
79
|
-
"application/json": components["schemas"]["applicationOutput"]
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
}
|
|
79
|
+
"application/json": components["schemas"]["applicationOutput"];
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
85
|
"/applications/search": {
|
|
86
86
|
/** Based on application properties (currently only name) search for applications. */
|
|
87
87
|
post: {
|
|
88
|
-
parameters: {
|
|
89
|
-
header: {
|
|
90
|
-
/** The ID of the app which this request is targeting. */
|
|
91
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
88
|
responses: {
|
|
95
89
|
/** Returns the applications that were found based on the search parameters. */
|
|
96
90
|
200: {
|
|
97
91
|
content: {
|
|
98
|
-
"application/json": components["schemas"]["applicationSearch"]
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
}
|
|
92
|
+
"application/json": components["schemas"]["applicationSearch"];
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
};
|
|
102
96
|
requestBody: {
|
|
103
97
|
content: {
|
|
104
|
-
"application/json": components["schemas"]["nameSearch"]
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
}
|
|
98
|
+
"application/json": components["schemas"]["nameSearch"];
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
};
|
|
109
103
|
"/queries/{queryId}": {
|
|
110
104
|
/** Queries which have been created within a Budibase app can be executed using this, */
|
|
111
105
|
post: {
|
|
112
106
|
parameters: {
|
|
113
107
|
path: {
|
|
114
108
|
/** The ID of the query which this request is targeting. */
|
|
115
|
-
queryId: components["parameters"]["queryId"]
|
|
116
|
-
}
|
|
109
|
+
queryId: components["parameters"]["queryId"];
|
|
110
|
+
};
|
|
117
111
|
header: {
|
|
118
112
|
/** The ID of the app which this request is targeting. */
|
|
119
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
120
|
-
}
|
|
121
|
-
}
|
|
113
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
114
|
+
};
|
|
115
|
+
};
|
|
122
116
|
responses: {
|
|
123
117
|
/** Returns the result of the query execution. */
|
|
124
118
|
200: {
|
|
125
119
|
content: {
|
|
126
|
-
"application/json": components["schemas"]["executeQueryOutput"]
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
}
|
|
120
|
+
"application/json": components["schemas"]["executeQueryOutput"];
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
};
|
|
130
124
|
requestBody: {
|
|
131
125
|
content: {
|
|
132
|
-
"application/json": components["schemas"]["executeQuery"]
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
}
|
|
126
|
+
"application/json": components["schemas"]["executeQuery"];
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
};
|
|
137
131
|
"/queries/search": {
|
|
138
132
|
/** Based on query properties (currently only name) search for queries. */
|
|
139
133
|
post: {
|
|
140
134
|
parameters: {
|
|
141
135
|
header: {
|
|
142
136
|
/** The ID of the app which this request is targeting. */
|
|
143
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
144
|
-
}
|
|
145
|
-
}
|
|
137
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
138
|
+
};
|
|
139
|
+
};
|
|
146
140
|
responses: {
|
|
147
141
|
/** Returns the queries found based on the search parameters. */
|
|
148
142
|
200: {
|
|
149
143
|
content: {
|
|
150
|
-
"application/json": components["schemas"]["querySearch"]
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
}
|
|
144
|
+
"application/json": components["schemas"]["querySearch"];
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
};
|
|
154
148
|
requestBody: {
|
|
155
149
|
content: {
|
|
156
|
-
"application/json": components["schemas"]["nameSearch"]
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
}
|
|
150
|
+
"application/json": components["schemas"]["nameSearch"];
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
};
|
|
161
155
|
"/tables/{tableId}/rows": {
|
|
162
156
|
/** Creates a row within the specified table. */
|
|
163
157
|
post: {
|
|
164
158
|
parameters: {
|
|
165
159
|
path: {
|
|
166
160
|
/** The ID of the table which this request is targeting. */
|
|
167
|
-
tableId: components["parameters"]["tableId"]
|
|
168
|
-
}
|
|
161
|
+
tableId: components["parameters"]["tableId"];
|
|
162
|
+
};
|
|
169
163
|
header: {
|
|
170
164
|
/** The ID of the app which this request is targeting. */
|
|
171
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
172
|
-
}
|
|
173
|
-
}
|
|
165
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
166
|
+
};
|
|
167
|
+
};
|
|
174
168
|
responses: {
|
|
175
169
|
/** Returns the created row, including the ID which has been generated for it. This can be found in the Budibase portal, viewed under the developer information. */
|
|
176
170
|
200: {
|
|
177
171
|
content: {
|
|
178
|
-
"application/json": components["schemas"]["rowOutput"]
|
|
179
|
-
}
|
|
180
|
-
}
|
|
181
|
-
}
|
|
172
|
+
"application/json": components["schemas"]["rowOutput"];
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
};
|
|
182
176
|
requestBody: {
|
|
183
177
|
content: {
|
|
184
|
-
"application/json": components["schemas"]["row"]
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
}
|
|
178
|
+
"application/json": components["schemas"]["row"];
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
};
|
|
189
183
|
"/tables/{tableId}/rows/{rowId}": {
|
|
190
184
|
/** This gets a single row, it will be enriched with the full related rows, rather than the squashed "primaryDisplay" format returned by the search endpoint. */
|
|
191
185
|
get: {
|
|
192
186
|
parameters: {
|
|
193
187
|
path: {
|
|
194
188
|
/** The ID of the table which this request is targeting. */
|
|
195
|
-
tableId: components["parameters"]["tableId"]
|
|
189
|
+
tableId: components["parameters"]["tableId"];
|
|
196
190
|
/** The ID of the row which this request is targeting. */
|
|
197
|
-
rowId: components["parameters"]["rowId"]
|
|
198
|
-
}
|
|
191
|
+
rowId: components["parameters"]["rowId"];
|
|
192
|
+
};
|
|
199
193
|
header: {
|
|
200
194
|
/** The ID of the app which this request is targeting. */
|
|
201
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
202
|
-
}
|
|
203
|
-
}
|
|
195
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
196
|
+
};
|
|
197
|
+
};
|
|
204
198
|
responses: {
|
|
205
199
|
/** Returns the retrieved row. */
|
|
206
200
|
200: {
|
|
207
201
|
content: {
|
|
208
|
-
"application/json": components["schemas"]["rowOutput"]
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
}
|
|
202
|
+
"application/json": components["schemas"]["rowOutput"];
|
|
203
|
+
};
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
};
|
|
213
207
|
/** Updates a row within the specified table. */
|
|
214
208
|
put: {
|
|
215
209
|
parameters: {
|
|
216
210
|
path: {
|
|
217
211
|
/** The ID of the table which this request is targeting. */
|
|
218
|
-
tableId: components["parameters"]["tableId"]
|
|
212
|
+
tableId: components["parameters"]["tableId"];
|
|
219
213
|
/** The ID of the row which this request is targeting. */
|
|
220
|
-
rowId: components["parameters"]["rowId"]
|
|
221
|
-
}
|
|
214
|
+
rowId: components["parameters"]["rowId"];
|
|
215
|
+
};
|
|
222
216
|
header: {
|
|
223
217
|
/** The ID of the app which this request is targeting. */
|
|
224
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
225
|
-
}
|
|
226
|
-
}
|
|
218
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
219
|
+
};
|
|
220
|
+
};
|
|
227
221
|
responses: {
|
|
228
222
|
/** Returns the created row, including the ID which has been generated for it. */
|
|
229
223
|
200: {
|
|
230
224
|
content: {
|
|
231
|
-
"application/json": components["schemas"]["rowOutput"]
|
|
232
|
-
}
|
|
233
|
-
}
|
|
234
|
-
}
|
|
225
|
+
"application/json": components["schemas"]["rowOutput"];
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
};
|
|
235
229
|
requestBody: {
|
|
236
230
|
content: {
|
|
237
|
-
"application/json": components["schemas"]["row"]
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
}
|
|
231
|
+
"application/json": components["schemas"]["row"];
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
};
|
|
241
235
|
/** Deletes a row within the specified table. */
|
|
242
236
|
delete: {
|
|
243
237
|
parameters: {
|
|
244
238
|
path: {
|
|
245
239
|
/** The ID of the table which this request is targeting. */
|
|
246
|
-
tableId: components["parameters"]["tableId"]
|
|
240
|
+
tableId: components["parameters"]["tableId"];
|
|
247
241
|
/** The ID of the row which this request is targeting. */
|
|
248
|
-
rowId: components["parameters"]["rowId"]
|
|
249
|
-
}
|
|
242
|
+
rowId: components["parameters"]["rowId"];
|
|
243
|
+
};
|
|
250
244
|
header: {
|
|
251
245
|
/** The ID of the app which this request is targeting. */
|
|
252
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
253
|
-
}
|
|
254
|
-
}
|
|
246
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
247
|
+
};
|
|
248
|
+
};
|
|
255
249
|
responses: {
|
|
256
250
|
/** Returns the deleted row, including the ID which has been generated for it. */
|
|
257
251
|
200: {
|
|
258
252
|
content: {
|
|
259
|
-
"application/json": components["schemas"]["rowOutput"]
|
|
260
|
-
}
|
|
261
|
-
}
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
}
|
|
253
|
+
"application/json": components["schemas"]["rowOutput"];
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
};
|
|
258
|
+
};
|
|
265
259
|
"/tables/{tableId}/rows/search": {
|
|
266
260
|
post: {
|
|
267
261
|
parameters: {
|
|
268
262
|
path: {
|
|
269
263
|
/** The ID of the table which this request is targeting. */
|
|
270
|
-
tableId: components["parameters"]["tableId"]
|
|
271
|
-
}
|
|
264
|
+
tableId: components["parameters"]["tableId"];
|
|
265
|
+
};
|
|
272
266
|
header: {
|
|
273
267
|
/** The ID of the app which this request is targeting. */
|
|
274
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
275
|
-
}
|
|
276
|
-
}
|
|
268
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
269
|
+
};
|
|
270
|
+
};
|
|
277
271
|
responses: {
|
|
278
272
|
/** The response will contain an array of rows that match the search parameters. */
|
|
279
273
|
200: {
|
|
280
274
|
content: {
|
|
281
|
-
"application/json": components["schemas"]["searchOutput"]
|
|
282
|
-
}
|
|
283
|
-
}
|
|
284
|
-
}
|
|
275
|
+
"application/json": components["schemas"]["searchOutput"];
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
};
|
|
285
279
|
requestBody: {
|
|
286
280
|
content: {
|
|
287
281
|
"application/json": {
|
|
@@ -290,244 +284,244 @@ export interface paths {
|
|
|
290
284
|
* @description A map of field name to the string to search for, this will look for rows that have a value starting with the string value.
|
|
291
285
|
* @example [object Object]
|
|
292
286
|
*/
|
|
293
|
-
string?: { [key: string]: string }
|
|
287
|
+
string?: { [key: string]: string };
|
|
294
288
|
/** @description A fuzzy search, only supported by internal tables. */
|
|
295
|
-
fuzzy?: { [key: string]: unknown }
|
|
289
|
+
fuzzy?: { [key: string]: unknown };
|
|
296
290
|
/**
|
|
297
291
|
* @description Searches within a range, the format of this must be columnName -> [low, high].
|
|
298
292
|
* @example [object Object]
|
|
299
293
|
*/
|
|
300
|
-
range?: { [key: string]: unknown }
|
|
294
|
+
range?: { [key: string]: unknown };
|
|
301
295
|
/** @description Searches for rows that have a column value that is exactly the value set. */
|
|
302
|
-
equal?: { [key: string]: unknown }
|
|
296
|
+
equal?: { [key: string]: unknown };
|
|
303
297
|
/** @description Searches for any row which does not contain the specified column value. */
|
|
304
|
-
notEqual?: { [key: string]: unknown }
|
|
298
|
+
notEqual?: { [key: string]: unknown };
|
|
305
299
|
/**
|
|
306
300
|
* @description Searches for rows which do not contain the specified column. The object should simply contain keys of the column names, these can map to any value.
|
|
307
301
|
* @example [object Object]
|
|
308
302
|
*/
|
|
309
|
-
empty?: { [key: string]: unknown }
|
|
303
|
+
empty?: { [key: string]: unknown };
|
|
310
304
|
/** @description Searches for rows which have the specified column. */
|
|
311
|
-
notEmpty?: { [key: string]: unknown }
|
|
305
|
+
notEmpty?: { [key: string]: unknown };
|
|
312
306
|
/** @description Searches for rows which have a column value that is any of the specified values. The format of this must be columnName -> [value1, value2]. */
|
|
313
|
-
oneOf?: { [key: string]: unknown }
|
|
314
|
-
}
|
|
307
|
+
oneOf?: { [key: string]: unknown };
|
|
308
|
+
};
|
|
315
309
|
/** @description Enables pagination, by default this is disabled. */
|
|
316
|
-
paginate?: boolean
|
|
310
|
+
paginate?: boolean;
|
|
317
311
|
/** @description If retrieving another page, the bookmark from the previous request must be supplied. */
|
|
318
|
-
bookmark?: string | number
|
|
312
|
+
bookmark?: string | number;
|
|
319
313
|
/** @description The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000. */
|
|
320
|
-
limit?: number
|
|
314
|
+
limit?: number;
|
|
321
315
|
/** @description A set of parameters describing the sort behaviour of the search. */
|
|
322
316
|
sort?: {
|
|
323
317
|
/**
|
|
324
318
|
* @description The order of the sort, by default this is ascending.
|
|
325
319
|
* @enum {string}
|
|
326
320
|
*/
|
|
327
|
-
order?: "ascending" | "descending"
|
|
321
|
+
order?: "ascending" | "descending";
|
|
328
322
|
/** @description The name of the column by which the rows will be sorted. */
|
|
329
|
-
column?: string
|
|
323
|
+
column?: string;
|
|
330
324
|
/**
|
|
331
325
|
* @description Defines whether the column should be treated as a string or as numbers when sorting.
|
|
332
326
|
* @enum {string}
|
|
333
327
|
*/
|
|
334
|
-
type?: "string" | "number"
|
|
335
|
-
}
|
|
336
|
-
}
|
|
337
|
-
}
|
|
338
|
-
}
|
|
339
|
-
}
|
|
340
|
-
}
|
|
328
|
+
type?: "string" | "number";
|
|
329
|
+
};
|
|
330
|
+
};
|
|
331
|
+
};
|
|
332
|
+
};
|
|
333
|
+
};
|
|
334
|
+
};
|
|
341
335
|
"/tables": {
|
|
342
336
|
/** Create a table, this could be internal or external. */
|
|
343
337
|
post: {
|
|
344
338
|
parameters: {
|
|
345
339
|
header: {
|
|
346
340
|
/** The ID of the app which this request is targeting. */
|
|
347
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
348
|
-
}
|
|
349
|
-
}
|
|
341
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
342
|
+
};
|
|
343
|
+
};
|
|
350
344
|
responses: {
|
|
351
345
|
/** Returns the created table, including the ID which has been generated for it. This can be internal or external data sources. */
|
|
352
346
|
200: {
|
|
353
347
|
content: {
|
|
354
|
-
"application/json": components["schemas"]["tableOutput"]
|
|
355
|
-
}
|
|
356
|
-
}
|
|
357
|
-
}
|
|
348
|
+
"application/json": components["schemas"]["tableOutput"];
|
|
349
|
+
};
|
|
350
|
+
};
|
|
351
|
+
};
|
|
358
352
|
requestBody: {
|
|
359
353
|
content: {
|
|
360
|
-
"application/json": components["schemas"]["table"]
|
|
361
|
-
}
|
|
362
|
-
}
|
|
363
|
-
}
|
|
364
|
-
}
|
|
354
|
+
"application/json": components["schemas"]["table"];
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
};
|
|
358
|
+
};
|
|
365
359
|
"/tables/{tableId}": {
|
|
366
360
|
/** Lookup a table, this could be internal or external. */
|
|
367
361
|
get: {
|
|
368
362
|
parameters: {
|
|
369
363
|
path: {
|
|
370
364
|
/** The ID of the table which this request is targeting. */
|
|
371
|
-
tableId: components["parameters"]["tableId"]
|
|
372
|
-
}
|
|
365
|
+
tableId: components["parameters"]["tableId"];
|
|
366
|
+
};
|
|
373
367
|
header: {
|
|
374
368
|
/** The ID of the app which this request is targeting. */
|
|
375
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
376
|
-
}
|
|
377
|
-
}
|
|
369
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
370
|
+
};
|
|
371
|
+
};
|
|
378
372
|
responses: {
|
|
379
373
|
/** Returns the retrieved table. */
|
|
380
374
|
200: {
|
|
381
375
|
content: {
|
|
382
|
-
"application/json": components["schemas"]["tableOutput"]
|
|
383
|
-
}
|
|
384
|
-
}
|
|
385
|
-
}
|
|
386
|
-
}
|
|
376
|
+
"application/json": components["schemas"]["tableOutput"];
|
|
377
|
+
};
|
|
378
|
+
};
|
|
379
|
+
};
|
|
380
|
+
};
|
|
387
381
|
/** Update a table, this could be internal or external. */
|
|
388
382
|
put: {
|
|
389
383
|
parameters: {
|
|
390
384
|
path: {
|
|
391
385
|
/** The ID of the table which this request is targeting. */
|
|
392
|
-
tableId: components["parameters"]["tableId"]
|
|
393
|
-
}
|
|
386
|
+
tableId: components["parameters"]["tableId"];
|
|
387
|
+
};
|
|
394
388
|
header: {
|
|
395
389
|
/** The ID of the app which this request is targeting. */
|
|
396
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
397
|
-
}
|
|
398
|
-
}
|
|
390
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
391
|
+
};
|
|
392
|
+
};
|
|
399
393
|
responses: {
|
|
400
394
|
/** Returns the updated table. */
|
|
401
395
|
200: {
|
|
402
396
|
content: {
|
|
403
|
-
"application/json": components["schemas"]["tableOutput"]
|
|
404
|
-
}
|
|
405
|
-
}
|
|
406
|
-
}
|
|
397
|
+
"application/json": components["schemas"]["tableOutput"];
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
};
|
|
407
401
|
requestBody: {
|
|
408
402
|
content: {
|
|
409
|
-
"application/json": components["schemas"]["table"]
|
|
410
|
-
}
|
|
411
|
-
}
|
|
412
|
-
}
|
|
403
|
+
"application/json": components["schemas"]["table"];
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
};
|
|
413
407
|
/** Delete a table, this could be internal or external. */
|
|
414
408
|
delete: {
|
|
415
409
|
parameters: {
|
|
416
410
|
path: {
|
|
417
411
|
/** The ID of the table which this request is targeting. */
|
|
418
|
-
tableId: components["parameters"]["tableId"]
|
|
419
|
-
}
|
|
412
|
+
tableId: components["parameters"]["tableId"];
|
|
413
|
+
};
|
|
420
414
|
header: {
|
|
421
415
|
/** The ID of the app which this request is targeting. */
|
|
422
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
423
|
-
}
|
|
424
|
-
}
|
|
416
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
417
|
+
};
|
|
418
|
+
};
|
|
425
419
|
responses: {
|
|
426
420
|
/** Returns the deleted table. */
|
|
427
421
|
200: {
|
|
428
422
|
content: {
|
|
429
|
-
"application/json": components["schemas"]["tableOutput"]
|
|
430
|
-
}
|
|
431
|
-
}
|
|
432
|
-
}
|
|
433
|
-
}
|
|
434
|
-
}
|
|
423
|
+
"application/json": components["schemas"]["tableOutput"];
|
|
424
|
+
};
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
};
|
|
435
429
|
"/tables/search": {
|
|
436
430
|
/** Based on table properties (currently only name) search for tables. This could be an internal or an external table. */
|
|
437
431
|
post: {
|
|
438
432
|
parameters: {
|
|
439
433
|
header: {
|
|
440
434
|
/** The ID of the app which this request is targeting. */
|
|
441
|
-
"x-budibase-app-id": components["parameters"]["appId"]
|
|
442
|
-
}
|
|
443
|
-
}
|
|
435
|
+
"x-budibase-app-id": components["parameters"]["appId"];
|
|
436
|
+
};
|
|
437
|
+
};
|
|
444
438
|
responses: {
|
|
445
439
|
/** Returns the found tables, based on the search parameters. */
|
|
446
440
|
200: {
|
|
447
441
|
content: {
|
|
448
|
-
"application/json": components["schemas"]["tableSearch"]
|
|
449
|
-
}
|
|
450
|
-
}
|
|
451
|
-
}
|
|
442
|
+
"application/json": components["schemas"]["tableSearch"];
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
};
|
|
452
446
|
requestBody: {
|
|
453
447
|
content: {
|
|
454
|
-
"application/json": components["schemas"]["nameSearch"]
|
|
455
|
-
}
|
|
456
|
-
}
|
|
457
|
-
}
|
|
458
|
-
}
|
|
448
|
+
"application/json": components["schemas"]["nameSearch"];
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
};
|
|
452
|
+
};
|
|
459
453
|
"/users": {
|
|
460
454
|
post: {
|
|
461
455
|
responses: {
|
|
462
456
|
/** Returns the created user. */
|
|
463
457
|
200: {
|
|
464
458
|
content: {
|
|
465
|
-
"application/json": components["schemas"]["userOutput"]
|
|
466
|
-
}
|
|
467
|
-
}
|
|
468
|
-
}
|
|
459
|
+
"application/json": components["schemas"]["userOutput"];
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
};
|
|
469
463
|
requestBody: {
|
|
470
464
|
content: {
|
|
471
|
-
"application/json": components["schemas"]["user"]
|
|
472
|
-
}
|
|
473
|
-
}
|
|
474
|
-
}
|
|
475
|
-
}
|
|
465
|
+
"application/json": components["schemas"]["user"];
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
};
|
|
476
470
|
"/users/{userId}": {
|
|
477
471
|
get: {
|
|
478
472
|
parameters: {
|
|
479
473
|
path: {
|
|
480
474
|
/** The ID of the user which this request is targeting. */
|
|
481
|
-
userId: components["parameters"]["userId"]
|
|
482
|
-
}
|
|
483
|
-
}
|
|
475
|
+
userId: components["parameters"]["userId"];
|
|
476
|
+
};
|
|
477
|
+
};
|
|
484
478
|
responses: {
|
|
485
479
|
/** Returns the retrieved user. */
|
|
486
480
|
200: {
|
|
487
481
|
content: {
|
|
488
|
-
"application/json": components["schemas"]["userOutput"]
|
|
489
|
-
}
|
|
490
|
-
}
|
|
491
|
-
}
|
|
492
|
-
}
|
|
482
|
+
"application/json": components["schemas"]["userOutput"];
|
|
483
|
+
};
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
};
|
|
493
487
|
put: {
|
|
494
488
|
parameters: {
|
|
495
489
|
path: {
|
|
496
490
|
/** The ID of the user which this request is targeting. */
|
|
497
|
-
userId: components["parameters"]["userId"]
|
|
498
|
-
}
|
|
499
|
-
}
|
|
491
|
+
userId: components["parameters"]["userId"];
|
|
492
|
+
};
|
|
493
|
+
};
|
|
500
494
|
responses: {
|
|
501
495
|
/** Returns the updated user. */
|
|
502
496
|
200: {
|
|
503
497
|
content: {
|
|
504
|
-
"application/json": components["schemas"]["userOutput"]
|
|
505
|
-
}
|
|
506
|
-
}
|
|
507
|
-
}
|
|
498
|
+
"application/json": components["schemas"]["userOutput"];
|
|
499
|
+
};
|
|
500
|
+
};
|
|
501
|
+
};
|
|
508
502
|
requestBody: {
|
|
509
503
|
content: {
|
|
510
|
-
"application/json": components["schemas"]["user"]
|
|
511
|
-
}
|
|
512
|
-
}
|
|
513
|
-
}
|
|
504
|
+
"application/json": components["schemas"]["user"];
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
};
|
|
514
508
|
delete: {
|
|
515
509
|
parameters: {
|
|
516
510
|
path: {
|
|
517
511
|
/** The ID of the user which this request is targeting. */
|
|
518
|
-
userId: components["parameters"]["userId"]
|
|
519
|
-
}
|
|
520
|
-
}
|
|
512
|
+
userId: components["parameters"]["userId"];
|
|
513
|
+
};
|
|
514
|
+
};
|
|
521
515
|
responses: {
|
|
522
516
|
/** Returns the deleted user. */
|
|
523
517
|
200: {
|
|
524
518
|
content: {
|
|
525
|
-
"application/json": components["schemas"]["userOutput"]
|
|
526
|
-
}
|
|
527
|
-
}
|
|
528
|
-
}
|
|
529
|
-
}
|
|
530
|
-
}
|
|
519
|
+
"application/json": components["schemas"]["userOutput"];
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
};
|
|
531
525
|
"/users/search": {
|
|
532
526
|
/** Based on user properties (currently only name) search for users. */
|
|
533
527
|
post: {
|
|
@@ -535,102 +529,102 @@ export interface paths {
|
|
|
535
529
|
/** Returns the found users based on search parameters. */
|
|
536
530
|
200: {
|
|
537
531
|
content: {
|
|
538
|
-
"application/json": components["schemas"]["userSearch"]
|
|
539
|
-
}
|
|
540
|
-
}
|
|
541
|
-
}
|
|
532
|
+
"application/json": components["schemas"]["userSearch"];
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
542
536
|
requestBody: {
|
|
543
537
|
content: {
|
|
544
|
-
"application/json": components["schemas"]["nameSearch"]
|
|
545
|
-
}
|
|
546
|
-
}
|
|
547
|
-
}
|
|
548
|
-
}
|
|
538
|
+
"application/json": components["schemas"]["nameSearch"];
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
};
|
|
549
543
|
}
|
|
550
544
|
|
|
551
545
|
export interface components {
|
|
552
546
|
schemas: {
|
|
553
547
|
application: {
|
|
554
548
|
/** @description The name of the app. */
|
|
555
|
-
name: string
|
|
549
|
+
name: string;
|
|
556
550
|
/** @description The URL by which the app is accessed, this must be URL encoded. */
|
|
557
|
-
url
|
|
558
|
-
}
|
|
551
|
+
url?: string;
|
|
552
|
+
};
|
|
559
553
|
applicationOutput: {
|
|
560
554
|
data: {
|
|
561
555
|
/** @description The name of the app. */
|
|
562
|
-
name: string
|
|
556
|
+
name: string;
|
|
563
557
|
/** @description The URL by which the app is accessed, this must be URL encoded. */
|
|
564
|
-
url: string
|
|
558
|
+
url: string;
|
|
565
559
|
/** @description The ID of the app. */
|
|
566
|
-
_id: string
|
|
560
|
+
_id: string;
|
|
567
561
|
/**
|
|
568
562
|
* @description The status of the app, stating it if is the development or published version.
|
|
569
563
|
* @enum {string}
|
|
570
564
|
*/
|
|
571
|
-
status: "development" | "published"
|
|
565
|
+
status: "development" | "published";
|
|
572
566
|
/** @description States when the app was created, will be constant. Stored in ISO format. */
|
|
573
|
-
createdAt: string
|
|
567
|
+
createdAt: string;
|
|
574
568
|
/** @description States the last time the app was updated - stored in ISO format. */
|
|
575
|
-
updatedAt: string
|
|
569
|
+
updatedAt: string;
|
|
576
570
|
/** @description States the version of the Budibase client this app is currently based on. */
|
|
577
|
-
version: string
|
|
571
|
+
version: string;
|
|
578
572
|
/** @description In a multi-tenant environment this will state the tenant this app is within. */
|
|
579
|
-
tenantId?: string
|
|
573
|
+
tenantId?: string;
|
|
580
574
|
/** @description The user this app is currently being built by. */
|
|
581
|
-
lockedBy?: { [key: string]: unknown }
|
|
582
|
-
}
|
|
583
|
-
}
|
|
575
|
+
lockedBy?: { [key: string]: unknown };
|
|
576
|
+
};
|
|
577
|
+
};
|
|
584
578
|
applicationSearch: {
|
|
585
579
|
data: {
|
|
586
580
|
/** @description The name of the app. */
|
|
587
|
-
name: string
|
|
581
|
+
name: string;
|
|
588
582
|
/** @description The URL by which the app is accessed, this must be URL encoded. */
|
|
589
|
-
url: string
|
|
583
|
+
url: string;
|
|
590
584
|
/** @description The ID of the app. */
|
|
591
|
-
_id: string
|
|
585
|
+
_id: string;
|
|
592
586
|
/**
|
|
593
587
|
* @description The status of the app, stating it if is the development or published version.
|
|
594
588
|
* @enum {string}
|
|
595
589
|
*/
|
|
596
|
-
status: "development" | "published"
|
|
590
|
+
status: "development" | "published";
|
|
597
591
|
/** @description States when the app was created, will be constant. Stored in ISO format. */
|
|
598
|
-
createdAt: string
|
|
592
|
+
createdAt: string;
|
|
599
593
|
/** @description States the last time the app was updated - stored in ISO format. */
|
|
600
|
-
updatedAt: string
|
|
594
|
+
updatedAt: string;
|
|
601
595
|
/** @description States the version of the Budibase client this app is currently based on. */
|
|
602
|
-
version: string
|
|
596
|
+
version: string;
|
|
603
597
|
/** @description In a multi-tenant environment this will state the tenant this app is within. */
|
|
604
|
-
tenantId?: string
|
|
598
|
+
tenantId?: string;
|
|
605
599
|
/** @description The user this app is currently being built by. */
|
|
606
|
-
lockedBy?: { [key: string]: unknown }
|
|
607
|
-
}[]
|
|
608
|
-
}
|
|
600
|
+
lockedBy?: { [key: string]: unknown };
|
|
601
|
+
}[];
|
|
602
|
+
};
|
|
609
603
|
/** @description The row to be created/updated, based on the table schema. */
|
|
610
|
-
row: { [key: string]: unknown }
|
|
604
|
+
row: { [key: string]: unknown };
|
|
611
605
|
searchOutput: {
|
|
612
606
|
/** @description An array of rows, these will each contain an _id field which can be used to update or delete them. */
|
|
613
|
-
data: { [key: string]: unknown }[]
|
|
607
|
+
data: { [key: string]: unknown }[];
|
|
614
608
|
/** @description If pagination in use, this should be provided. */
|
|
615
|
-
bookmark?: string | number
|
|
609
|
+
bookmark?: string | number;
|
|
616
610
|
/** @description If pagination in use, this will determine if there is another page to fetch. */
|
|
617
|
-
hasNextPage?: boolean
|
|
618
|
-
}
|
|
611
|
+
hasNextPage?: boolean;
|
|
612
|
+
};
|
|
619
613
|
rowOutput: {
|
|
620
614
|
/** @description The row to be created/updated, based on the table schema. */
|
|
621
615
|
data: {
|
|
622
616
|
/** @description The ID of the row. */
|
|
623
|
-
_id: string
|
|
617
|
+
_id: string;
|
|
624
618
|
/** @description The ID of the table this row comes from. */
|
|
625
|
-
tableId: string
|
|
626
|
-
} & { [key: string]: unknown }
|
|
627
|
-
}
|
|
619
|
+
tableId: string;
|
|
620
|
+
} & { [key: string]: unknown };
|
|
621
|
+
};
|
|
628
622
|
/** @description The table to be created/updated. */
|
|
629
623
|
table: {
|
|
630
624
|
/** @description The name of the table. */
|
|
631
|
-
name: string
|
|
625
|
+
name: string;
|
|
632
626
|
/** @description The name of the column which should be used in relationship tags when relating to this table. */
|
|
633
|
-
primaryDisplay?: string
|
|
627
|
+
primaryDisplay?: string;
|
|
634
628
|
schema: {
|
|
635
629
|
[key: string]:
|
|
636
630
|
| {
|
|
@@ -638,60 +632,60 @@ export interface components {
|
|
|
638
632
|
* @description A relationship column.
|
|
639
633
|
* @enum {string}
|
|
640
634
|
*/
|
|
641
|
-
type?: "link"
|
|
635
|
+
type?: "link";
|
|
642
636
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
643
637
|
constraints?: {
|
|
644
638
|
/** @enum {string} */
|
|
645
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
639
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
646
640
|
/** @description Defines whether the column is required or not. */
|
|
647
|
-
presence?: boolean
|
|
648
|
-
}
|
|
641
|
+
presence?: boolean;
|
|
642
|
+
};
|
|
649
643
|
/** @description The name of the column. */
|
|
650
|
-
name?: string
|
|
644
|
+
name?: string;
|
|
651
645
|
/** @description Defines whether the column is automatically generated. */
|
|
652
|
-
autocolumn?: boolean
|
|
646
|
+
autocolumn?: boolean;
|
|
653
647
|
/** @description The name of the column which a relationship column is related to in another table. */
|
|
654
|
-
fieldName?: string
|
|
648
|
+
fieldName?: string;
|
|
655
649
|
/** @description The ID of the table which a relationship column is related to. */
|
|
656
|
-
tableId?: string
|
|
650
|
+
tableId?: string;
|
|
657
651
|
/**
|
|
658
652
|
* @description Defines the type of relationship that this column will be used for.
|
|
659
653
|
* @enum {string}
|
|
660
654
|
*/
|
|
661
|
-
relationshipType?: "one-to-many" | "many-to-one" | "many-to-many"
|
|
655
|
+
relationshipType?: "one-to-many" | "many-to-one" | "many-to-many";
|
|
662
656
|
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
|
|
663
|
-
through?: string
|
|
657
|
+
through?: string;
|
|
664
658
|
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
|
|
665
|
-
foreignKey?: string
|
|
659
|
+
foreignKey?: string;
|
|
666
660
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
|
|
667
|
-
throughFrom?: string
|
|
661
|
+
throughFrom?: string;
|
|
668
662
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
|
|
669
|
-
throughTo?: string
|
|
663
|
+
throughTo?: string;
|
|
670
664
|
}
|
|
671
665
|
| {
|
|
672
666
|
/**
|
|
673
667
|
* @description A formula column.
|
|
674
668
|
* @enum {string}
|
|
675
669
|
*/
|
|
676
|
-
type?: "formula"
|
|
670
|
+
type?: "formula";
|
|
677
671
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
678
672
|
constraints?: {
|
|
679
673
|
/** @enum {string} */
|
|
680
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
674
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
681
675
|
/** @description Defines whether the column is required or not. */
|
|
682
|
-
presence?: boolean
|
|
683
|
-
}
|
|
676
|
+
presence?: boolean;
|
|
677
|
+
};
|
|
684
678
|
/** @description The name of the column. */
|
|
685
|
-
name?: string
|
|
679
|
+
name?: string;
|
|
686
680
|
/** @description Defines whether the column is automatically generated. */
|
|
687
|
-
autocolumn?: boolean
|
|
681
|
+
autocolumn?: boolean;
|
|
688
682
|
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
|
|
689
|
-
formula?: string
|
|
683
|
+
formula?: string;
|
|
690
684
|
/**
|
|
691
685
|
* @description Defines whether this is a static or dynamic formula.
|
|
692
686
|
* @enum {string}
|
|
693
687
|
*/
|
|
694
|
-
formulaType?: "static" | "dynamic"
|
|
688
|
+
formulaType?: "static" | "dynamic";
|
|
695
689
|
}
|
|
696
690
|
| {
|
|
697
691
|
/**
|
|
@@ -711,28 +705,28 @@ export interface components {
|
|
|
711
705
|
| "formula"
|
|
712
706
|
| "auto"
|
|
713
707
|
| "json"
|
|
714
|
-
| "internal"
|
|
708
|
+
| "internal";
|
|
715
709
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
716
710
|
constraints?: {
|
|
717
711
|
/** @enum {string} */
|
|
718
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
712
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
719
713
|
/** @description Defines whether the column is required or not. */
|
|
720
|
-
presence?: boolean
|
|
721
|
-
}
|
|
714
|
+
presence?: boolean;
|
|
715
|
+
};
|
|
722
716
|
/** @description The name of the column. */
|
|
723
|
-
name?: string
|
|
717
|
+
name?: string;
|
|
724
718
|
/** @description Defines whether the column is automatically generated. */
|
|
725
|
-
autocolumn?: boolean
|
|
726
|
-
}
|
|
727
|
-
}
|
|
728
|
-
}
|
|
719
|
+
autocolumn?: boolean;
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
};
|
|
729
723
|
tableOutput: {
|
|
730
724
|
/** @description The table to be created/updated. */
|
|
731
725
|
data: {
|
|
732
726
|
/** @description The name of the table. */
|
|
733
|
-
name: string
|
|
727
|
+
name: string;
|
|
734
728
|
/** @description The name of the column which should be used in relationship tags when relating to this table. */
|
|
735
|
-
primaryDisplay?: string
|
|
729
|
+
primaryDisplay?: string;
|
|
736
730
|
schema: {
|
|
737
731
|
[key: string]:
|
|
738
732
|
| {
|
|
@@ -740,22 +734,22 @@ export interface components {
|
|
|
740
734
|
* @description A relationship column.
|
|
741
735
|
* @enum {string}
|
|
742
736
|
*/
|
|
743
|
-
type?: "link"
|
|
737
|
+
type?: "link";
|
|
744
738
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
745
739
|
constraints?: {
|
|
746
740
|
/** @enum {string} */
|
|
747
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
741
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
748
742
|
/** @description Defines whether the column is required or not. */
|
|
749
|
-
presence?: boolean
|
|
750
|
-
}
|
|
743
|
+
presence?: boolean;
|
|
744
|
+
};
|
|
751
745
|
/** @description The name of the column. */
|
|
752
|
-
name?: string
|
|
746
|
+
name?: string;
|
|
753
747
|
/** @description Defines whether the column is automatically generated. */
|
|
754
|
-
autocolumn?: boolean
|
|
748
|
+
autocolumn?: boolean;
|
|
755
749
|
/** @description The name of the column which a relationship column is related to in another table. */
|
|
756
|
-
fieldName?: string
|
|
750
|
+
fieldName?: string;
|
|
757
751
|
/** @description The ID of the table which a relationship column is related to. */
|
|
758
|
-
tableId?: string
|
|
752
|
+
tableId?: string;
|
|
759
753
|
/**
|
|
760
754
|
* @description Defines the type of relationship that this column will be used for.
|
|
761
755
|
* @enum {string}
|
|
@@ -763,40 +757,40 @@ export interface components {
|
|
|
763
757
|
relationshipType?:
|
|
764
758
|
| "one-to-many"
|
|
765
759
|
| "many-to-one"
|
|
766
|
-
| "many-to-many"
|
|
760
|
+
| "many-to-many";
|
|
767
761
|
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
|
|
768
|
-
through?: string
|
|
762
|
+
through?: string;
|
|
769
763
|
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
|
|
770
|
-
foreignKey?: string
|
|
764
|
+
foreignKey?: string;
|
|
771
765
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
|
|
772
|
-
throughFrom?: string
|
|
766
|
+
throughFrom?: string;
|
|
773
767
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
|
|
774
|
-
throughTo?: string
|
|
768
|
+
throughTo?: string;
|
|
775
769
|
}
|
|
776
770
|
| {
|
|
777
771
|
/**
|
|
778
772
|
* @description A formula column.
|
|
779
773
|
* @enum {string}
|
|
780
774
|
*/
|
|
781
|
-
type?: "formula"
|
|
775
|
+
type?: "formula";
|
|
782
776
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
783
777
|
constraints?: {
|
|
784
778
|
/** @enum {string} */
|
|
785
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
779
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
786
780
|
/** @description Defines whether the column is required or not. */
|
|
787
|
-
presence?: boolean
|
|
788
|
-
}
|
|
781
|
+
presence?: boolean;
|
|
782
|
+
};
|
|
789
783
|
/** @description The name of the column. */
|
|
790
|
-
name?: string
|
|
784
|
+
name?: string;
|
|
791
785
|
/** @description Defines whether the column is automatically generated. */
|
|
792
|
-
autocolumn?: boolean
|
|
786
|
+
autocolumn?: boolean;
|
|
793
787
|
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
|
|
794
|
-
formula?: string
|
|
788
|
+
formula?: string;
|
|
795
789
|
/**
|
|
796
790
|
* @description Defines whether this is a static or dynamic formula.
|
|
797
791
|
* @enum {string}
|
|
798
792
|
*/
|
|
799
|
-
formulaType?: "static" | "dynamic"
|
|
793
|
+
formulaType?: "static" | "dynamic";
|
|
800
794
|
}
|
|
801
795
|
| {
|
|
802
796
|
/**
|
|
@@ -816,30 +810,30 @@ export interface components {
|
|
|
816
810
|
| "formula"
|
|
817
811
|
| "auto"
|
|
818
812
|
| "json"
|
|
819
|
-
| "internal"
|
|
813
|
+
| "internal";
|
|
820
814
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
821
815
|
constraints?: {
|
|
822
816
|
/** @enum {string} */
|
|
823
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
817
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
824
818
|
/** @description Defines whether the column is required or not. */
|
|
825
|
-
presence?: boolean
|
|
826
|
-
}
|
|
819
|
+
presence?: boolean;
|
|
820
|
+
};
|
|
827
821
|
/** @description The name of the column. */
|
|
828
|
-
name?: string
|
|
822
|
+
name?: string;
|
|
829
823
|
/** @description Defines whether the column is automatically generated. */
|
|
830
|
-
autocolumn?: boolean
|
|
831
|
-
}
|
|
832
|
-
}
|
|
824
|
+
autocolumn?: boolean;
|
|
825
|
+
};
|
|
826
|
+
};
|
|
833
827
|
/** @description The ID of the table. */
|
|
834
|
-
_id: string
|
|
835
|
-
}
|
|
836
|
-
}
|
|
828
|
+
_id: string;
|
|
829
|
+
};
|
|
830
|
+
};
|
|
837
831
|
tableSearch: {
|
|
838
832
|
data: {
|
|
839
833
|
/** @description The name of the table. */
|
|
840
|
-
name: string
|
|
834
|
+
name: string;
|
|
841
835
|
/** @description The name of the column which should be used in relationship tags when relating to this table. */
|
|
842
|
-
primaryDisplay?: string
|
|
836
|
+
primaryDisplay?: string;
|
|
843
837
|
schema: {
|
|
844
838
|
[key: string]:
|
|
845
839
|
| {
|
|
@@ -847,22 +841,22 @@ export interface components {
|
|
|
847
841
|
* @description A relationship column.
|
|
848
842
|
* @enum {string}
|
|
849
843
|
*/
|
|
850
|
-
type?: "link"
|
|
844
|
+
type?: "link";
|
|
851
845
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
852
846
|
constraints?: {
|
|
853
847
|
/** @enum {string} */
|
|
854
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
848
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
855
849
|
/** @description Defines whether the column is required or not. */
|
|
856
|
-
presence?: boolean
|
|
857
|
-
}
|
|
850
|
+
presence?: boolean;
|
|
851
|
+
};
|
|
858
852
|
/** @description The name of the column. */
|
|
859
|
-
name?: string
|
|
853
|
+
name?: string;
|
|
860
854
|
/** @description Defines whether the column is automatically generated. */
|
|
861
|
-
autocolumn?: boolean
|
|
855
|
+
autocolumn?: boolean;
|
|
862
856
|
/** @description The name of the column which a relationship column is related to in another table. */
|
|
863
|
-
fieldName?: string
|
|
857
|
+
fieldName?: string;
|
|
864
858
|
/** @description The ID of the table which a relationship column is related to. */
|
|
865
|
-
tableId?: string
|
|
859
|
+
tableId?: string;
|
|
866
860
|
/**
|
|
867
861
|
* @description Defines the type of relationship that this column will be used for.
|
|
868
862
|
* @enum {string}
|
|
@@ -870,40 +864,40 @@ export interface components {
|
|
|
870
864
|
relationshipType?:
|
|
871
865
|
| "one-to-many"
|
|
872
866
|
| "many-to-one"
|
|
873
|
-
| "many-to-many"
|
|
867
|
+
| "many-to-many";
|
|
874
868
|
/** @description When using a SQL table that contains many to many relationships this defines the table the relationships are linked through. */
|
|
875
|
-
through?: string
|
|
869
|
+
through?: string;
|
|
876
870
|
/** @description When using a SQL table that contains a one to many relationship this defines the foreign key. */
|
|
877
|
-
foreignKey?: string
|
|
871
|
+
foreignKey?: string;
|
|
878
872
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for this table. */
|
|
879
|
-
throughFrom?: string
|
|
873
|
+
throughFrom?: string;
|
|
880
874
|
/** @description When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table. */
|
|
881
|
-
throughTo?: string
|
|
875
|
+
throughTo?: string;
|
|
882
876
|
}
|
|
883
877
|
| {
|
|
884
878
|
/**
|
|
885
879
|
* @description A formula column.
|
|
886
880
|
* @enum {string}
|
|
887
881
|
*/
|
|
888
|
-
type?: "formula"
|
|
882
|
+
type?: "formula";
|
|
889
883
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
890
884
|
constraints?: {
|
|
891
885
|
/** @enum {string} */
|
|
892
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
886
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
893
887
|
/** @description Defines whether the column is required or not. */
|
|
894
|
-
presence?: boolean
|
|
895
|
-
}
|
|
888
|
+
presence?: boolean;
|
|
889
|
+
};
|
|
896
890
|
/** @description The name of the column. */
|
|
897
|
-
name?: string
|
|
891
|
+
name?: string;
|
|
898
892
|
/** @description Defines whether the column is automatically generated. */
|
|
899
|
-
autocolumn?: boolean
|
|
893
|
+
autocolumn?: boolean;
|
|
900
894
|
/** @description Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format. */
|
|
901
|
-
formula?: string
|
|
895
|
+
formula?: string;
|
|
902
896
|
/**
|
|
903
897
|
* @description Defines whether this is a static or dynamic formula.
|
|
904
898
|
* @enum {string}
|
|
905
899
|
*/
|
|
906
|
-
formulaType?: "static" | "dynamic"
|
|
900
|
+
formulaType?: "static" | "dynamic";
|
|
907
901
|
}
|
|
908
902
|
| {
|
|
909
903
|
/**
|
|
@@ -923,201 +917,201 @@ export interface components {
|
|
|
923
917
|
| "formula"
|
|
924
918
|
| "auto"
|
|
925
919
|
| "json"
|
|
926
|
-
| "internal"
|
|
920
|
+
| "internal";
|
|
927
921
|
/** @description A constraint can be applied to the column which will be validated against when a row is saved. */
|
|
928
922
|
constraints?: {
|
|
929
923
|
/** @enum {string} */
|
|
930
|
-
type?: "string" | "number" | "object" | "boolean"
|
|
924
|
+
type?: "string" | "number" | "object" | "boolean";
|
|
931
925
|
/** @description Defines whether the column is required or not. */
|
|
932
|
-
presence?: boolean
|
|
933
|
-
}
|
|
926
|
+
presence?: boolean;
|
|
927
|
+
};
|
|
934
928
|
/** @description The name of the column. */
|
|
935
|
-
name?: string
|
|
929
|
+
name?: string;
|
|
936
930
|
/** @description Defines whether the column is automatically generated. */
|
|
937
|
-
autocolumn?: boolean
|
|
938
|
-
}
|
|
939
|
-
}
|
|
931
|
+
autocolumn?: boolean;
|
|
932
|
+
};
|
|
933
|
+
};
|
|
940
934
|
/** @description The ID of the table. */
|
|
941
|
-
_id: string
|
|
942
|
-
}[]
|
|
943
|
-
}
|
|
935
|
+
_id: string;
|
|
936
|
+
}[];
|
|
937
|
+
};
|
|
944
938
|
/** @description The query body must contain the required parameters for the query, this depends on query type, setup and bindings. */
|
|
945
|
-
executeQuery: { [key: string]: unknown }
|
|
939
|
+
executeQuery: { [key: string]: unknown };
|
|
946
940
|
executeQueryOutput: {
|
|
947
941
|
/** @description The data response from the query. */
|
|
948
|
-
data: { [key: string]: unknown }[]
|
|
942
|
+
data: { [key: string]: unknown }[];
|
|
949
943
|
/** @description Extra information that is not part of the main data, e.g. headers. */
|
|
950
944
|
extra?: {
|
|
951
945
|
/** @description If carrying out a REST request, this will contain the response headers. */
|
|
952
|
-
headers?: { [key: string]: unknown }
|
|
946
|
+
headers?: { [key: string]: unknown };
|
|
953
947
|
/** @description The raw query response, as a string. */
|
|
954
|
-
raw?: string
|
|
955
|
-
}
|
|
948
|
+
raw?: string;
|
|
949
|
+
};
|
|
956
950
|
/** @description If pagination is supported, this will contain the bookmark/anchor information for it. */
|
|
957
|
-
pagination?: { [key: string]: unknown }
|
|
958
|
-
}
|
|
951
|
+
pagination?: { [key: string]: unknown };
|
|
952
|
+
};
|
|
959
953
|
query: {
|
|
960
954
|
/** @description The ID of the query. */
|
|
961
|
-
_id: string
|
|
955
|
+
_id: string;
|
|
962
956
|
/** @description The ID of the data source the query belongs to. */
|
|
963
|
-
datasourceId?: string
|
|
957
|
+
datasourceId?: string;
|
|
964
958
|
/** @description The bindings which are required to perform this query. */
|
|
965
|
-
parameters?: string[]
|
|
959
|
+
parameters?: string[];
|
|
966
960
|
/** @description The fields that are used to perform this query, e.g. the sql statement */
|
|
967
|
-
fields?: { [key: string]: unknown }
|
|
961
|
+
fields?: { [key: string]: unknown };
|
|
968
962
|
/**
|
|
969
963
|
* @description The verb that describes this query.
|
|
970
964
|
* @enum {undefined}
|
|
971
965
|
*/
|
|
972
|
-
queryVerb?: "create" | "read" | "update" | "delete"
|
|
966
|
+
queryVerb?: "create" | "read" | "update" | "delete";
|
|
973
967
|
/** @description The name of the query. */
|
|
974
|
-
name: string
|
|
968
|
+
name: string;
|
|
975
969
|
/** @description The schema of the data returned when the query is executed. */
|
|
976
|
-
schema: { [key: string]: unknown }
|
|
970
|
+
schema: { [key: string]: unknown };
|
|
977
971
|
/** @description The JavaScript transformer function, applied after the query responds with data. */
|
|
978
|
-
transformer?: string
|
|
972
|
+
transformer?: string;
|
|
979
973
|
/** @description Whether the query has readable data. */
|
|
980
|
-
readable?: boolean
|
|
981
|
-
}
|
|
974
|
+
readable?: boolean;
|
|
975
|
+
};
|
|
982
976
|
querySearch: {
|
|
983
977
|
data: {
|
|
984
978
|
/** @description The ID of the query. */
|
|
985
|
-
_id: string
|
|
979
|
+
_id: string;
|
|
986
980
|
/** @description The ID of the data source the query belongs to. */
|
|
987
|
-
datasourceId?: string
|
|
981
|
+
datasourceId?: string;
|
|
988
982
|
/** @description The bindings which are required to perform this query. */
|
|
989
|
-
parameters?: string[]
|
|
983
|
+
parameters?: string[];
|
|
990
984
|
/** @description The fields that are used to perform this query, e.g. the sql statement */
|
|
991
|
-
fields?: { [key: string]: unknown }
|
|
985
|
+
fields?: { [key: string]: unknown };
|
|
992
986
|
/**
|
|
993
987
|
* @description The verb that describes this query.
|
|
994
988
|
* @enum {undefined}
|
|
995
989
|
*/
|
|
996
|
-
queryVerb?: "create" | "read" | "update" | "delete"
|
|
990
|
+
queryVerb?: "create" | "read" | "update" | "delete";
|
|
997
991
|
/** @description The name of the query. */
|
|
998
|
-
name: string
|
|
992
|
+
name: string;
|
|
999
993
|
/** @description The schema of the data returned when the query is executed. */
|
|
1000
|
-
schema: { [key: string]: unknown }
|
|
994
|
+
schema: { [key: string]: unknown };
|
|
1001
995
|
/** @description The JavaScript transformer function, applied after the query responds with data. */
|
|
1002
|
-
transformer?: string
|
|
996
|
+
transformer?: string;
|
|
1003
997
|
/** @description Whether the query has readable data. */
|
|
1004
|
-
readable?: boolean
|
|
1005
|
-
}[]
|
|
1006
|
-
}
|
|
998
|
+
readable?: boolean;
|
|
999
|
+
}[];
|
|
1000
|
+
};
|
|
1007
1001
|
user: {
|
|
1008
1002
|
/** @description The email address of the user, this must be unique. */
|
|
1009
|
-
email: string
|
|
1003
|
+
email: string;
|
|
1010
1004
|
/** @description The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure. */
|
|
1011
|
-
password?: string
|
|
1005
|
+
password?: string;
|
|
1012
1006
|
/**
|
|
1013
1007
|
* @description The status of the user, if they are active.
|
|
1014
1008
|
* @enum {string}
|
|
1015
1009
|
*/
|
|
1016
|
-
status?: "active"
|
|
1010
|
+
status?: "active";
|
|
1017
1011
|
/** @description The first name of the user */
|
|
1018
|
-
firstName?: string
|
|
1012
|
+
firstName?: string;
|
|
1019
1013
|
/** @description The last name of the user */
|
|
1020
|
-
lastName?: string
|
|
1014
|
+
lastName?: string;
|
|
1021
1015
|
/** @description If set to true forces the user to reset their password on first login. */
|
|
1022
|
-
forceResetPassword?: boolean
|
|
1016
|
+
forceResetPassword?: boolean;
|
|
1023
1017
|
/** @description Describes if the user is a builder user or not. */
|
|
1024
1018
|
builder?: {
|
|
1025
1019
|
/** @description If set to true the user will be able to build any app in the system. */
|
|
1026
|
-
global?: boolean
|
|
1027
|
-
}
|
|
1020
|
+
global?: boolean;
|
|
1021
|
+
};
|
|
1028
1022
|
/** @description Describes if the user is an admin user or not. */
|
|
1029
1023
|
admin?: {
|
|
1030
1024
|
/** @description If set to true the user will be able to administrate the system. */
|
|
1031
|
-
global?: boolean
|
|
1032
|
-
}
|
|
1025
|
+
global?: boolean;
|
|
1026
|
+
};
|
|
1033
1027
|
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
|
|
1034
|
-
roles: { [key: string]: string }
|
|
1035
|
-
}
|
|
1028
|
+
roles: { [key: string]: string };
|
|
1029
|
+
};
|
|
1036
1030
|
userOutput: {
|
|
1037
1031
|
data: {
|
|
1038
1032
|
/** @description The email address of the user, this must be unique. */
|
|
1039
|
-
email: string
|
|
1033
|
+
email: string;
|
|
1040
1034
|
/** @description The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure. */
|
|
1041
|
-
password?: string
|
|
1035
|
+
password?: string;
|
|
1042
1036
|
/**
|
|
1043
1037
|
* @description The status of the user, if they are active.
|
|
1044
1038
|
* @enum {string}
|
|
1045
1039
|
*/
|
|
1046
|
-
status?: "active"
|
|
1040
|
+
status?: "active";
|
|
1047
1041
|
/** @description The first name of the user */
|
|
1048
|
-
firstName?: string
|
|
1042
|
+
firstName?: string;
|
|
1049
1043
|
/** @description The last name of the user */
|
|
1050
|
-
lastName?: string
|
|
1044
|
+
lastName?: string;
|
|
1051
1045
|
/** @description If set to true forces the user to reset their password on first login. */
|
|
1052
|
-
forceResetPassword?: boolean
|
|
1046
|
+
forceResetPassword?: boolean;
|
|
1053
1047
|
/** @description Describes if the user is a builder user or not. */
|
|
1054
1048
|
builder?: {
|
|
1055
1049
|
/** @description If set to true the user will be able to build any app in the system. */
|
|
1056
|
-
global?: boolean
|
|
1057
|
-
}
|
|
1050
|
+
global?: boolean;
|
|
1051
|
+
};
|
|
1058
1052
|
/** @description Describes if the user is an admin user or not. */
|
|
1059
1053
|
admin?: {
|
|
1060
1054
|
/** @description If set to true the user will be able to administrate the system. */
|
|
1061
|
-
global?: boolean
|
|
1062
|
-
}
|
|
1055
|
+
global?: boolean;
|
|
1056
|
+
};
|
|
1063
1057
|
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
|
|
1064
|
-
roles: { [key: string]: string }
|
|
1058
|
+
roles: { [key: string]: string };
|
|
1065
1059
|
/** @description The ID of the user. */
|
|
1066
|
-
_id: string
|
|
1067
|
-
}
|
|
1068
|
-
}
|
|
1060
|
+
_id: string;
|
|
1061
|
+
};
|
|
1062
|
+
};
|
|
1069
1063
|
userSearch: {
|
|
1070
1064
|
data: {
|
|
1071
1065
|
/** @description The email address of the user, this must be unique. */
|
|
1072
|
-
email: string
|
|
1066
|
+
email: string;
|
|
1073
1067
|
/** @description The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure. */
|
|
1074
|
-
password?: string
|
|
1068
|
+
password?: string;
|
|
1075
1069
|
/**
|
|
1076
1070
|
* @description The status of the user, if they are active.
|
|
1077
1071
|
* @enum {string}
|
|
1078
1072
|
*/
|
|
1079
|
-
status?: "active"
|
|
1073
|
+
status?: "active";
|
|
1080
1074
|
/** @description The first name of the user */
|
|
1081
|
-
firstName?: string
|
|
1075
|
+
firstName?: string;
|
|
1082
1076
|
/** @description The last name of the user */
|
|
1083
|
-
lastName?: string
|
|
1077
|
+
lastName?: string;
|
|
1084
1078
|
/** @description If set to true forces the user to reset their password on first login. */
|
|
1085
|
-
forceResetPassword?: boolean
|
|
1079
|
+
forceResetPassword?: boolean;
|
|
1086
1080
|
/** @description Describes if the user is a builder user or not. */
|
|
1087
1081
|
builder?: {
|
|
1088
1082
|
/** @description If set to true the user will be able to build any app in the system. */
|
|
1089
|
-
global?: boolean
|
|
1090
|
-
}
|
|
1083
|
+
global?: boolean;
|
|
1084
|
+
};
|
|
1091
1085
|
/** @description Describes if the user is an admin user or not. */
|
|
1092
1086
|
admin?: {
|
|
1093
1087
|
/** @description If set to true the user will be able to administrate the system. */
|
|
1094
|
-
global?: boolean
|
|
1095
|
-
}
|
|
1088
|
+
global?: boolean;
|
|
1089
|
+
};
|
|
1096
1090
|
/** @description Contains the roles of the user per app (assuming they are not a builder user). */
|
|
1097
|
-
roles: { [key: string]: string }
|
|
1091
|
+
roles: { [key: string]: string };
|
|
1098
1092
|
/** @description The ID of the user. */
|
|
1099
|
-
_id: string
|
|
1100
|
-
}[]
|
|
1101
|
-
}
|
|
1093
|
+
_id: string;
|
|
1094
|
+
}[];
|
|
1095
|
+
};
|
|
1102
1096
|
nameSearch: {
|
|
1103
1097
|
/** @description The name to be used when searching - this will be used in a case insensitive starts with match. */
|
|
1104
|
-
name: string
|
|
1105
|
-
}
|
|
1106
|
-
}
|
|
1098
|
+
name: string;
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1107
1101
|
parameters: {
|
|
1108
1102
|
/** @description The ID of the table which this request is targeting. */
|
|
1109
|
-
tableId: string
|
|
1103
|
+
tableId: string;
|
|
1110
1104
|
/** @description The ID of the row which this request is targeting. */
|
|
1111
|
-
rowId: string
|
|
1105
|
+
rowId: string;
|
|
1112
1106
|
/** @description The ID of the app which this request is targeting. */
|
|
1113
|
-
appId: string
|
|
1107
|
+
appId: string;
|
|
1114
1108
|
/** @description The ID of the app which this request is targeting. */
|
|
1115
|
-
appIdUrl: string
|
|
1109
|
+
appIdUrl: string;
|
|
1116
1110
|
/** @description The ID of the query which this request is targeting. */
|
|
1117
|
-
queryId: string
|
|
1111
|
+
queryId: string;
|
|
1118
1112
|
/** @description The ID of the user which this request is targeting. */
|
|
1119
|
-
userId: string
|
|
1120
|
-
}
|
|
1113
|
+
userId: string;
|
|
1114
|
+
};
|
|
1121
1115
|
}
|
|
1122
1116
|
|
|
1123
1117
|
export interface operations {}
|