@keboola/api-client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +456 -0
- package/dist/ai/index.cjs +203 -0
- package/dist/ai/index.cjs.map +1 -0
- package/dist/ai/index.d.cts +35 -0
- package/dist/ai/index.d.ts +35 -0
- package/dist/ai/index.js +197 -0
- package/dist/ai/index.js.map +1 -0
- package/dist/ai/types.cjs +4 -0
- package/dist/ai/types.cjs.map +1 -0
- package/dist/ai/types.d.cts +2 -0
- package/dist/ai/types.d.ts +2 -0
- package/dist/ai/types.js +3 -0
- package/dist/ai/types.js.map +1 -0
- package/dist/assets/index.cjs +182 -0
- package/dist/assets/index.cjs.map +1 -0
- package/dist/assets/index.d.cts +9 -0
- package/dist/assets/index.d.ts +9 -0
- package/dist/assets/index.js +176 -0
- package/dist/assets/index.js.map +1 -0
- package/dist/assets/types.cjs +4 -0
- package/dist/assets/types.cjs.map +1 -0
- package/dist/assets/types.d.cts +8 -0
- package/dist/assets/types.d.ts +8 -0
- package/dist/assets/types.js +3 -0
- package/dist/assets/types.js.map +1 -0
- package/dist/authMiddleware-BTFSCMTE.d.ts +11 -0
- package/dist/authMiddleware-BteBe1Bt.d.cts +11 -0
- package/dist/chat/index.cjs +428 -0
- package/dist/chat/index.cjs.map +1 -0
- package/dist/chat/index.d.cts +51 -0
- package/dist/chat/index.d.ts +51 -0
- package/dist/chat/index.js +422 -0
- package/dist/chat/index.js.map +1 -0
- package/dist/chat/suggestions.cjs +158 -0
- package/dist/chat/suggestions.cjs.map +1 -0
- package/dist/chat/suggestions.d.cts +437 -0
- package/dist/chat/suggestions.d.ts +437 -0
- package/dist/chat/suggestions.js +140 -0
- package/dist/chat/suggestions.js.map +1 -0
- package/dist/chat/types.cjs +10 -0
- package/dist/chat/types.cjs.map +1 -0
- package/dist/chat/types.d.cts +3 -0
- package/dist/chat/types.d.ts +3 -0
- package/dist/chat/types.js +8 -0
- package/dist/chat/types.js.map +1 -0
- package/dist/createGenericFetchClient-CLUzu-jY.d.cts +18 -0
- package/dist/createGenericFetchClient-DEakI3F1.d.ts +18 -0
- package/dist/createOpenapiFetchClient-CpXmAIFB.d.cts +24 -0
- package/dist/createOpenapiFetchClient-_sm4bchL.d.ts +24 -0
- package/dist/dataScience/index.cjs +416 -0
- package/dist/dataScience/index.cjs.map +1 -0
- package/dist/dataScience/index.d.cts +191 -0
- package/dist/dataScience/index.d.ts +191 -0
- package/dist/dataScience/index.js +388 -0
- package/dist/dataScience/index.js.map +1 -0
- package/dist/dataScience/types.cjs +4 -0
- package/dist/dataScience/types.cjs.map +1 -0
- package/dist/dataScience/types.d.cts +2 -0
- package/dist/dataScience/types.d.ts +2 -0
- package/dist/dataScience/types.js +3 -0
- package/dist/dataScience/types.js.map +1 -0
- package/dist/editor/index.cjs +275 -0
- package/dist/editor/index.cjs.map +1 -0
- package/dist/editor/index.d.cts +172 -0
- package/dist/editor/index.d.ts +172 -0
- package/dist/editor/index.js +269 -0
- package/dist/editor/index.js.map +1 -0
- package/dist/editor/types.cjs +4 -0
- package/dist/editor/types.cjs.map +1 -0
- package/dist/editor/types.d.cts +2 -0
- package/dist/editor/types.d.ts +2 -0
- package/dist/editor/types.js +3 -0
- package/dist/editor/types.js.map +1 -0
- package/dist/encryption/index.cjs +192 -0
- package/dist/encryption/index.cjs.map +1 -0
- package/dist/encryption/index.d.cts +14 -0
- package/dist/encryption/index.d.ts +14 -0
- package/dist/encryption/index.js +186 -0
- package/dist/encryption/index.js.map +1 -0
- package/dist/encryption/types.cjs +4 -0
- package/dist/encryption/types.cjs.map +1 -0
- package/dist/encryption/types.d.cts +8 -0
- package/dist/encryption/types.d.ts +8 -0
- package/dist/encryption/types.js +3 -0
- package/dist/encryption/types.js.map +1 -0
- package/dist/import/index.cjs +198 -0
- package/dist/import/index.cjs.map +1 -0
- package/dist/import/index.d.cts +9 -0
- package/dist/import/index.d.ts +9 -0
- package/dist/import/index.js +192 -0
- package/dist/import/index.js.map +1 -0
- package/dist/index.cjs +3910 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3108 -0
- package/dist/index.d.ts +3108 -0
- package/dist/index.js +3858 -0
- package/dist/index.js.map +1 -0
- package/dist/keboolaUID-D1DGSbge.d.cts +19 -0
- package/dist/keboolaUID-D1DGSbge.d.ts +19 -0
- package/dist/management/index.cjs +872 -0
- package/dist/management/index.cjs.map +1 -0
- package/dist/management/index.d.cts +440 -0
- package/dist/management/index.d.ts +440 -0
- package/dist/management/index.js +865 -0
- package/dist/management/index.js.map +1 -0
- package/dist/management/types.cjs +4 -0
- package/dist/management/types.cjs.map +1 -0
- package/dist/management/types.d.cts +9 -0
- package/dist/management/types.d.ts +9 -0
- package/dist/management/types.js +3 -0
- package/dist/management/types.js.map +1 -0
- package/dist/metastore/index.cjs +339 -0
- package/dist/metastore/index.cjs.map +1 -0
- package/dist/metastore/index.d.cts +52 -0
- package/dist/metastore/index.d.ts +52 -0
- package/dist/metastore/index.js +333 -0
- package/dist/metastore/index.js.map +1 -0
- package/dist/metastore/types.cjs +4 -0
- package/dist/metastore/types.cjs.map +1 -0
- package/dist/metastore/types.d.cts +2 -0
- package/dist/metastore/types.d.ts +2 -0
- package/dist/metastore/types.js +3 -0
- package/dist/metastore/types.js.map +1 -0
- package/dist/queryService/index.cjs +250 -0
- package/dist/queryService/index.cjs.map +1 -0
- package/dist/queryService/index.d.cts +39 -0
- package/dist/queryService/index.d.ts +39 -0
- package/dist/queryService/index.js +244 -0
- package/dist/queryService/index.js.map +1 -0
- package/dist/queryService/types.cjs +4 -0
- package/dist/queryService/types.cjs.map +1 -0
- package/dist/queryService/types.d.cts +2 -0
- package/dist/queryService/types.d.ts +2 -0
- package/dist/queryService/types.js +3 -0
- package/dist/queryService/types.js.map +1 -0
- package/dist/queue/index.cjs +192 -0
- package/dist/queue/index.cjs.map +1 -0
- package/dist/queue/index.d.cts +133 -0
- package/dist/queue/index.d.ts +133 -0
- package/dist/queue/index.js +186 -0
- package/dist/queue/index.js.map +1 -0
- package/dist/queue/types.cjs +4 -0
- package/dist/queue/types.cjs.map +1 -0
- package/dist/queue/types.d.cts +2 -0
- package/dist/queue/types.d.ts +2 -0
- package/dist/queue/types.js +3 -0
- package/dist/queue/types.js.map +1 -0
- package/dist/sdk/storage/index.cjs +96 -0
- package/dist/sdk/storage/index.cjs.map +1 -0
- package/dist/sdk/storage/index.d.cts +24 -0
- package/dist/sdk/storage/index.d.ts +24 -0
- package/dist/sdk/storage/index.js +94 -0
- package/dist/sdk/storage/index.js.map +1 -0
- package/dist/sdk/tag/index.cjs +210 -0
- package/dist/sdk/tag/index.cjs.map +1 -0
- package/dist/sdk/tag/index.d.cts +25 -0
- package/dist/sdk/tag/index.d.ts +25 -0
- package/dist/sdk/tag/index.js +208 -0
- package/dist/sdk/tag/index.js.map +1 -0
- package/dist/sdk/tag/types.cjs +4 -0
- package/dist/sdk/tag/types.cjs.map +1 -0
- package/dist/sdk/tag/types.d.cts +30 -0
- package/dist/sdk/tag/types.d.ts +30 -0
- package/dist/sdk/tag/types.js +3 -0
- package/dist/sdk/tag/types.js.map +1 -0
- package/dist/status/index.cjs +178 -0
- package/dist/status/index.cjs.map +1 -0
- package/dist/status/index.d.cts +10 -0
- package/dist/status/index.d.ts +10 -0
- package/dist/status/index.js +172 -0
- package/dist/status/index.js.map +1 -0
- package/dist/status/types.cjs +4 -0
- package/dist/status/types.cjs.map +1 -0
- package/dist/status/types.d.cts +19 -0
- package/dist/status/types.d.ts +19 -0
- package/dist/status/types.js +3 -0
- package/dist/status/types.js.map +1 -0
- package/dist/storage/index.cjs +1021 -0
- package/dist/storage/index.cjs.map +1 -0
- package/dist/storage/index.d.cts +12 -0
- package/dist/storage/index.d.ts +12 -0
- package/dist/storage/index.js +1014 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/types.cjs +4 -0
- package/dist/storage/types.cjs.map +1 -0
- package/dist/storage/types.d.cts +10976 -0
- package/dist/storage/types.d.ts +10976 -0
- package/dist/storage/types.js +3 -0
- package/dist/storage/types.js.map +1 -0
- package/dist/storageClient-DPLh_p0V.d.cts +608 -0
- package/dist/storageClient-YVWer22Y.d.ts +608 -0
- package/dist/syncActions/index.cjs +366 -0
- package/dist/syncActions/index.cjs.map +1 -0
- package/dist/syncActions/index.d.cts +94 -0
- package/dist/syncActions/index.d.ts +94 -0
- package/dist/syncActions/index.js +341 -0
- package/dist/syncActions/index.js.map +1 -0
- package/dist/syncActions/types.cjs +4 -0
- package/dist/syncActions/types.cjs.map +1 -0
- package/dist/syncActions/types.d.cts +261 -0
- package/dist/syncActions/types.d.ts +261 -0
- package/dist/syncActions/types.js +3 -0
- package/dist/syncActions/types.js.map +1 -0
- package/dist/telemetry/index.cjs +189 -0
- package/dist/telemetry/index.cjs.map +1 -0
- package/dist/telemetry/index.d.cts +13 -0
- package/dist/telemetry/index.d.ts +13 -0
- package/dist/telemetry/index.js +183 -0
- package/dist/telemetry/index.js.map +1 -0
- package/dist/telemetry/types.cjs +4 -0
- package/dist/telemetry/types.cjs.map +1 -0
- package/dist/telemetry/types.d.cts +12 -0
- package/dist/telemetry/types.d.ts +12 -0
- package/dist/telemetry/types.js +3 -0
- package/dist/telemetry/types.js.map +1 -0
- package/dist/types-B51cQMrX.d.ts +1408 -0
- package/dist/types-B7k8S4ki.d.ts +1520 -0
- package/dist/types-BNQK_jR_.d.cts +1520 -0
- package/dist/types-BY0tjg2Q.d.ts +1079 -0
- package/dist/types-BeShtGlc.d.cts +8591 -0
- package/dist/types-BeShtGlc.d.ts +8591 -0
- package/dist/types-BjrNNn5I.d.ts +1643 -0
- package/dist/types-C-bd4ArM.d.cts +1079 -0
- package/dist/types-C7mpAfq-.d.cts +64 -0
- package/dist/types-C7mpAfq-.d.ts +64 -0
- package/dist/types-CGMJT3JL.d.ts +943 -0
- package/dist/types-CRSKcua9.d.cts +1314 -0
- package/dist/types-DJ6nbNq5.d.cts +1643 -0
- package/dist/types-DJkU9gvB.d.cts +943 -0
- package/dist/types-DYMMsuU0.d.cts +78 -0
- package/dist/types-DYMMsuU0.d.ts +78 -0
- package/dist/types-Dg1tEsVR.d.cts +17 -0
- package/dist/types-Dg1tEsVR.d.ts +17 -0
- package/dist/types-DgaMV8FF.d.cts +60 -0
- package/dist/types-DgaMV8FF.d.ts +60 -0
- package/dist/types-Dws8mFNY.d.cts +1408 -0
- package/dist/types-cH0_hkCW.d.ts +1314 -0
- package/dist/utils-BNQZiNOu.d.ts +1657 -0
- package/dist/utils-DE09pDTi.d.cts +1657 -0
- package/dist/vault/index.cjs +225 -0
- package/dist/vault/index.cjs.map +1 -0
- package/dist/vault/index.d.cts +26 -0
- package/dist/vault/index.d.ts +26 -0
- package/dist/vault/index.js +219 -0
- package/dist/vault/index.js.map +1 -0
- package/dist/vault/types.cjs +4 -0
- package/dist/vault/types.cjs.map +1 -0
- package/dist/vault/types.d.cts +390 -0
- package/dist/vault/types.d.ts +390 -0
- package/dist/vault/types.js +3 -0
- package/dist/vault/types.js.map +1 -0
- package/dist/verify/index.cjs +190 -0
- package/dist/verify/index.cjs.map +1 -0
- package/dist/verify/index.d.cts +9 -0
- package/dist/verify/index.d.ts +9 -0
- package/dist/verify/index.js +184 -0
- package/dist/verify/index.js.map +1 -0
- package/dist/verify/types.cjs +4 -0
- package/dist/verify/types.cjs.map +1 -0
- package/dist/verify/types.d.cts +29 -0
- package/dist/verify/types.d.ts +29 -0
- package/dist/verify/types.js +3 -0
- package/dist/verify/types.js.map +1 -0
- package/package.json +570 -0
|
@@ -0,0 +1,1520 @@
|
|
|
1
|
+
import { b as OpenapiBodyType, d as OpenapiPathType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-C7mpAfq-.cjs';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* This file was auto-generated by openapi-typescript.
|
|
5
|
+
* Do not make direct changes to the file.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
type paths = {
|
|
9
|
+
'/': {
|
|
10
|
+
parameters: {
|
|
11
|
+
query?: never;
|
|
12
|
+
header?: never;
|
|
13
|
+
path?: never;
|
|
14
|
+
cookie?: never;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Index endpoint
|
|
18
|
+
* @description Returns basic information about the service.
|
|
19
|
+
*/
|
|
20
|
+
get: operations['index'];
|
|
21
|
+
put?: never;
|
|
22
|
+
post?: never;
|
|
23
|
+
delete?: never;
|
|
24
|
+
options?: never;
|
|
25
|
+
head?: never;
|
|
26
|
+
patch?: never;
|
|
27
|
+
trace?: never;
|
|
28
|
+
};
|
|
29
|
+
'/health-check': {
|
|
30
|
+
parameters: {
|
|
31
|
+
query?: never;
|
|
32
|
+
header?: never;
|
|
33
|
+
path?: never;
|
|
34
|
+
cookie?: never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Health-check endpoint
|
|
38
|
+
* @description Checks the service is up & running.
|
|
39
|
+
*/
|
|
40
|
+
get: operations['healthCheck'];
|
|
41
|
+
put?: never;
|
|
42
|
+
post?: never;
|
|
43
|
+
delete?: never;
|
|
44
|
+
options?: never;
|
|
45
|
+
head?: never;
|
|
46
|
+
patch?: never;
|
|
47
|
+
trace?: never;
|
|
48
|
+
};
|
|
49
|
+
'/sql/sessions': {
|
|
50
|
+
parameters: {
|
|
51
|
+
query?: never;
|
|
52
|
+
header?: never;
|
|
53
|
+
path?: never;
|
|
54
|
+
cookie?: never;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* List SQL Editor sessions
|
|
58
|
+
* @description Retrieves a list of SQL Editor sessions for the current project.
|
|
59
|
+
*/
|
|
60
|
+
get: operations['listSqlEditorSessions'];
|
|
61
|
+
put?: never;
|
|
62
|
+
/**
|
|
63
|
+
* Create a new SQL Editor session
|
|
64
|
+
* @description Creates a new SQL Editor session.
|
|
65
|
+
*/
|
|
66
|
+
post: operations['createSqlEditorSession'];
|
|
67
|
+
delete?: never;
|
|
68
|
+
options?: never;
|
|
69
|
+
head?: never;
|
|
70
|
+
patch?: never;
|
|
71
|
+
trace?: never;
|
|
72
|
+
};
|
|
73
|
+
'/sql/sessions/{id}': {
|
|
74
|
+
parameters: {
|
|
75
|
+
query?: never;
|
|
76
|
+
header?: never;
|
|
77
|
+
path?: never;
|
|
78
|
+
cookie?: never;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* Get a SQL Editor session by ID
|
|
82
|
+
* @description Retrieves a specific SQL Editor session by its ID.
|
|
83
|
+
*/
|
|
84
|
+
get: operations['getSqlEditorSession'];
|
|
85
|
+
put?: never;
|
|
86
|
+
post?: never;
|
|
87
|
+
/**
|
|
88
|
+
* Delete a SQL Editor session
|
|
89
|
+
* @description Deletes a specific SQL Editor session by its ID.
|
|
90
|
+
*/
|
|
91
|
+
delete: operations['deleteSqlEditorSession'];
|
|
92
|
+
options?: never;
|
|
93
|
+
head?: never;
|
|
94
|
+
patch?: never;
|
|
95
|
+
trace?: never;
|
|
96
|
+
};
|
|
97
|
+
'/sql/sessions/{id}/credentials': {
|
|
98
|
+
parameters: {
|
|
99
|
+
query?: never;
|
|
100
|
+
header?: never;
|
|
101
|
+
path?: never;
|
|
102
|
+
cookie?: never;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
* Get workspace credentials for a SQL Editor session
|
|
106
|
+
* @description Retrieves the decrypted workspace credentials for a SQL Editor session.
|
|
107
|
+
* This endpoint is only available for BigQuery workspaces. For Snowflake workspaces,
|
|
108
|
+
* a 400 Bad Request error will be returned.
|
|
109
|
+
*/
|
|
110
|
+
get: operations['getSqlEditorSessionCredentials'];
|
|
111
|
+
put?: never;
|
|
112
|
+
post?: never;
|
|
113
|
+
delete?: never;
|
|
114
|
+
options?: never;
|
|
115
|
+
head?: never;
|
|
116
|
+
patch?: never;
|
|
117
|
+
trace?: never;
|
|
118
|
+
};
|
|
119
|
+
'/sql/sessions/{id}/workspace-password': {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never;
|
|
122
|
+
header?: never;
|
|
123
|
+
path?: never;
|
|
124
|
+
cookie?: never;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Get workspace password for a SQL Editor session (deprecated)
|
|
128
|
+
* @description Retrieves the workspace username and password for a SQL Editor session from the sandboxes API.
|
|
129
|
+
* This endpoint is only available for Snowflake workspaces. For non-Snowflake workspaces,
|
|
130
|
+
* a 400 Bad Request error will be returned.
|
|
131
|
+
*
|
|
132
|
+
* **Important:** This operation is provided only for backward compatibility with legacy password-based workspaces
|
|
133
|
+
* until the support for password authentication is completely removed.
|
|
134
|
+
*/
|
|
135
|
+
get: operations['getSqlEditorSessionWorkspacePassword'];
|
|
136
|
+
put?: never;
|
|
137
|
+
post?: never;
|
|
138
|
+
delete?: never;
|
|
139
|
+
options?: never;
|
|
140
|
+
head?: never;
|
|
141
|
+
patch?: never;
|
|
142
|
+
trace?: never;
|
|
143
|
+
};
|
|
144
|
+
'/sql/sessions/{id}/load': {
|
|
145
|
+
parameters: {
|
|
146
|
+
query?: never;
|
|
147
|
+
header?: never;
|
|
148
|
+
path?: never;
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
get?: never;
|
|
152
|
+
put?: never;
|
|
153
|
+
/**
|
|
154
|
+
* Load data into SQL Editor session
|
|
155
|
+
* @description Loads data into a SQL Editor session workspace. Supports three modes:
|
|
156
|
+
* - **input**: Loads tables from the session's associated configuration into the workspace
|
|
157
|
+
* - **input-preserve**: Same as input, but preserves existing data in the workspace
|
|
158
|
+
* - **clean**: Clears the workspace and loads empty input
|
|
159
|
+
*/
|
|
160
|
+
post: operations['loadSqlEditorSession'];
|
|
161
|
+
delete?: never;
|
|
162
|
+
options?: never;
|
|
163
|
+
head?: never;
|
|
164
|
+
patch?: never;
|
|
165
|
+
trace?: never;
|
|
166
|
+
};
|
|
167
|
+
'/sql/sessions/{id}/unload': {
|
|
168
|
+
parameters: {
|
|
169
|
+
query?: never;
|
|
170
|
+
header?: never;
|
|
171
|
+
path?: never;
|
|
172
|
+
cookie?: never;
|
|
173
|
+
};
|
|
174
|
+
get?: never;
|
|
175
|
+
put?: never;
|
|
176
|
+
/**
|
|
177
|
+
* Unload data from SQL Editor session workspace
|
|
178
|
+
* @description Unloads data from a SQL Editor session workspace to storage tables based on the output mapping configuration of the session's associated component configuration.
|
|
179
|
+
* Optionally specify a tableId to unload only that specific table.
|
|
180
|
+
*/
|
|
181
|
+
post: operations['unloadSqlEditorSession'];
|
|
182
|
+
delete?: never;
|
|
183
|
+
options?: never;
|
|
184
|
+
head?: never;
|
|
185
|
+
patch?: never;
|
|
186
|
+
trace?: never;
|
|
187
|
+
};
|
|
188
|
+
'/sql/sessions/{id}/reset-credentials': {
|
|
189
|
+
parameters: {
|
|
190
|
+
query?: never;
|
|
191
|
+
header?: never;
|
|
192
|
+
path?: never;
|
|
193
|
+
cookie?: never;
|
|
194
|
+
};
|
|
195
|
+
get?: never;
|
|
196
|
+
put?: never;
|
|
197
|
+
/**
|
|
198
|
+
* Reset workspace credentials
|
|
199
|
+
* @description Resets the credentials for a workspace session. For Snowflake workspaces, generates a new RSA keypair
|
|
200
|
+
* and updates the public key in the workspace. Returns both the private and public keys.
|
|
201
|
+
* The private key is generated in-memory only and is never stored.
|
|
202
|
+
*
|
|
203
|
+
* **Important:** This operation is only supported for Snowflake backend sessions in 'ready' or 'loading' status.
|
|
204
|
+
*
|
|
205
|
+
* **Security Note:** The private key returned in the response must be securely stored by the client.
|
|
206
|
+
* It will not be available again after this request completes.
|
|
207
|
+
*/
|
|
208
|
+
post: operations['resetSqlEditorSessionCredentials'];
|
|
209
|
+
delete?: never;
|
|
210
|
+
options?: never;
|
|
211
|
+
head?: never;
|
|
212
|
+
patch?: never;
|
|
213
|
+
trace?: never;
|
|
214
|
+
};
|
|
215
|
+
'/sql/sessions/{id}/reset-password': {
|
|
216
|
+
parameters: {
|
|
217
|
+
query?: never;
|
|
218
|
+
header?: never;
|
|
219
|
+
path?: never;
|
|
220
|
+
cookie?: never;
|
|
221
|
+
};
|
|
222
|
+
get?: never;
|
|
223
|
+
put?: never;
|
|
224
|
+
/**
|
|
225
|
+
* Reset workspace password (deprecated)
|
|
226
|
+
* @description Resets the password for a workspace session. For Snowflake workspaces, generates a new password
|
|
227
|
+
* via the Storage API and returns the username and password.
|
|
228
|
+
*
|
|
229
|
+
* **Important:** This operation is only supported for Snowflake backend sessions in 'ready' or 'loading' status.
|
|
230
|
+
* **Important:** This operation is provided only for backward compatibility with legacy password-based workspaces
|
|
231
|
+
* until the support for password authentication is completely removed.
|
|
232
|
+
*/
|
|
233
|
+
post: operations['resetSqlEditorSessionPassword'];
|
|
234
|
+
delete?: never;
|
|
235
|
+
options?: never;
|
|
236
|
+
head?: never;
|
|
237
|
+
patch?: never;
|
|
238
|
+
trace?: never;
|
|
239
|
+
};
|
|
240
|
+
'/sql/sessions/{id}/acknowledge-last-error': {
|
|
241
|
+
parameters: {
|
|
242
|
+
query?: never;
|
|
243
|
+
header?: never;
|
|
244
|
+
path?: never;
|
|
245
|
+
cookie?: never;
|
|
246
|
+
};
|
|
247
|
+
get?: never;
|
|
248
|
+
put?: never;
|
|
249
|
+
/**
|
|
250
|
+
* Acknowledge session error
|
|
251
|
+
* @description Acknowledges and clears the last error from a SQL Editor session. This operation sets the lastError field to null,
|
|
252
|
+
* effectively clearing any error state from the session.
|
|
253
|
+
*
|
|
254
|
+
* **Note:** This operation can only be performed on sessions that have a lastError set. If the session has no error,
|
|
255
|
+
* a 400 Bad Request response will be returned.
|
|
256
|
+
*/
|
|
257
|
+
post: operations['acknowledgeSessionError'];
|
|
258
|
+
delete?: never;
|
|
259
|
+
options?: never;
|
|
260
|
+
head?: never;
|
|
261
|
+
patch?: never;
|
|
262
|
+
trace?: never;
|
|
263
|
+
};
|
|
264
|
+
'/sql/sessions/{id}/schema': {
|
|
265
|
+
parameters: {
|
|
266
|
+
query?: never;
|
|
267
|
+
header?: never;
|
|
268
|
+
path?: never;
|
|
269
|
+
cookie?: never;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Get SQL Editor session schema
|
|
273
|
+
* @description Retrieves the database schema for a specific SQL Editor session.
|
|
274
|
+
*/
|
|
275
|
+
get: operations['getSqlEditorSessionSchema'];
|
|
276
|
+
put?: never;
|
|
277
|
+
post?: never;
|
|
278
|
+
delete?: never;
|
|
279
|
+
options?: never;
|
|
280
|
+
head?: never;
|
|
281
|
+
patch?: never;
|
|
282
|
+
trace?: never;
|
|
283
|
+
};
|
|
284
|
+
'/sql/get-output-tables': {
|
|
285
|
+
parameters: {
|
|
286
|
+
query?: never;
|
|
287
|
+
header?: never;
|
|
288
|
+
path?: never;
|
|
289
|
+
cookie?: never;
|
|
290
|
+
};
|
|
291
|
+
get?: never;
|
|
292
|
+
put?: never;
|
|
293
|
+
/**
|
|
294
|
+
* Retrieve output tables from SQL queries
|
|
295
|
+
* @description Analyzes given SQL queries and returns the names of all tables created by those queries.
|
|
296
|
+
*/
|
|
297
|
+
post: operations['getSqlEditorOutputTables'];
|
|
298
|
+
delete?: never;
|
|
299
|
+
options?: never;
|
|
300
|
+
head?: never;
|
|
301
|
+
patch?: never;
|
|
302
|
+
trace?: never;
|
|
303
|
+
};
|
|
304
|
+
'/sql/sessions/{id}/run-query': {
|
|
305
|
+
parameters: {
|
|
306
|
+
query?: never;
|
|
307
|
+
header?: never;
|
|
308
|
+
path?: never;
|
|
309
|
+
cookie?: never;
|
|
310
|
+
};
|
|
311
|
+
get?: never;
|
|
312
|
+
put?: never;
|
|
313
|
+
/**
|
|
314
|
+
* Run SQL queries in SQL Editor session
|
|
315
|
+
* @description Executes SQL queries in a specific SQL Editor session and returns the results.
|
|
316
|
+
*/
|
|
317
|
+
post: operations['runSqlEditorQuery'];
|
|
318
|
+
delete?: never;
|
|
319
|
+
options?: never;
|
|
320
|
+
head?: never;
|
|
321
|
+
patch?: never;
|
|
322
|
+
trace?: never;
|
|
323
|
+
};
|
|
324
|
+
'/sql/sessions/{id}/table-preview': {
|
|
325
|
+
parameters: {
|
|
326
|
+
query?: never;
|
|
327
|
+
header?: never;
|
|
328
|
+
path?: never;
|
|
329
|
+
cookie?: never;
|
|
330
|
+
};
|
|
331
|
+
get?: never;
|
|
332
|
+
put?: never;
|
|
333
|
+
/**
|
|
334
|
+
* Get table preview in SQL Editor session
|
|
335
|
+
* @description Gets a preview of a table in a specific SQL Editor session by executing a SELECT query with LIMIT 100.
|
|
336
|
+
*/
|
|
337
|
+
post: operations['getTablePreview'];
|
|
338
|
+
delete?: never;
|
|
339
|
+
options?: never;
|
|
340
|
+
head?: never;
|
|
341
|
+
patch?: never;
|
|
342
|
+
trace?: never;
|
|
343
|
+
};
|
|
344
|
+
'/sql/sessions/{id}/table-ddl': {
|
|
345
|
+
parameters: {
|
|
346
|
+
query?: never;
|
|
347
|
+
header?: never;
|
|
348
|
+
path?: never;
|
|
349
|
+
cookie?: never;
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* Get table DDL (CREATE TABLE statement)
|
|
353
|
+
* @description Retrieves the DDL (Data Definition Language) statement for a specified table in a SQL Editor session.
|
|
354
|
+
* Executes Snowflake's GET_DDL function and returns the CREATE TABLE statement synchronously.
|
|
355
|
+
*/
|
|
356
|
+
get: operations['getTableDDL'];
|
|
357
|
+
put?: never;
|
|
358
|
+
post?: never;
|
|
359
|
+
delete?: never;
|
|
360
|
+
options?: never;
|
|
361
|
+
head?: never;
|
|
362
|
+
patch?: never;
|
|
363
|
+
trace?: never;
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
type components = {
|
|
367
|
+
schemas: {
|
|
368
|
+
Error: {
|
|
369
|
+
/** @example The value foobar is invalid */
|
|
370
|
+
error: string;
|
|
371
|
+
/** @example 400 */
|
|
372
|
+
code: number;
|
|
373
|
+
/** @enum {string} */
|
|
374
|
+
status: 'error';
|
|
375
|
+
/** @example job-runner-1234567890 */
|
|
376
|
+
exceptionId?: string;
|
|
377
|
+
};
|
|
378
|
+
CreateSqlEditorSessionRequest: {
|
|
379
|
+
/** @description The ID of the branch to create the session in */
|
|
380
|
+
branchId: string;
|
|
381
|
+
/** @description The ID of the component (e.g. keboola.snowflake-transformation) */
|
|
382
|
+
componentId: string | null;
|
|
383
|
+
/** @description The ID of the configuration */
|
|
384
|
+
configurationId: string | null;
|
|
385
|
+
/**
|
|
386
|
+
* @description Specifies the loading mode for the session:
|
|
387
|
+
* * `clean` - Creates a clean session (default)
|
|
388
|
+
* * `input` - Loads with input data (not yet implemented)
|
|
389
|
+
* @default clean
|
|
390
|
+
* @enum {string}
|
|
391
|
+
*/
|
|
392
|
+
loadMode: 'input' | 'clean';
|
|
393
|
+
/**
|
|
394
|
+
* @description Specifies the authentication method for the workspace:
|
|
395
|
+
* * `keyPair` - Key-based authentication (default, recommended)
|
|
396
|
+
* * `usernamePassword` - Username/password authentication (only supported for BYODB workspaces)
|
|
397
|
+
*
|
|
398
|
+
* **Warning:** Do not use this parameter unless absolutely necessary. It is provided only for backward compatibility with legacy password-based workspaces until support for password authentication is completely removed.
|
|
399
|
+
*
|
|
400
|
+
* **Important:** The `usernamePassword` option is only supported for BYODB (Bring Your Own Database) workspaces. If specified for non-BYODB workspaces, it will be ignored and `keyPair` will be used instead with a warning logged.
|
|
401
|
+
* @default keyPair
|
|
402
|
+
* @enum {string}
|
|
403
|
+
*/
|
|
404
|
+
loginType: 'usernamePassword' | 'keyPair';
|
|
405
|
+
};
|
|
406
|
+
SqlEditorSession: {
|
|
407
|
+
/**
|
|
408
|
+
* Format: uuid
|
|
409
|
+
* @description Unique identifier of the SQL Editor session
|
|
410
|
+
*/
|
|
411
|
+
id: string;
|
|
412
|
+
/**
|
|
413
|
+
* Format: date-time
|
|
414
|
+
* @description When the session was created
|
|
415
|
+
*/
|
|
416
|
+
createdAt: string;
|
|
417
|
+
/**
|
|
418
|
+
* Format: date-time
|
|
419
|
+
* @description When the session was last updated
|
|
420
|
+
*/
|
|
421
|
+
updatedAt: string;
|
|
422
|
+
/**
|
|
423
|
+
* @description Current status of the session
|
|
424
|
+
* @example initializing
|
|
425
|
+
*/
|
|
426
|
+
status: string;
|
|
427
|
+
/** @description ID of the user who created the session */
|
|
428
|
+
userId: string;
|
|
429
|
+
/** @description The ID of the branch this session belongs to */
|
|
430
|
+
branchId: string;
|
|
431
|
+
/** @description The ID of the component (e.g. keboola.snowflake-transformation) */
|
|
432
|
+
componentId: string;
|
|
433
|
+
/** @description The ID of the configuration */
|
|
434
|
+
configurationId: string;
|
|
435
|
+
/** @description Schema name in the workspace */
|
|
436
|
+
workspaceSchema: string;
|
|
437
|
+
/** @description Database name in the workspace */
|
|
438
|
+
workspaceDatabase: string;
|
|
439
|
+
/** @description ID of the associated workspace */
|
|
440
|
+
workspaceId: string;
|
|
441
|
+
/** @description ID of the job that is creating the workspace */
|
|
442
|
+
workspaceCreateJobId: string | null;
|
|
443
|
+
/** @description Array of workspace jobs associated with this session */
|
|
444
|
+
workspaceLoadJobs: {
|
|
445
|
+
/** @description Job ID */
|
|
446
|
+
id: string;
|
|
447
|
+
/** @description Job type (create, load, unload, delete) */
|
|
448
|
+
type: string;
|
|
449
|
+
}[];
|
|
450
|
+
/** @description Private key to the underlying snowflake workspace, present only when includeCredentials parameter is supplied. */
|
|
451
|
+
snowflakePrivateKey?: string;
|
|
452
|
+
/** @description Indicates whether the session has read-only access to the storage workspace */
|
|
453
|
+
readOnlyStorageAccess?: boolean;
|
|
454
|
+
/**
|
|
455
|
+
* @description Type of the backend database (snowflake or bigquery)
|
|
456
|
+
* @enum {string|null}
|
|
457
|
+
*/
|
|
458
|
+
backendType?: 'snowflake' | 'bigquery' | null;
|
|
459
|
+
/**
|
|
460
|
+
* @description Size of the backend (e.g., "small", "large", ...)
|
|
461
|
+
* @example small
|
|
462
|
+
*/
|
|
463
|
+
backendSize?: string | null;
|
|
464
|
+
/**
|
|
465
|
+
* @description Last error message that occurred in the session, if any
|
|
466
|
+
* @example Table 'myTable' not found in schema 'mySchema'
|
|
467
|
+
*/
|
|
468
|
+
lastError?: string | null;
|
|
469
|
+
/**
|
|
470
|
+
* @description Indicates whether the session is shared (from configuration runtime.shared or sandbox shared attribute)
|
|
471
|
+
* @example false
|
|
472
|
+
*/
|
|
473
|
+
shared: boolean;
|
|
474
|
+
/**
|
|
475
|
+
* @description The login type used for the workspace authentication.
|
|
476
|
+
* * `snowflake-person-sso` - Person SSO authentication
|
|
477
|
+
* * `snowflake-legacy-service` - Legacy service password authentication
|
|
478
|
+
* * `snowflake-person-keypair` - Person keypair authentication
|
|
479
|
+
* * `snowflake-service-keypair` - Service keypair authentication
|
|
480
|
+
* * `default` - Default authentication for BigQuery workspaces
|
|
481
|
+
*
|
|
482
|
+
* This field is null for existing sessions that were not re-used yet.
|
|
483
|
+
* @example snowflake-service-keypair
|
|
484
|
+
* @enum {string|null}
|
|
485
|
+
*/
|
|
486
|
+
workspaceLoginType?:
|
|
487
|
+
| 'snowflake-person-sso'
|
|
488
|
+
| 'snowflake-legacy-service'
|
|
489
|
+
| 'snowflake-person-keypair'
|
|
490
|
+
| 'snowflake-service-keypair'
|
|
491
|
+
| 'default'
|
|
492
|
+
| null;
|
|
493
|
+
/**
|
|
494
|
+
* Format: date-time
|
|
495
|
+
* @description Timestamp of when data was last loaded to the session. Null if data was never loaded to the session.
|
|
496
|
+
* @example 2026-03-05T12:00:00.000+00:00
|
|
497
|
+
*/
|
|
498
|
+
lastLoadedAt?: string | null;
|
|
499
|
+
};
|
|
500
|
+
LoadSessionRequest: {
|
|
501
|
+
/**
|
|
502
|
+
* @description The mode to load the session in. 'input' loads tables from the session's associated configuration, 'input-preserve' loads tables but preserves existing data, 'clean' clears the workspace
|
|
503
|
+
* @example input
|
|
504
|
+
* @enum {string}
|
|
505
|
+
*/
|
|
506
|
+
mode: 'input' | 'input-preserve' | 'clean';
|
|
507
|
+
/**
|
|
508
|
+
* @description Optional table name to load specifically. If not provided, all tables from the IM will be loaded.
|
|
509
|
+
* @example users
|
|
510
|
+
*/
|
|
511
|
+
tableId?: string | null;
|
|
512
|
+
};
|
|
513
|
+
UnloadSessionRequest: {
|
|
514
|
+
/**
|
|
515
|
+
* @description Optional tableId to unload specifically. If not provided, all tables from the OM will be unloaded.
|
|
516
|
+
* @example users
|
|
517
|
+
*/
|
|
518
|
+
tableId?: string | null;
|
|
519
|
+
};
|
|
520
|
+
ResetCredentialsResponse: {
|
|
521
|
+
/**
|
|
522
|
+
* @description PEM-encoded private key in PKCS#8 format. This key is generated in-memory and never stored. Store it securely.
|
|
523
|
+
* @example -----BEGIN PRIVATE KEY-----
|
|
524
|
+
* MIIEowIBAAKCAQEA...
|
|
525
|
+
* -----END PRIVATE KEY-----
|
|
526
|
+
*/
|
|
527
|
+
privateKey: string;
|
|
528
|
+
/**
|
|
529
|
+
* @description PEM-encoded RSA public key that has been set in the Snowflake workspace
|
|
530
|
+
* @example -----BEGIN PUBLIC KEY-----
|
|
531
|
+
* MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A...
|
|
532
|
+
* -----END PUBLIC KEY-----
|
|
533
|
+
*/
|
|
534
|
+
publicKey: string;
|
|
535
|
+
};
|
|
536
|
+
ResetPasswordResponse: {
|
|
537
|
+
/**
|
|
538
|
+
* @description Username for the Snowflake workspace
|
|
539
|
+
* @example KEBOOLA_WORKSPACE_123456
|
|
540
|
+
*/
|
|
541
|
+
username: string;
|
|
542
|
+
/**
|
|
543
|
+
* @description Password generated by the Storage API. This password is never stored. Store it securely.
|
|
544
|
+
* @example a1b2c3d4e5f6g7h8i9j0
|
|
545
|
+
*/
|
|
546
|
+
password: string;
|
|
547
|
+
/**
|
|
548
|
+
* @description Snowflake host/account identifier
|
|
549
|
+
* @example keboola.snowflakecomputing.com
|
|
550
|
+
*/
|
|
551
|
+
host: string;
|
|
552
|
+
/**
|
|
553
|
+
* @description Database name in Snowflake
|
|
554
|
+
* @example KEBOOLA_1234
|
|
555
|
+
*/
|
|
556
|
+
database: string;
|
|
557
|
+
/**
|
|
558
|
+
* @description Schema name in the workspace
|
|
559
|
+
* @example WORKSPACE_123456
|
|
560
|
+
*/
|
|
561
|
+
schema: string;
|
|
562
|
+
/**
|
|
563
|
+
* @description Snowflake warehouse name
|
|
564
|
+
* @example KEBOOLA_PROD
|
|
565
|
+
*/
|
|
566
|
+
warehouse: string;
|
|
567
|
+
};
|
|
568
|
+
WorkspacePasswordResponse: {
|
|
569
|
+
/**
|
|
570
|
+
* @description Username for the Snowflake workspace from sandboxes API
|
|
571
|
+
* @example KEBOOLA_WORKSPACE_123456
|
|
572
|
+
*/
|
|
573
|
+
username: string;
|
|
574
|
+
/**
|
|
575
|
+
* @description Password for the Snowflake workspace from sandboxes API
|
|
576
|
+
* @example a1b2c3d4e5f6g7h8i9j0
|
|
577
|
+
*/
|
|
578
|
+
password: string;
|
|
579
|
+
/**
|
|
580
|
+
* @description Snowflake host/account identifier
|
|
581
|
+
* @example keboola.snowflakecomputing.com
|
|
582
|
+
*/
|
|
583
|
+
host: string;
|
|
584
|
+
/**
|
|
585
|
+
* @description Database name in Snowflake
|
|
586
|
+
* @example KEBOOLA_1234
|
|
587
|
+
*/
|
|
588
|
+
database: string;
|
|
589
|
+
/**
|
|
590
|
+
* @description Schema name in the workspace
|
|
591
|
+
* @example WORKSPACE_123456
|
|
592
|
+
*/
|
|
593
|
+
schema: string;
|
|
594
|
+
/**
|
|
595
|
+
* @description Snowflake warehouse name
|
|
596
|
+
* @example KEBOOLA_PROD
|
|
597
|
+
*/
|
|
598
|
+
warehouse: string;
|
|
599
|
+
};
|
|
600
|
+
ReloadSessionRequest: {
|
|
601
|
+
/**
|
|
602
|
+
* @description The mode to reload the session in. 'input' reloads input tables, 'clean' cleans the workspace.
|
|
603
|
+
* @enum {string}
|
|
604
|
+
*/
|
|
605
|
+
mode: 'input' | 'clean';
|
|
606
|
+
};
|
|
607
|
+
RunQueryRequest: {
|
|
608
|
+
/**
|
|
609
|
+
* @description Array of SQL queries to execute
|
|
610
|
+
* @example [
|
|
611
|
+
* "SELECT 1",
|
|
612
|
+
* "SELECT * FROM information_schema.tables LIMIT 1"
|
|
613
|
+
* ]
|
|
614
|
+
*/
|
|
615
|
+
queries: string[];
|
|
616
|
+
};
|
|
617
|
+
RunQueryResponse: {
|
|
618
|
+
/**
|
|
619
|
+
* @description ID of the submitted query job
|
|
620
|
+
* @example 12345678-1234-1234-1234-1234567890ab
|
|
621
|
+
*/
|
|
622
|
+
queryJobId: string;
|
|
623
|
+
/**
|
|
624
|
+
* Format: uri
|
|
625
|
+
* @description URL to check the status of the query job
|
|
626
|
+
* @example https://query.keboola.com/api/v1/queries/12345678-1234-1234-1234-1234567890ab
|
|
627
|
+
*/
|
|
628
|
+
url: string;
|
|
629
|
+
};
|
|
630
|
+
TablePreviewRequest: {
|
|
631
|
+
/**
|
|
632
|
+
* @description Name of the table to preview
|
|
633
|
+
* @example users
|
|
634
|
+
*/
|
|
635
|
+
tableName: string;
|
|
636
|
+
/**
|
|
637
|
+
* @description Name of the database containing the table (optional)
|
|
638
|
+
* @example KEBOOLA_123
|
|
639
|
+
*/
|
|
640
|
+
databaseName?: string | null;
|
|
641
|
+
/**
|
|
642
|
+
* @description Name of the schema containing the table (optional)
|
|
643
|
+
* @example in.c-example-schema
|
|
644
|
+
*/
|
|
645
|
+
schemaName?: string | null;
|
|
646
|
+
};
|
|
647
|
+
TablePreviewResponse: {
|
|
648
|
+
/**
|
|
649
|
+
* @description ID of the submitted query job for table preview
|
|
650
|
+
* @example 12345678-1234-1234-1234-1234567890ab
|
|
651
|
+
*/
|
|
652
|
+
queryJobId: string;
|
|
653
|
+
/**
|
|
654
|
+
* Format: uri
|
|
655
|
+
* @description URL to check the status of the query job
|
|
656
|
+
* @example https://query.keboola.com/api/v1/queries/12345678-1234-1234-1234-1234567890ab
|
|
657
|
+
*/
|
|
658
|
+
url: string;
|
|
659
|
+
};
|
|
660
|
+
GetOutputTablesRequest: {
|
|
661
|
+
/** @description An array of SQL statements to analyze for table creation statements. */
|
|
662
|
+
queries: string[];
|
|
663
|
+
};
|
|
664
|
+
/**
|
|
665
|
+
* @example {
|
|
666
|
+
* "tables": [
|
|
667
|
+
* "TABLE1",
|
|
668
|
+
* "TABLE2"
|
|
669
|
+
* ]
|
|
670
|
+
* }
|
|
671
|
+
*/
|
|
672
|
+
GetOutputTablesResponse: {
|
|
673
|
+
/** @description List of output table names created by the queries */
|
|
674
|
+
tables: string[];
|
|
675
|
+
};
|
|
676
|
+
TableDDLResponse: {
|
|
677
|
+
/**
|
|
678
|
+
* @description The DDL (CREATE TABLE) statement for the specified table
|
|
679
|
+
* @example CREATE OR REPLACE TABLE "KEBOOLA_123"."public"."users" (id INT, name VARCHAR, email VARCHAR)
|
|
680
|
+
*/
|
|
681
|
+
ddl: string;
|
|
682
|
+
};
|
|
683
|
+
TableDefinitions: {
|
|
684
|
+
/** @description List of database databases */
|
|
685
|
+
databases: components['schemas']['Catalog'][];
|
|
686
|
+
};
|
|
687
|
+
Catalog: {
|
|
688
|
+
/** @description Database database name */
|
|
689
|
+
name: string;
|
|
690
|
+
/** @description User-friendly name for the database (typically project name) */
|
|
691
|
+
displayName?: string | null;
|
|
692
|
+
/** @description List of schemas in the database */
|
|
693
|
+
schemas: components['schemas']['Schema'][];
|
|
694
|
+
};
|
|
695
|
+
Schema: {
|
|
696
|
+
/** @description Schema name */
|
|
697
|
+
name: string;
|
|
698
|
+
/** @description User-friendly name for the schema (typically bucket display name) */
|
|
699
|
+
displayName?: string | null;
|
|
700
|
+
/** @description List of tables in the schema */
|
|
701
|
+
tables: components['schemas']['Table'][];
|
|
702
|
+
};
|
|
703
|
+
Table: {
|
|
704
|
+
/** @description Table name */
|
|
705
|
+
name: string;
|
|
706
|
+
/** @enum {string} */
|
|
707
|
+
type: 'BASE TABLE' | 'VIEW' | 'ALIAS' | 'LOCAL TEMPORARY';
|
|
708
|
+
/** @description User-friendly name for the table (typically table display name) */
|
|
709
|
+
displayName?: string | null;
|
|
710
|
+
/** @description Unique identifier of the table */
|
|
711
|
+
id?: string | null;
|
|
712
|
+
/** @description List of columns in the table */
|
|
713
|
+
columns: components['schemas']['Column'][];
|
|
714
|
+
metrics?: components['schemas']['TableMetrics'] | null;
|
|
715
|
+
lifecycle?: components['schemas']['TableLifecycle'] | null;
|
|
716
|
+
};
|
|
717
|
+
Column: {
|
|
718
|
+
/** @description Column name */
|
|
719
|
+
name: string;
|
|
720
|
+
/** @description Column data type. Present only when onlyWorkspaceSchema parameter is set to "1". */
|
|
721
|
+
type?: string;
|
|
722
|
+
};
|
|
723
|
+
TableMetrics: {
|
|
724
|
+
/** @description Number of rows in the table */
|
|
725
|
+
rowCount?: number | null;
|
|
726
|
+
/** @description Size of the table in bytes */
|
|
727
|
+
byteSize?: number | null;
|
|
728
|
+
};
|
|
729
|
+
TableLifecycle: {
|
|
730
|
+
/**
|
|
731
|
+
* Format: date-time
|
|
732
|
+
* @description Date and time when the table was created
|
|
733
|
+
*/
|
|
734
|
+
createdAt?: string | null;
|
|
735
|
+
/**
|
|
736
|
+
* Format: date-time
|
|
737
|
+
* @description Date and time of the last modification
|
|
738
|
+
*/
|
|
739
|
+
modifiedAt?: string | null;
|
|
740
|
+
/**
|
|
741
|
+
* Format: date-time
|
|
742
|
+
* @description Date and time of the last data import
|
|
743
|
+
*/
|
|
744
|
+
lastImportAt?: string | null;
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
responses: never;
|
|
748
|
+
parameters: never;
|
|
749
|
+
requestBodies: never;
|
|
750
|
+
headers: never;
|
|
751
|
+
pathItems: never;
|
|
752
|
+
};
|
|
753
|
+
type operations = {
|
|
754
|
+
index: {
|
|
755
|
+
parameters: {
|
|
756
|
+
query?: never;
|
|
757
|
+
header?: never;
|
|
758
|
+
path?: never;
|
|
759
|
+
cookie?: never;
|
|
760
|
+
};
|
|
761
|
+
requestBody?: never;
|
|
762
|
+
responses: {
|
|
763
|
+
/** @description OK */
|
|
764
|
+
200: {
|
|
765
|
+
headers: {
|
|
766
|
+
[name: string]: unknown;
|
|
767
|
+
};
|
|
768
|
+
content: {
|
|
769
|
+
'application/json': {
|
|
770
|
+
appName: string;
|
|
771
|
+
appVersion: string;
|
|
772
|
+
/** Format: url */
|
|
773
|
+
apiDocs: string;
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
};
|
|
778
|
+
};
|
|
779
|
+
healthCheck: {
|
|
780
|
+
parameters: {
|
|
781
|
+
query?: never;
|
|
782
|
+
header?: never;
|
|
783
|
+
path?: never;
|
|
784
|
+
cookie?: never;
|
|
785
|
+
};
|
|
786
|
+
requestBody?: never;
|
|
787
|
+
responses: {
|
|
788
|
+
/** @description OK */
|
|
789
|
+
200: {
|
|
790
|
+
headers: {
|
|
791
|
+
[name: string]: unknown;
|
|
792
|
+
};
|
|
793
|
+
content: {
|
|
794
|
+
'application/json': {
|
|
795
|
+
/** @enum {string} */
|
|
796
|
+
status: 'ok';
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
listSqlEditorSessions: {
|
|
803
|
+
parameters: {
|
|
804
|
+
query?: {
|
|
805
|
+
/** @description If set to "1", returns all sessions in the project. If omitted or set to "0", returns only sessions for the current user. */
|
|
806
|
+
listAll?: '0' | '1';
|
|
807
|
+
};
|
|
808
|
+
header?: never;
|
|
809
|
+
path?: never;
|
|
810
|
+
cookie?: never;
|
|
811
|
+
};
|
|
812
|
+
requestBody?: never;
|
|
813
|
+
responses: {
|
|
814
|
+
/** @description List of SQL Editor sessions */
|
|
815
|
+
200: {
|
|
816
|
+
headers: {
|
|
817
|
+
[name: string]: unknown;
|
|
818
|
+
};
|
|
819
|
+
content: {
|
|
820
|
+
'application/json': components['schemas']['SqlEditorSession'][];
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
/** @description Error response */
|
|
824
|
+
default: {
|
|
825
|
+
headers: {
|
|
826
|
+
[name: string]: unknown;
|
|
827
|
+
};
|
|
828
|
+
content: {
|
|
829
|
+
'application/json': components['schemas']['Error'];
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
createSqlEditorSession: {
|
|
835
|
+
parameters: {
|
|
836
|
+
query?: never;
|
|
837
|
+
header?: never;
|
|
838
|
+
path?: never;
|
|
839
|
+
cookie?: never;
|
|
840
|
+
};
|
|
841
|
+
requestBody: {
|
|
842
|
+
content: {
|
|
843
|
+
'application/json': components['schemas']['CreateSqlEditorSessionRequest'];
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
responses: {
|
|
847
|
+
/** @description SQL Editor session created successfully */
|
|
848
|
+
201: {
|
|
849
|
+
headers: {
|
|
850
|
+
[name: string]: unknown;
|
|
851
|
+
};
|
|
852
|
+
content: {
|
|
853
|
+
'application/json': components['schemas']['SqlEditorSession'];
|
|
854
|
+
};
|
|
855
|
+
};
|
|
856
|
+
/** @description Error response */
|
|
857
|
+
default: {
|
|
858
|
+
headers: {
|
|
859
|
+
[name: string]: unknown;
|
|
860
|
+
};
|
|
861
|
+
content: {
|
|
862
|
+
'application/json': components['schemas']['Error'];
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
getSqlEditorSession: {
|
|
868
|
+
parameters: {
|
|
869
|
+
query?: never;
|
|
870
|
+
header?: never;
|
|
871
|
+
path: {
|
|
872
|
+
/** @description SQL Editor session ID (UUID) */
|
|
873
|
+
id: string;
|
|
874
|
+
};
|
|
875
|
+
cookie?: never;
|
|
876
|
+
};
|
|
877
|
+
requestBody?: never;
|
|
878
|
+
responses: {
|
|
879
|
+
/** @description SQL Editor session details */
|
|
880
|
+
200: {
|
|
881
|
+
headers: {
|
|
882
|
+
[name: string]: unknown;
|
|
883
|
+
};
|
|
884
|
+
content: {
|
|
885
|
+
'application/json': components['schemas']['SqlEditorSession'];
|
|
886
|
+
};
|
|
887
|
+
};
|
|
888
|
+
/** @description Error response */
|
|
889
|
+
default: {
|
|
890
|
+
headers: {
|
|
891
|
+
[name: string]: unknown;
|
|
892
|
+
};
|
|
893
|
+
content: {
|
|
894
|
+
'application/json': components['schemas']['Error'];
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
deleteSqlEditorSession: {
|
|
900
|
+
parameters: {
|
|
901
|
+
query?: never;
|
|
902
|
+
header?: never;
|
|
903
|
+
path: {
|
|
904
|
+
/** @description SQL Editor session ID (UUID) */
|
|
905
|
+
id: string;
|
|
906
|
+
};
|
|
907
|
+
cookie?: never;
|
|
908
|
+
};
|
|
909
|
+
requestBody?: never;
|
|
910
|
+
responses: {
|
|
911
|
+
/** @description SQL Editor session deleted successfully */
|
|
912
|
+
204: {
|
|
913
|
+
headers: {
|
|
914
|
+
[name: string]: unknown;
|
|
915
|
+
};
|
|
916
|
+
content?: never;
|
|
917
|
+
};
|
|
918
|
+
/** @description Error response */
|
|
919
|
+
default: {
|
|
920
|
+
headers: {
|
|
921
|
+
[name: string]: unknown;
|
|
922
|
+
};
|
|
923
|
+
content: {
|
|
924
|
+
'application/json': components['schemas']['Error'];
|
|
925
|
+
};
|
|
926
|
+
};
|
|
927
|
+
};
|
|
928
|
+
};
|
|
929
|
+
getSqlEditorSessionCredentials: {
|
|
930
|
+
parameters: {
|
|
931
|
+
query?: never;
|
|
932
|
+
header?: never;
|
|
933
|
+
path: {
|
|
934
|
+
/** @description SQL Editor session ID (UUID) */
|
|
935
|
+
id: string;
|
|
936
|
+
};
|
|
937
|
+
cookie?: never;
|
|
938
|
+
};
|
|
939
|
+
requestBody?: never;
|
|
940
|
+
responses: {
|
|
941
|
+
/** @description Workspace credentials retrieved successfully */
|
|
942
|
+
200: {
|
|
943
|
+
headers: {
|
|
944
|
+
[name: string]: unknown;
|
|
945
|
+
};
|
|
946
|
+
content: {
|
|
947
|
+
'application/json': {
|
|
948
|
+
[key: string]: unknown;
|
|
949
|
+
};
|
|
950
|
+
};
|
|
951
|
+
};
|
|
952
|
+
/** @description Bad request (non-BigQuery workspace) */
|
|
953
|
+
400: {
|
|
954
|
+
headers: {
|
|
955
|
+
[name: string]: unknown;
|
|
956
|
+
};
|
|
957
|
+
content: {
|
|
958
|
+
'application/json': components['schemas']['Error'];
|
|
959
|
+
};
|
|
960
|
+
};
|
|
961
|
+
/** @description Session not found */
|
|
962
|
+
404: {
|
|
963
|
+
headers: {
|
|
964
|
+
[name: string]: unknown;
|
|
965
|
+
};
|
|
966
|
+
content: {
|
|
967
|
+
'application/json': components['schemas']['Error'];
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
/** @description Error response */
|
|
971
|
+
default: {
|
|
972
|
+
headers: {
|
|
973
|
+
[name: string]: unknown;
|
|
974
|
+
};
|
|
975
|
+
content: {
|
|
976
|
+
'application/json': components['schemas']['Error'];
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
getSqlEditorSessionWorkspacePassword: {
|
|
982
|
+
parameters: {
|
|
983
|
+
query?: never;
|
|
984
|
+
header?: never;
|
|
985
|
+
path: {
|
|
986
|
+
/** @description SQL Editor session ID (UUID) */
|
|
987
|
+
id: string;
|
|
988
|
+
};
|
|
989
|
+
cookie?: never;
|
|
990
|
+
};
|
|
991
|
+
requestBody?: never;
|
|
992
|
+
responses: {
|
|
993
|
+
/** @description Workspace password retrieved successfully */
|
|
994
|
+
200: {
|
|
995
|
+
headers: {
|
|
996
|
+
[name: string]: unknown;
|
|
997
|
+
};
|
|
998
|
+
content: {
|
|
999
|
+
'application/json': components['schemas']['WorkspacePasswordResponse'];
|
|
1000
|
+
};
|
|
1001
|
+
};
|
|
1002
|
+
/** @description Bad request (non-Snowflake workspace) */
|
|
1003
|
+
400: {
|
|
1004
|
+
headers: {
|
|
1005
|
+
[name: string]: unknown;
|
|
1006
|
+
};
|
|
1007
|
+
content: {
|
|
1008
|
+
'application/json': components['schemas']['Error'];
|
|
1009
|
+
};
|
|
1010
|
+
};
|
|
1011
|
+
/** @description Session not found */
|
|
1012
|
+
404: {
|
|
1013
|
+
headers: {
|
|
1014
|
+
[name: string]: unknown;
|
|
1015
|
+
};
|
|
1016
|
+
content: {
|
|
1017
|
+
'application/json': components['schemas']['Error'];
|
|
1018
|
+
};
|
|
1019
|
+
};
|
|
1020
|
+
/** @description Error response */
|
|
1021
|
+
default: {
|
|
1022
|
+
headers: {
|
|
1023
|
+
[name: string]: unknown;
|
|
1024
|
+
};
|
|
1025
|
+
content: {
|
|
1026
|
+
'application/json': components['schemas']['Error'];
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
};
|
|
1030
|
+
};
|
|
1031
|
+
loadSqlEditorSession: {
|
|
1032
|
+
parameters: {
|
|
1033
|
+
query?: never;
|
|
1034
|
+
header?: never;
|
|
1035
|
+
path: {
|
|
1036
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1037
|
+
id: string;
|
|
1038
|
+
};
|
|
1039
|
+
cookie?: never;
|
|
1040
|
+
};
|
|
1041
|
+
requestBody: {
|
|
1042
|
+
content: {
|
|
1043
|
+
'application/json': components['schemas']['LoadSessionRequest'];
|
|
1044
|
+
};
|
|
1045
|
+
};
|
|
1046
|
+
responses: {
|
|
1047
|
+
/** @description SQL Editor session loaded successfully */
|
|
1048
|
+
200: {
|
|
1049
|
+
headers: {
|
|
1050
|
+
[name: string]: unknown;
|
|
1051
|
+
};
|
|
1052
|
+
content: {
|
|
1053
|
+
'application/json': components['schemas']['SqlEditorSession'];
|
|
1054
|
+
};
|
|
1055
|
+
};
|
|
1056
|
+
/** @description Error response */
|
|
1057
|
+
default: {
|
|
1058
|
+
headers: {
|
|
1059
|
+
[name: string]: unknown;
|
|
1060
|
+
};
|
|
1061
|
+
content: {
|
|
1062
|
+
'application/json': components['schemas']['Error'];
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
unloadSqlEditorSession: {
|
|
1068
|
+
parameters: {
|
|
1069
|
+
query?: never;
|
|
1070
|
+
header?: never;
|
|
1071
|
+
path: {
|
|
1072
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1073
|
+
id: string;
|
|
1074
|
+
};
|
|
1075
|
+
cookie?: never;
|
|
1076
|
+
};
|
|
1077
|
+
requestBody?: {
|
|
1078
|
+
content: {
|
|
1079
|
+
'application/json': components['schemas']['UnloadSessionRequest'];
|
|
1080
|
+
};
|
|
1081
|
+
};
|
|
1082
|
+
responses: {
|
|
1083
|
+
/** @description SQL Editor session workspace unloaded successfully */
|
|
1084
|
+
200: {
|
|
1085
|
+
headers: {
|
|
1086
|
+
[name: string]: unknown;
|
|
1087
|
+
};
|
|
1088
|
+
content: {
|
|
1089
|
+
'application/json': components['schemas']['SqlEditorSession'];
|
|
1090
|
+
};
|
|
1091
|
+
};
|
|
1092
|
+
/** @description Error response */
|
|
1093
|
+
default: {
|
|
1094
|
+
headers: {
|
|
1095
|
+
[name: string]: unknown;
|
|
1096
|
+
};
|
|
1097
|
+
content: {
|
|
1098
|
+
'application/json': components['schemas']['Error'];
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
};
|
|
1103
|
+
resetSqlEditorSessionCredentials: {
|
|
1104
|
+
parameters: {
|
|
1105
|
+
query?: never;
|
|
1106
|
+
header?: never;
|
|
1107
|
+
path: {
|
|
1108
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1109
|
+
id: string;
|
|
1110
|
+
};
|
|
1111
|
+
cookie?: never;
|
|
1112
|
+
};
|
|
1113
|
+
requestBody?: never;
|
|
1114
|
+
responses: {
|
|
1115
|
+
/** @description Workspace credentials reset successfully */
|
|
1116
|
+
200: {
|
|
1117
|
+
headers: {
|
|
1118
|
+
[name: string]: unknown;
|
|
1119
|
+
};
|
|
1120
|
+
content: {
|
|
1121
|
+
'application/json': components['schemas']['ResetCredentialsResponse'];
|
|
1122
|
+
};
|
|
1123
|
+
};
|
|
1124
|
+
/** @description Bad request (non-Snowflake backend or invalid session state) */
|
|
1125
|
+
400: {
|
|
1126
|
+
headers: {
|
|
1127
|
+
[name: string]: unknown;
|
|
1128
|
+
};
|
|
1129
|
+
content: {
|
|
1130
|
+
'application/json': components['schemas']['Error'];
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
/** @description Session not found */
|
|
1134
|
+
404: {
|
|
1135
|
+
headers: {
|
|
1136
|
+
[name: string]: unknown;
|
|
1137
|
+
};
|
|
1138
|
+
content: {
|
|
1139
|
+
'application/json': components['schemas']['Error'];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
/** @description Error response */
|
|
1143
|
+
default: {
|
|
1144
|
+
headers: {
|
|
1145
|
+
[name: string]: unknown;
|
|
1146
|
+
};
|
|
1147
|
+
content: {
|
|
1148
|
+
'application/json': components['schemas']['Error'];
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
resetSqlEditorSessionPassword: {
|
|
1154
|
+
parameters: {
|
|
1155
|
+
query?: never;
|
|
1156
|
+
header?: never;
|
|
1157
|
+
path: {
|
|
1158
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1159
|
+
id: string;
|
|
1160
|
+
};
|
|
1161
|
+
cookie?: never;
|
|
1162
|
+
};
|
|
1163
|
+
requestBody?: never;
|
|
1164
|
+
responses: {
|
|
1165
|
+
/** @description Workspace password reset successfully */
|
|
1166
|
+
200: {
|
|
1167
|
+
headers: {
|
|
1168
|
+
[name: string]: unknown;
|
|
1169
|
+
};
|
|
1170
|
+
content: {
|
|
1171
|
+
'application/json': components['schemas']['ResetPasswordResponse'];
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
/** @description Bad request (non-Snowflake backend or invalid session state) */
|
|
1175
|
+
400: {
|
|
1176
|
+
headers: {
|
|
1177
|
+
[name: string]: unknown;
|
|
1178
|
+
};
|
|
1179
|
+
content: {
|
|
1180
|
+
'application/json': components['schemas']['Error'];
|
|
1181
|
+
};
|
|
1182
|
+
};
|
|
1183
|
+
/** @description Session not found */
|
|
1184
|
+
404: {
|
|
1185
|
+
headers: {
|
|
1186
|
+
[name: string]: unknown;
|
|
1187
|
+
};
|
|
1188
|
+
content: {
|
|
1189
|
+
'application/json': components['schemas']['Error'];
|
|
1190
|
+
};
|
|
1191
|
+
};
|
|
1192
|
+
/** @description Error response */
|
|
1193
|
+
default: {
|
|
1194
|
+
headers: {
|
|
1195
|
+
[name: string]: unknown;
|
|
1196
|
+
};
|
|
1197
|
+
content: {
|
|
1198
|
+
'application/json': components['schemas']['Error'];
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
acknowledgeSessionError: {
|
|
1204
|
+
parameters: {
|
|
1205
|
+
query?: never;
|
|
1206
|
+
header?: never;
|
|
1207
|
+
path: {
|
|
1208
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1209
|
+
id: string;
|
|
1210
|
+
};
|
|
1211
|
+
cookie?: never;
|
|
1212
|
+
};
|
|
1213
|
+
requestBody?: never;
|
|
1214
|
+
responses: {
|
|
1215
|
+
/** @description Session error acknowledged successfully */
|
|
1216
|
+
200: {
|
|
1217
|
+
headers: {
|
|
1218
|
+
[name: string]: unknown;
|
|
1219
|
+
};
|
|
1220
|
+
content: {
|
|
1221
|
+
'application/json': components['schemas']['SqlEditorSession'];
|
|
1222
|
+
};
|
|
1223
|
+
};
|
|
1224
|
+
/** @description Bad request (session has no error to acknowledge) */
|
|
1225
|
+
400: {
|
|
1226
|
+
headers: {
|
|
1227
|
+
[name: string]: unknown;
|
|
1228
|
+
};
|
|
1229
|
+
content: {
|
|
1230
|
+
'application/json': components['schemas']['Error'];
|
|
1231
|
+
};
|
|
1232
|
+
};
|
|
1233
|
+
/** @description Session not found */
|
|
1234
|
+
404: {
|
|
1235
|
+
headers: {
|
|
1236
|
+
[name: string]: unknown;
|
|
1237
|
+
};
|
|
1238
|
+
content: {
|
|
1239
|
+
'application/json': components['schemas']['Error'];
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
/** @description Error response */
|
|
1243
|
+
default: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
1247
|
+
content: {
|
|
1248
|
+
'application/json': components['schemas']['Error'];
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
1252
|
+
};
|
|
1253
|
+
getSqlEditorSessionSchema: {
|
|
1254
|
+
parameters: {
|
|
1255
|
+
query?: {
|
|
1256
|
+
/** @description If set to "1", returns only the workspace schema. If set to "0" or omitted, returns all available schemas excluding the workspace schema. */
|
|
1257
|
+
onlyWorkspaceSchema?: '0' | '1';
|
|
1258
|
+
/** @description If set to "1", loads table definitions including columns. If set to "0", returns only database and schema information without table details. */
|
|
1259
|
+
loadTables?: '0' | '1';
|
|
1260
|
+
};
|
|
1261
|
+
header?: never;
|
|
1262
|
+
path: {
|
|
1263
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1264
|
+
id: string;
|
|
1265
|
+
};
|
|
1266
|
+
cookie?: never;
|
|
1267
|
+
};
|
|
1268
|
+
requestBody?: never;
|
|
1269
|
+
responses: {
|
|
1270
|
+
/** @description Database schema information */
|
|
1271
|
+
200: {
|
|
1272
|
+
headers: {
|
|
1273
|
+
[name: string]: unknown;
|
|
1274
|
+
};
|
|
1275
|
+
content: {
|
|
1276
|
+
/**
|
|
1277
|
+
* @example {
|
|
1278
|
+
* "databases": [
|
|
1279
|
+
* {
|
|
1280
|
+
* "name": "KEBOOLA_123456",
|
|
1281
|
+
* "displayName": "My Production Project",
|
|
1282
|
+
* "schemas": [
|
|
1283
|
+
* {
|
|
1284
|
+
* "name": "in.c-sample-data",
|
|
1285
|
+
* "displayName": "Input Data",
|
|
1286
|
+
* "tables": [
|
|
1287
|
+
* {
|
|
1288
|
+
* "name": "users",
|
|
1289
|
+
* "type": "BASE TABLE",
|
|
1290
|
+
* "displayName": "User Accounts",
|
|
1291
|
+
* "id": "in.c-sample-data.users",
|
|
1292
|
+
* "columns": [
|
|
1293
|
+
* {
|
|
1294
|
+
* "name": "id"
|
|
1295
|
+
* },
|
|
1296
|
+
* {
|
|
1297
|
+
* "name": "email"
|
|
1298
|
+
* }
|
|
1299
|
+
* ]
|
|
1300
|
+
* }
|
|
1301
|
+
* ]
|
|
1302
|
+
* },
|
|
1303
|
+
* {
|
|
1304
|
+
* "name": "WORKSPACE_789",
|
|
1305
|
+
* "tables": [
|
|
1306
|
+
* {
|
|
1307
|
+
* "name": "temp_results",
|
|
1308
|
+
* "type": "BASE TABLE",
|
|
1309
|
+
* "columns": [
|
|
1310
|
+
* {
|
|
1311
|
+
* "name": "result_id",
|
|
1312
|
+
* "type": "INTEGER"
|
|
1313
|
+
* }
|
|
1314
|
+
* ]
|
|
1315
|
+
* }
|
|
1316
|
+
* ]
|
|
1317
|
+
* }
|
|
1318
|
+
* ]
|
|
1319
|
+
* }
|
|
1320
|
+
* ]
|
|
1321
|
+
* }
|
|
1322
|
+
*/
|
|
1323
|
+
'application/json': components['schemas']['TableDefinitions'];
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
/** @description Error response */
|
|
1327
|
+
default: {
|
|
1328
|
+
headers: {
|
|
1329
|
+
[name: string]: unknown;
|
|
1330
|
+
};
|
|
1331
|
+
content: {
|
|
1332
|
+
'application/json': components['schemas']['Error'];
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
};
|
|
1336
|
+
};
|
|
1337
|
+
getSqlEditorOutputTables: {
|
|
1338
|
+
parameters: {
|
|
1339
|
+
query?: never;
|
|
1340
|
+
header?: never;
|
|
1341
|
+
path?: never;
|
|
1342
|
+
cookie?: never;
|
|
1343
|
+
};
|
|
1344
|
+
requestBody: {
|
|
1345
|
+
content: {
|
|
1346
|
+
'application/json': components['schemas']['GetOutputTablesRequest'];
|
|
1347
|
+
};
|
|
1348
|
+
};
|
|
1349
|
+
responses: {
|
|
1350
|
+
/** @description List of output tables */
|
|
1351
|
+
200: {
|
|
1352
|
+
headers: {
|
|
1353
|
+
[name: string]: unknown;
|
|
1354
|
+
};
|
|
1355
|
+
content: {
|
|
1356
|
+
'application/json': components['schemas']['GetOutputTablesResponse'];
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
/** @description Error response */
|
|
1360
|
+
default: {
|
|
1361
|
+
headers: {
|
|
1362
|
+
[name: string]: unknown;
|
|
1363
|
+
};
|
|
1364
|
+
content: {
|
|
1365
|
+
'application/json': components['schemas']['Error'];
|
|
1366
|
+
};
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
};
|
|
1370
|
+
runSqlEditorQuery: {
|
|
1371
|
+
parameters: {
|
|
1372
|
+
query?: never;
|
|
1373
|
+
header?: never;
|
|
1374
|
+
path: {
|
|
1375
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1376
|
+
id: string;
|
|
1377
|
+
};
|
|
1378
|
+
cookie?: never;
|
|
1379
|
+
};
|
|
1380
|
+
requestBody: {
|
|
1381
|
+
content: {
|
|
1382
|
+
'application/json': components['schemas']['RunQueryRequest'];
|
|
1383
|
+
};
|
|
1384
|
+
};
|
|
1385
|
+
responses: {
|
|
1386
|
+
/** @description Queries executed successfully */
|
|
1387
|
+
200: {
|
|
1388
|
+
headers: {
|
|
1389
|
+
[name: string]: unknown;
|
|
1390
|
+
};
|
|
1391
|
+
content: {
|
|
1392
|
+
'application/json': components['schemas']['RunQueryResponse'];
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
/** @description Error response */
|
|
1396
|
+
default: {
|
|
1397
|
+
headers: {
|
|
1398
|
+
[name: string]: unknown;
|
|
1399
|
+
};
|
|
1400
|
+
content: {
|
|
1401
|
+
'application/json': components['schemas']['Error'];
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
getTablePreview: {
|
|
1407
|
+
parameters: {
|
|
1408
|
+
query?: never;
|
|
1409
|
+
header?: never;
|
|
1410
|
+
path: {
|
|
1411
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1412
|
+
id: string;
|
|
1413
|
+
};
|
|
1414
|
+
cookie?: never;
|
|
1415
|
+
};
|
|
1416
|
+
requestBody: {
|
|
1417
|
+
content: {
|
|
1418
|
+
'application/json': components['schemas']['TablePreviewRequest'];
|
|
1419
|
+
};
|
|
1420
|
+
};
|
|
1421
|
+
responses: {
|
|
1422
|
+
/** @description Table preview query submitted successfully */
|
|
1423
|
+
200: {
|
|
1424
|
+
headers: {
|
|
1425
|
+
[name: string]: unknown;
|
|
1426
|
+
};
|
|
1427
|
+
content: {
|
|
1428
|
+
'application/json': components['schemas']['TablePreviewResponse'];
|
|
1429
|
+
};
|
|
1430
|
+
};
|
|
1431
|
+
/** @description Error response */
|
|
1432
|
+
default: {
|
|
1433
|
+
headers: {
|
|
1434
|
+
[name: string]: unknown;
|
|
1435
|
+
};
|
|
1436
|
+
content: {
|
|
1437
|
+
'application/json': components['schemas']['Error'];
|
|
1438
|
+
};
|
|
1439
|
+
};
|
|
1440
|
+
};
|
|
1441
|
+
};
|
|
1442
|
+
getTableDDL: {
|
|
1443
|
+
parameters: {
|
|
1444
|
+
query: {
|
|
1445
|
+
/**
|
|
1446
|
+
* @description Name of the table to get DDL for
|
|
1447
|
+
* @example users
|
|
1448
|
+
*/
|
|
1449
|
+
tableName: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* @description Name of the schema containing the table
|
|
1452
|
+
* @example public
|
|
1453
|
+
*/
|
|
1454
|
+
schemaName: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* @description Name of the database containing the table
|
|
1457
|
+
* @example KEBOOLA_123
|
|
1458
|
+
*/
|
|
1459
|
+
databaseName: string;
|
|
1460
|
+
};
|
|
1461
|
+
header?: never;
|
|
1462
|
+
path: {
|
|
1463
|
+
/** @description SQL Editor session ID (UUID) */
|
|
1464
|
+
id: string;
|
|
1465
|
+
};
|
|
1466
|
+
cookie?: never;
|
|
1467
|
+
};
|
|
1468
|
+
requestBody?: never;
|
|
1469
|
+
responses: {
|
|
1470
|
+
/** @description DDL statement retrieved successfully */
|
|
1471
|
+
200: {
|
|
1472
|
+
headers: {
|
|
1473
|
+
[name: string]: unknown;
|
|
1474
|
+
};
|
|
1475
|
+
content: {
|
|
1476
|
+
/**
|
|
1477
|
+
* @example {
|
|
1478
|
+
* "ddl": "CREATE OR REPLACE TABLE \"KEBOOLA_123\".\"public\".\"users\" (id INT, name VARCHAR)"
|
|
1479
|
+
* }
|
|
1480
|
+
*/
|
|
1481
|
+
'application/json': components['schemas']['TableDDLResponse'];
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
/** @description Error response */
|
|
1485
|
+
default: {
|
|
1486
|
+
headers: {
|
|
1487
|
+
[name: string]: unknown;
|
|
1488
|
+
};
|
|
1489
|
+
content: {
|
|
1490
|
+
'application/json': components['schemas']['Error'];
|
|
1491
|
+
};
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1494
|
+
};
|
|
1495
|
+
};
|
|
1496
|
+
|
|
1497
|
+
type SqlSession = OpenapiReturnType<paths['/sql/sessions']['post']>;
|
|
1498
|
+
type CreateSqlSessionBody = OpenapiBodyType<paths['/sql/sessions']['post']>;
|
|
1499
|
+
type GetSqlSessionPath = OpenapiPathType<paths['/sql/sessions/{id}']['get']>;
|
|
1500
|
+
type GetSqlSessionsQuery = OpenapiQueryType<paths['/sql/sessions']['get']>;
|
|
1501
|
+
type GetSqlSessionSchemaQuery = OpenapiQueryType<paths['/sql/sessions/{id}/schema']['get']>;
|
|
1502
|
+
type GetSqlSessionSchemaPath = OpenapiPathType<paths['/sql/sessions/{id}/schema']['get']>;
|
|
1503
|
+
type Session = OpenapiReturnType<paths['/sql/sessions/{id}']['get']>;
|
|
1504
|
+
type SessionSchema = OpenapiReturnType<paths['/sql/sessions/{id}/schema']['get']>;
|
|
1505
|
+
type SessionSchemaDatabase = SessionSchema['databases'][number];
|
|
1506
|
+
type SessionSchemaBucket = SessionSchemaDatabase['schemas'][number];
|
|
1507
|
+
type SessionSchemaTable = SessionSchemaBucket['tables'][number];
|
|
1508
|
+
type SessionSchemaColumn = SessionSchemaTable['columns'][number];
|
|
1509
|
+
type PostSqlRunQueryPath = OpenapiPathType<paths['/sql/sessions/{id}/run-query']['post']>;
|
|
1510
|
+
type PostSqlRunQueryBody = OpenapiBodyType<paths['/sql/sessions/{id}/run-query']['post']>;
|
|
1511
|
+
type PostSqlTablePreviewPath = OpenapiPathType<paths['/sql/sessions/{id}/table-preview']['post']>;
|
|
1512
|
+
type PostSqlTablePreviewBody = OpenapiBodyType<paths['/sql/sessions/{id}/table-preview']['post']>;
|
|
1513
|
+
type GetSqlSessionTableDdlPath = OpenapiPathType<paths['/sql/sessions/{id}/table-ddl']['get']>;
|
|
1514
|
+
type GetSqlSessionTableDdlQuery = OpenapiQueryType<paths['/sql/sessions/{id}/table-ddl']['get']>;
|
|
1515
|
+
type PostSqlSessionLoadPath = OpenapiPathType<paths['/sql/sessions/{id}/load']['post']>;
|
|
1516
|
+
type PostSqlSessionLoadBody = OpenapiBodyType<paths['/sql/sessions/{id}/load']['post']>;
|
|
1517
|
+
type PostSqlSessionUnloadPath = OpenapiPathType<paths['/sql/sessions/{id}/unload']['post']>;
|
|
1518
|
+
type PostSqlSessionUnloadBody = OpenapiBodyType<paths['/sql/sessions/{id}/unload']['post']>;
|
|
1519
|
+
|
|
1520
|
+
export type { CreateSqlSessionBody as C, GetSqlSessionPath as G, PostSqlRunQueryPath as P, Session as S, GetSqlSessionsQuery as a, GetSqlSessionSchemaPath as b, GetSqlSessionSchemaQuery as c, components as d, PostSqlRunQueryBody as e, PostSqlTablePreviewPath as f, PostSqlTablePreviewBody as g, GetSqlSessionTableDdlPath as h, GetSqlSessionTableDdlQuery as i, PostSqlSessionLoadPath as j, PostSqlSessionLoadBody as k, PostSqlSessionUnloadPath as l, PostSqlSessionUnloadBody as m, SessionSchema as n, SessionSchemaBucket as o, SessionSchemaColumn as p, SessionSchemaDatabase as q, SessionSchemaTable as r, SqlSession as s };
|