@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,1657 @@
|
|
|
1
|
+
import { d as OpenapiPathType, c as OpenapiQueryType, b as OpenapiBodyType, a as OpenapiReturnType } from './types-C7mpAfq-.js';
|
|
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
|
+
'/health-check': {
|
|
10
|
+
parameters: {
|
|
11
|
+
query?: never;
|
|
12
|
+
header?: never;
|
|
13
|
+
path?: never;
|
|
14
|
+
cookie?: never;
|
|
15
|
+
};
|
|
16
|
+
get?: never;
|
|
17
|
+
put?: never;
|
|
18
|
+
/**
|
|
19
|
+
* Health-check endpoint
|
|
20
|
+
* @description Checks the service is up & running.
|
|
21
|
+
*/
|
|
22
|
+
post: operations['healthCheck'];
|
|
23
|
+
delete?: never;
|
|
24
|
+
options?: never;
|
|
25
|
+
head?: never;
|
|
26
|
+
patch?: never;
|
|
27
|
+
trace?: never;
|
|
28
|
+
};
|
|
29
|
+
'/git/repository': {
|
|
30
|
+
parameters: {
|
|
31
|
+
query?: never;
|
|
32
|
+
header?: never;
|
|
33
|
+
path?: never;
|
|
34
|
+
cookie?: never;
|
|
35
|
+
};
|
|
36
|
+
get?: never;
|
|
37
|
+
put?: never;
|
|
38
|
+
/**
|
|
39
|
+
* List git repository branches
|
|
40
|
+
* @description Clone repository without checkout and list remote branches.
|
|
41
|
+
*/
|
|
42
|
+
post: operations['gitRepository'];
|
|
43
|
+
delete?: never;
|
|
44
|
+
options?: never;
|
|
45
|
+
head?: never;
|
|
46
|
+
patch?: never;
|
|
47
|
+
trace?: never;
|
|
48
|
+
};
|
|
49
|
+
'/git/entrypoints': {
|
|
50
|
+
parameters: {
|
|
51
|
+
query?: never;
|
|
52
|
+
header?: never;
|
|
53
|
+
path?: never;
|
|
54
|
+
cookie?: never;
|
|
55
|
+
};
|
|
56
|
+
get?: never;
|
|
57
|
+
put?: never;
|
|
58
|
+
/**
|
|
59
|
+
* List repository entrypoints
|
|
60
|
+
* @description Checkout repository root and list files in root directory.
|
|
61
|
+
*/
|
|
62
|
+
post: operations['gitEntrypoints'];
|
|
63
|
+
delete?: never;
|
|
64
|
+
options?: never;
|
|
65
|
+
head?: never;
|
|
66
|
+
patch?: never;
|
|
67
|
+
trace?: never;
|
|
68
|
+
};
|
|
69
|
+
'/apps': {
|
|
70
|
+
parameters: {
|
|
71
|
+
query?: never;
|
|
72
|
+
header?: never;
|
|
73
|
+
path?: never;
|
|
74
|
+
cookie?: never;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* List apps
|
|
78
|
+
* @description List project apps.
|
|
79
|
+
*/
|
|
80
|
+
get: operations['listApps'];
|
|
81
|
+
put?: never;
|
|
82
|
+
/**
|
|
83
|
+
* Create app
|
|
84
|
+
* @description Create new app
|
|
85
|
+
*/
|
|
86
|
+
post: operations['createApp'];
|
|
87
|
+
delete?: never;
|
|
88
|
+
options?: never;
|
|
89
|
+
head?: never;
|
|
90
|
+
patch?: never;
|
|
91
|
+
trace?: never;
|
|
92
|
+
};
|
|
93
|
+
'/apps/{appId}': {
|
|
94
|
+
parameters: {
|
|
95
|
+
query?: never;
|
|
96
|
+
header?: never;
|
|
97
|
+
path?: never;
|
|
98
|
+
cookie?: never;
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* Get app detail
|
|
102
|
+
* @description Get app detail.
|
|
103
|
+
*/
|
|
104
|
+
get: operations['getApp'];
|
|
105
|
+
put?: never;
|
|
106
|
+
post?: never;
|
|
107
|
+
/**
|
|
108
|
+
* Delete app
|
|
109
|
+
* @description Delete app
|
|
110
|
+
*/
|
|
111
|
+
delete: operations['deleteApp'];
|
|
112
|
+
options?: never;
|
|
113
|
+
head?: never;
|
|
114
|
+
/**
|
|
115
|
+
* Update app state
|
|
116
|
+
* @description Update app state.
|
|
117
|
+
*/
|
|
118
|
+
patch: operations['patchApp'];
|
|
119
|
+
trace?: never;
|
|
120
|
+
};
|
|
121
|
+
'/apps/{appId}/proxy-config': {
|
|
122
|
+
parameters: {
|
|
123
|
+
query?: never;
|
|
124
|
+
header?: never;
|
|
125
|
+
path?: never;
|
|
126
|
+
cookie?: never;
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
* Get proxy config for the app
|
|
130
|
+
* @description Get proxy config for the app
|
|
131
|
+
*/
|
|
132
|
+
get: operations['getAppProxyConfig'];
|
|
133
|
+
put?: never;
|
|
134
|
+
post?: never;
|
|
135
|
+
delete?: never;
|
|
136
|
+
options?: never;
|
|
137
|
+
head?: never;
|
|
138
|
+
patch?: never;
|
|
139
|
+
trace?: never;
|
|
140
|
+
};
|
|
141
|
+
'/apps/{appId}/password': {
|
|
142
|
+
parameters: {
|
|
143
|
+
query?: never;
|
|
144
|
+
header?: never;
|
|
145
|
+
path?: never;
|
|
146
|
+
cookie?: never;
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* Get app password
|
|
150
|
+
* @description Returns app password. Currently applicable only for apps with auth type `password`.
|
|
151
|
+
*/
|
|
152
|
+
get: operations['getAppPassword'];
|
|
153
|
+
put?: never;
|
|
154
|
+
post?: never;
|
|
155
|
+
delete?: never;
|
|
156
|
+
options?: never;
|
|
157
|
+
head?: never;
|
|
158
|
+
patch?: never;
|
|
159
|
+
trace?: never;
|
|
160
|
+
};
|
|
161
|
+
'/apps/{appId}/reset-password': {
|
|
162
|
+
parameters: {
|
|
163
|
+
query?: never;
|
|
164
|
+
header?: never;
|
|
165
|
+
path?: never;
|
|
166
|
+
cookie?: never;
|
|
167
|
+
};
|
|
168
|
+
get?: never;
|
|
169
|
+
put?: never;
|
|
170
|
+
/**
|
|
171
|
+
* Reset app password
|
|
172
|
+
* @description Reset app password.
|
|
173
|
+
*/
|
|
174
|
+
post: operations['resetAppPassword'];
|
|
175
|
+
delete?: never;
|
|
176
|
+
options?: never;
|
|
177
|
+
head?: never;
|
|
178
|
+
patch?: never;
|
|
179
|
+
trace?: never;
|
|
180
|
+
};
|
|
181
|
+
'/apps/{appId}/logs/download': {
|
|
182
|
+
parameters: {
|
|
183
|
+
query?: never;
|
|
184
|
+
header?: never;
|
|
185
|
+
path?: never;
|
|
186
|
+
cookie?: never;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Download app logs
|
|
190
|
+
* @description Download app logs as a file.
|
|
191
|
+
*/
|
|
192
|
+
get: operations['downloadAppLogs'];
|
|
193
|
+
put?: never;
|
|
194
|
+
post?: never;
|
|
195
|
+
delete?: never;
|
|
196
|
+
options?: never;
|
|
197
|
+
head?: never;
|
|
198
|
+
patch?: never;
|
|
199
|
+
trace?: never;
|
|
200
|
+
};
|
|
201
|
+
'/apps/{appId}/logs/tail': {
|
|
202
|
+
parameters: {
|
|
203
|
+
query?: never;
|
|
204
|
+
header?: never;
|
|
205
|
+
path?: never;
|
|
206
|
+
cookie?: never;
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* Tail app logs
|
|
210
|
+
* @description Tail app logs.
|
|
211
|
+
*/
|
|
212
|
+
get: operations['tailAppLogs'];
|
|
213
|
+
put?: never;
|
|
214
|
+
post?: never;
|
|
215
|
+
delete?: never;
|
|
216
|
+
options?: never;
|
|
217
|
+
head?: never;
|
|
218
|
+
patch?: never;
|
|
219
|
+
trace?: never;
|
|
220
|
+
};
|
|
221
|
+
'/apps/{appId}/runs': {
|
|
222
|
+
parameters: {
|
|
223
|
+
query?: never;
|
|
224
|
+
header?: never;
|
|
225
|
+
path?: never;
|
|
226
|
+
cookie?: never;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* List app runs
|
|
230
|
+
* @description List app runs for a specific app.
|
|
231
|
+
*/
|
|
232
|
+
get: operations['listAppRuns'];
|
|
233
|
+
put?: never;
|
|
234
|
+
post?: never;
|
|
235
|
+
delete?: never;
|
|
236
|
+
options?: never;
|
|
237
|
+
head?: never;
|
|
238
|
+
patch?: never;
|
|
239
|
+
trace?: never;
|
|
240
|
+
};
|
|
241
|
+
'/apps/{appId}/runs/{runId}': {
|
|
242
|
+
parameters: {
|
|
243
|
+
query?: never;
|
|
244
|
+
header?: never;
|
|
245
|
+
path?: never;
|
|
246
|
+
cookie?: never;
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* Get app run detail
|
|
250
|
+
* @description Get detailed information about a specific app run.
|
|
251
|
+
*/
|
|
252
|
+
get: operations['getAppRun'];
|
|
253
|
+
put?: never;
|
|
254
|
+
post?: never;
|
|
255
|
+
delete?: never;
|
|
256
|
+
options?: never;
|
|
257
|
+
head?: never;
|
|
258
|
+
patch?: never;
|
|
259
|
+
trace?: never;
|
|
260
|
+
};
|
|
261
|
+
'/sandboxes': {
|
|
262
|
+
parameters: {
|
|
263
|
+
query?: never;
|
|
264
|
+
header?: never;
|
|
265
|
+
path?: never;
|
|
266
|
+
cookie?: never;
|
|
267
|
+
};
|
|
268
|
+
get?: never;
|
|
269
|
+
put?: never;
|
|
270
|
+
/**
|
|
271
|
+
* Create sandbox
|
|
272
|
+
* @description This endpoint is intended to create Python/R Sandboxes.
|
|
273
|
+
*/
|
|
274
|
+
post: operations['createSandbox'];
|
|
275
|
+
delete?: never;
|
|
276
|
+
options?: never;
|
|
277
|
+
head?: never;
|
|
278
|
+
patch?: never;
|
|
279
|
+
trace?: never;
|
|
280
|
+
};
|
|
281
|
+
'/sandboxes/{appId}': {
|
|
282
|
+
parameters: {
|
|
283
|
+
query?: never;
|
|
284
|
+
header?: never;
|
|
285
|
+
path?: never;
|
|
286
|
+
cookie?: never;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* Get sandbox
|
|
290
|
+
* @description This endpoint is intended to get details for Python/R Sandboxes.
|
|
291
|
+
*/
|
|
292
|
+
get: operations['getSandbox'];
|
|
293
|
+
put?: never;
|
|
294
|
+
post?: never;
|
|
295
|
+
/**
|
|
296
|
+
* Delete sandbox
|
|
297
|
+
* @description This endpoint is intended to delete Python/R Sandboxes.
|
|
298
|
+
*/
|
|
299
|
+
delete: operations['deleteSandbox'];
|
|
300
|
+
options?: never;
|
|
301
|
+
head?: never;
|
|
302
|
+
/**
|
|
303
|
+
* Update sandbox
|
|
304
|
+
* @description This endpoint is intended to update Python/R Sandboxes.
|
|
305
|
+
*/
|
|
306
|
+
patch: operations['patchSandbox'];
|
|
307
|
+
trace?: never;
|
|
308
|
+
};
|
|
309
|
+
'/runtimes': {
|
|
310
|
+
parameters: {
|
|
311
|
+
query?: never;
|
|
312
|
+
header?: never;
|
|
313
|
+
path?: never;
|
|
314
|
+
cookie?: never;
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* List Runtimes
|
|
318
|
+
* @description List of registered runtimes
|
|
319
|
+
*/
|
|
320
|
+
get: operations['listRuntimes'];
|
|
321
|
+
put?: never;
|
|
322
|
+
post?: never;
|
|
323
|
+
delete?: never;
|
|
324
|
+
options?: never;
|
|
325
|
+
head?: never;
|
|
326
|
+
patch?: never;
|
|
327
|
+
trace?: never;
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
type components = {
|
|
331
|
+
schemas: {
|
|
332
|
+
/**
|
|
333
|
+
* @description Git repository request. Authentication is required - provide either SSH key or username/password credentials.
|
|
334
|
+
* Sensitive fields (password, sshKey) are write-only and will not be returned in responses.
|
|
335
|
+
*/
|
|
336
|
+
GitRequest:
|
|
337
|
+
| components['schemas']['GitRequestWithSshKey']
|
|
338
|
+
| components['schemas']['GitRequestWithUsernamePassword'];
|
|
339
|
+
/** @description Git request using SSH key authentication. */
|
|
340
|
+
GitRequestWithSshKey: {
|
|
341
|
+
/** @description Git repository URL (HTTP(S) or SSH format) */
|
|
342
|
+
repository: string;
|
|
343
|
+
/** @description Optional branch name (default is main for entrypoints) */
|
|
344
|
+
branch?: string | null;
|
|
345
|
+
/**
|
|
346
|
+
* @description SSH private key for repository access in OpenSSH format (must start with -----BEGIN).
|
|
347
|
+
* Required when using SSH authentication. Mutually exclusive with username/password.
|
|
348
|
+
*/
|
|
349
|
+
sshKey: string;
|
|
350
|
+
};
|
|
351
|
+
/** @description Git request using username/password authentication. */
|
|
352
|
+
GitRequestWithUsernamePassword: {
|
|
353
|
+
/** @description Git repository URL (must be HTTP(S) format for username/password authentication) */
|
|
354
|
+
repository: string;
|
|
355
|
+
/** @description Optional branch name (default is main for entrypoints) */
|
|
356
|
+
branch?: string | null;
|
|
357
|
+
/** @description HTTP basic auth username. Required together with password. */
|
|
358
|
+
username: string;
|
|
359
|
+
/**
|
|
360
|
+
* @description HTTP basic auth password. Required together with username.
|
|
361
|
+
* Mutually exclusive with sshKey.
|
|
362
|
+
*/
|
|
363
|
+
password: string;
|
|
364
|
+
};
|
|
365
|
+
GitRepositoryResponse: {
|
|
366
|
+
repository: {
|
|
367
|
+
/** @description Repository URL without credentials */
|
|
368
|
+
url: string;
|
|
369
|
+
branches: {
|
|
370
|
+
/** @description Branch name */
|
|
371
|
+
branch: string;
|
|
372
|
+
/** @description Commit message */
|
|
373
|
+
comment: string;
|
|
374
|
+
/** @description Commit hash (short) */
|
|
375
|
+
sha: string;
|
|
376
|
+
author: {
|
|
377
|
+
/** @description Author name */
|
|
378
|
+
name: string;
|
|
379
|
+
/**
|
|
380
|
+
* @description Author email (normalized, without angle brackets)
|
|
381
|
+
* @example user@example.com
|
|
382
|
+
*/
|
|
383
|
+
email: string;
|
|
384
|
+
};
|
|
385
|
+
/**
|
|
386
|
+
* Format: date-time
|
|
387
|
+
* @description Author date in ISO8601 format
|
|
388
|
+
* @example 2024-01-01T12:00:00+00:00
|
|
389
|
+
*/
|
|
390
|
+
date: string;
|
|
391
|
+
}[];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
GitEntrypointsResponse: {
|
|
395
|
+
entrypoints: string[];
|
|
396
|
+
};
|
|
397
|
+
Runtime: {
|
|
398
|
+
/** @description Human-readable description of the runtime */
|
|
399
|
+
description: string;
|
|
400
|
+
/** @description Runtime type (e.g., python, r, streamlit) */
|
|
401
|
+
type: string;
|
|
402
|
+
/** @description Whether this runtime is the default for its type */
|
|
403
|
+
isTypeDefault: boolean;
|
|
404
|
+
/**
|
|
405
|
+
* Format: date-time
|
|
406
|
+
* @description Date when the runtime was released
|
|
407
|
+
*/
|
|
408
|
+
releaseDate: string;
|
|
409
|
+
/**
|
|
410
|
+
* Format: date-time
|
|
411
|
+
* @description Date when the runtime reaches end of life (null if no end date)
|
|
412
|
+
*/
|
|
413
|
+
endOfLifeDate?: string | null;
|
|
414
|
+
/** @description Docker image name */
|
|
415
|
+
imageName?: string | null;
|
|
416
|
+
/** @description Docker image tag */
|
|
417
|
+
imageTag?: string | null;
|
|
418
|
+
/** @description Transformation component ID (if applicable) */
|
|
419
|
+
transformationComponentId?: string | null;
|
|
420
|
+
/** @description Transformation component tag (if applicable) */
|
|
421
|
+
transformationComponentTag?: string | null;
|
|
422
|
+
/** @description Sandbox Docker image name (if different from main image) */
|
|
423
|
+
sandboxImageName?: string | null;
|
|
424
|
+
/** @description Sandbox Docker image tag (if different from main image) */
|
|
425
|
+
sandboxImageTag?: string | null;
|
|
426
|
+
};
|
|
427
|
+
ExistingApp: {
|
|
428
|
+
id: string;
|
|
429
|
+
/** @description App type (e.g. streamlit, jupyter, python, python-js) */
|
|
430
|
+
type?: string | null;
|
|
431
|
+
projectId: string;
|
|
432
|
+
componentId: string;
|
|
433
|
+
branchId: string | null;
|
|
434
|
+
configId: string;
|
|
435
|
+
configVersion: string;
|
|
436
|
+
/** @enum {string} */
|
|
437
|
+
state:
|
|
438
|
+
| 'created'
|
|
439
|
+
| 'starting'
|
|
440
|
+
| 'restarting'
|
|
441
|
+
| 'running'
|
|
442
|
+
| 'stopping'
|
|
443
|
+
| 'stopped'
|
|
444
|
+
| 'deleting'
|
|
445
|
+
| 'deleted';
|
|
446
|
+
/** @enum {string} */
|
|
447
|
+
desiredState: 'running' | 'stopped' | 'deleted';
|
|
448
|
+
/** Format: date-time */
|
|
449
|
+
lastRequestTimestamp: string | null;
|
|
450
|
+
/** Format: date-time */
|
|
451
|
+
lastStartTimestamp?: string | null;
|
|
452
|
+
url?: string | null;
|
|
453
|
+
/** @description `0` means whatever default is configured on backend */
|
|
454
|
+
autoSuspendAfterSeconds?: number;
|
|
455
|
+
/** @description Whether auto-restart is enabled for the app. When disabled, the app can be started only manually by setting `desiredState` to `running`, not by opening the app URL. */
|
|
456
|
+
autoRestartEnabled?: boolean;
|
|
457
|
+
/** @description App size (e.g. micro, tiny, small, medium, large, external) */
|
|
458
|
+
size?: string | null;
|
|
459
|
+
/** @enum {string} */
|
|
460
|
+
provisioningStrategy: 'jobQueue' | 'operator';
|
|
461
|
+
};
|
|
462
|
+
/** @description Response schema for sandbox endpoints (GET, POST, PATCH). */
|
|
463
|
+
SandboxResponse: {
|
|
464
|
+
id?: string;
|
|
465
|
+
projectId?: string;
|
|
466
|
+
/**
|
|
467
|
+
* @deprecated
|
|
468
|
+
* @description Always empty string
|
|
469
|
+
*/
|
|
470
|
+
tokenId?: string;
|
|
471
|
+
branchId?: string | null;
|
|
472
|
+
configurationId?: string;
|
|
473
|
+
/**
|
|
474
|
+
* @deprecated
|
|
475
|
+
* @description Always empty string
|
|
476
|
+
*/
|
|
477
|
+
physicalId?: string;
|
|
478
|
+
type?: string;
|
|
479
|
+
/** @description Whether the sandbox is currently running. */
|
|
480
|
+
active?: boolean;
|
|
481
|
+
/** Format: date-time */
|
|
482
|
+
createdTimestamp?: string;
|
|
483
|
+
/** Format: date-time */
|
|
484
|
+
startTimestamp?: string;
|
|
485
|
+
/** Format: date-time */
|
|
486
|
+
updatedTimestamp?: string;
|
|
487
|
+
persistentStorage?: {
|
|
488
|
+
pvcName?: string | null;
|
|
489
|
+
k8sManifest?: string | null;
|
|
490
|
+
/** @description Whether persistent storage is enabled for this sandbox. */
|
|
491
|
+
isEnabled?: boolean;
|
|
492
|
+
/** @description Whether the project-level persistent storage is ready. */
|
|
493
|
+
ready?: boolean | null;
|
|
494
|
+
/** @description Kubernetes StorageClass name for the project's persistent storage. */
|
|
495
|
+
k8sStorageClassName?: string | null;
|
|
496
|
+
};
|
|
497
|
+
shared?: boolean;
|
|
498
|
+
componentId?: string;
|
|
499
|
+
configurationVersion?: string;
|
|
500
|
+
size?: string | null;
|
|
501
|
+
/**
|
|
502
|
+
* Format: date-time
|
|
503
|
+
* @deprecated
|
|
504
|
+
* @description Always null
|
|
505
|
+
*/
|
|
506
|
+
lastAutosaveTimestamp?: string | null;
|
|
507
|
+
/**
|
|
508
|
+
* Format: date-time
|
|
509
|
+
* @deprecated
|
|
510
|
+
* @description Deprecated, always null
|
|
511
|
+
*/
|
|
512
|
+
expirationTimestamp?: string | null;
|
|
513
|
+
/** @description Auto-suspend timeout in seconds (defaults to 3600) */
|
|
514
|
+
autoSuspendAfterSeconds?: number;
|
|
515
|
+
/**
|
|
516
|
+
* @deprecated
|
|
517
|
+
* @description Deprecated, use autoSuspendAfterSeconds
|
|
518
|
+
*/
|
|
519
|
+
expirationAfterHours?: number;
|
|
520
|
+
/**
|
|
521
|
+
* @deprecated
|
|
522
|
+
* @description Always null
|
|
523
|
+
*/
|
|
524
|
+
user?: string | null;
|
|
525
|
+
url?: string | null;
|
|
526
|
+
password?: string | null;
|
|
527
|
+
/**
|
|
528
|
+
* @deprecated
|
|
529
|
+
* @description Always null
|
|
530
|
+
*/
|
|
531
|
+
autosaveTokenId?: string | null;
|
|
532
|
+
/**
|
|
533
|
+
* @deprecated
|
|
534
|
+
* @description Deprecated, always null
|
|
535
|
+
*/
|
|
536
|
+
host?: string | null;
|
|
537
|
+
imageVersion?: string | null;
|
|
538
|
+
packages?: string[] | null;
|
|
539
|
+
/**
|
|
540
|
+
* @deprecated
|
|
541
|
+
* @description Deprecated, always null
|
|
542
|
+
*/
|
|
543
|
+
sizeParameters?: unknown;
|
|
544
|
+
/**
|
|
545
|
+
* @deprecated
|
|
546
|
+
* @description Deprecated, always null
|
|
547
|
+
*/
|
|
548
|
+
stagingWorkspaceId?: unknown;
|
|
549
|
+
/**
|
|
550
|
+
* @deprecated
|
|
551
|
+
* @description Deprecated, always null
|
|
552
|
+
*/
|
|
553
|
+
stagingWorkspaceType?: unknown;
|
|
554
|
+
/**
|
|
555
|
+
* @deprecated
|
|
556
|
+
* @description Deprecated, always null
|
|
557
|
+
*/
|
|
558
|
+
workspaceDetails?: unknown;
|
|
559
|
+
/**
|
|
560
|
+
* @deprecated
|
|
561
|
+
* @description Deprecated, always null
|
|
562
|
+
*/
|
|
563
|
+
databricks?: unknown;
|
|
564
|
+
/**
|
|
565
|
+
* @deprecated
|
|
566
|
+
* @description Deprecated, always null
|
|
567
|
+
*/
|
|
568
|
+
credentials?: unknown;
|
|
569
|
+
};
|
|
570
|
+
AppRun: {
|
|
571
|
+
/** @description Unique identifier for the app run (UUID in RFC 4122 format) */
|
|
572
|
+
id: string;
|
|
573
|
+
/** @description ID of the app this run belongs to */
|
|
574
|
+
appId: string;
|
|
575
|
+
/**
|
|
576
|
+
* @description Current state of the app run
|
|
577
|
+
* @enum {string|null}
|
|
578
|
+
*/
|
|
579
|
+
state?: 'starting' | 'running' | 'failed' | 'finished' | null;
|
|
580
|
+
/**
|
|
581
|
+
* Format: date-time
|
|
582
|
+
* @description Timestamp when the app run was created (ISO 8601 ATOM format)
|
|
583
|
+
*/
|
|
584
|
+
createdAt?: string | null;
|
|
585
|
+
/**
|
|
586
|
+
* Format: date-time
|
|
587
|
+
* @description Timestamp when the app run started (ISO 8601 ATOM format)
|
|
588
|
+
*/
|
|
589
|
+
startedAt?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* Format: date-time
|
|
592
|
+
* @description Timestamp when the app run stopped (ISO 8601 ATOM format)
|
|
593
|
+
*/
|
|
594
|
+
stoppedAt?: string | null;
|
|
595
|
+
/** @description Startup logs from the app run */
|
|
596
|
+
startupLogs?: string | null;
|
|
597
|
+
/** @description Runtime size used for this app run (e.g., small, medium, large) */
|
|
598
|
+
runtimeSize?: string | null;
|
|
599
|
+
/** @description Configuration version used for this app run */
|
|
600
|
+
configVersion?: string | null;
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
responses: never;
|
|
604
|
+
parameters: never;
|
|
605
|
+
requestBodies: never;
|
|
606
|
+
headers: never;
|
|
607
|
+
pathItems: never;
|
|
608
|
+
};
|
|
609
|
+
type operations = {
|
|
610
|
+
healthCheck: {
|
|
611
|
+
parameters: {
|
|
612
|
+
query?: never;
|
|
613
|
+
header?: never;
|
|
614
|
+
path?: never;
|
|
615
|
+
cookie?: never;
|
|
616
|
+
};
|
|
617
|
+
requestBody?: never;
|
|
618
|
+
responses: {
|
|
619
|
+
/** @description OK */
|
|
620
|
+
200: {
|
|
621
|
+
headers: {
|
|
622
|
+
[name: string]: unknown;
|
|
623
|
+
};
|
|
624
|
+
content: {
|
|
625
|
+
'application/json': {
|
|
626
|
+
api?: string;
|
|
627
|
+
/** Format: url */
|
|
628
|
+
documentation?: string;
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
};
|
|
633
|
+
};
|
|
634
|
+
gitRepository: {
|
|
635
|
+
parameters: {
|
|
636
|
+
query?: never;
|
|
637
|
+
header?: never;
|
|
638
|
+
path?: never;
|
|
639
|
+
cookie?: never;
|
|
640
|
+
};
|
|
641
|
+
requestBody: {
|
|
642
|
+
content: {
|
|
643
|
+
'application/json': components['schemas']['GitRequest'];
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
responses: {
|
|
647
|
+
/** @description OK */
|
|
648
|
+
200: {
|
|
649
|
+
headers: {
|
|
650
|
+
[name: string]: unknown;
|
|
651
|
+
};
|
|
652
|
+
content: {
|
|
653
|
+
'application/json': components['schemas']['GitRepositoryResponse'];
|
|
654
|
+
};
|
|
655
|
+
};
|
|
656
|
+
/** @description Bad Request */
|
|
657
|
+
400: {
|
|
658
|
+
headers: {
|
|
659
|
+
[name: string]: unknown;
|
|
660
|
+
};
|
|
661
|
+
content?: never;
|
|
662
|
+
};
|
|
663
|
+
/** @description Unauthorized */
|
|
664
|
+
401: {
|
|
665
|
+
headers: {
|
|
666
|
+
[name: string]: unknown;
|
|
667
|
+
};
|
|
668
|
+
content?: never;
|
|
669
|
+
};
|
|
670
|
+
/** @description Validation Error */
|
|
671
|
+
422: {
|
|
672
|
+
headers: {
|
|
673
|
+
[name: string]: unknown;
|
|
674
|
+
};
|
|
675
|
+
content: {
|
|
676
|
+
'application/json': {
|
|
677
|
+
error?: string;
|
|
678
|
+
violations?: Record<string, never>[];
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
};
|
|
682
|
+
};
|
|
683
|
+
};
|
|
684
|
+
gitEntrypoints: {
|
|
685
|
+
parameters: {
|
|
686
|
+
query?: never;
|
|
687
|
+
header?: never;
|
|
688
|
+
path?: never;
|
|
689
|
+
cookie?: never;
|
|
690
|
+
};
|
|
691
|
+
requestBody: {
|
|
692
|
+
content: {
|
|
693
|
+
'application/json': components['schemas']['GitRequest'];
|
|
694
|
+
};
|
|
695
|
+
};
|
|
696
|
+
responses: {
|
|
697
|
+
/** @description OK */
|
|
698
|
+
200: {
|
|
699
|
+
headers: {
|
|
700
|
+
[name: string]: unknown;
|
|
701
|
+
};
|
|
702
|
+
content: {
|
|
703
|
+
'application/json': components['schemas']['GitEntrypointsResponse'];
|
|
704
|
+
};
|
|
705
|
+
};
|
|
706
|
+
/** @description Bad Request */
|
|
707
|
+
400: {
|
|
708
|
+
headers: {
|
|
709
|
+
[name: string]: unknown;
|
|
710
|
+
};
|
|
711
|
+
content?: never;
|
|
712
|
+
};
|
|
713
|
+
/** @description Unauthorized */
|
|
714
|
+
401: {
|
|
715
|
+
headers: {
|
|
716
|
+
[name: string]: unknown;
|
|
717
|
+
};
|
|
718
|
+
content?: never;
|
|
719
|
+
};
|
|
720
|
+
/** @description Validation Error */
|
|
721
|
+
422: {
|
|
722
|
+
headers: {
|
|
723
|
+
[name: string]: unknown;
|
|
724
|
+
};
|
|
725
|
+
content: {
|
|
726
|
+
'application/json': {
|
|
727
|
+
error?: string;
|
|
728
|
+
violations?: Record<string, never>[];
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
listApps: {
|
|
735
|
+
parameters: {
|
|
736
|
+
query?: {
|
|
737
|
+
offset?: number;
|
|
738
|
+
limit?: number;
|
|
739
|
+
/** @description Filter apps by component ID */
|
|
740
|
+
componentId?: string;
|
|
741
|
+
/** @description Filter apps by type (can be specified multiple times) */
|
|
742
|
+
type?: ('bigquery' | 'python' | 'r' | 'snowflake' | 'streamlit' | 'python-js')[];
|
|
743
|
+
/** @description Filter apps by branch ID */
|
|
744
|
+
branchId?: string;
|
|
745
|
+
};
|
|
746
|
+
header?: never;
|
|
747
|
+
path?: never;
|
|
748
|
+
cookie?: never;
|
|
749
|
+
};
|
|
750
|
+
requestBody?: never;
|
|
751
|
+
responses: {
|
|
752
|
+
/** @description OK */
|
|
753
|
+
200: {
|
|
754
|
+
headers: {
|
|
755
|
+
[name: string]: unknown;
|
|
756
|
+
};
|
|
757
|
+
content: {
|
|
758
|
+
'application/json': components['schemas']['ExistingApp'][];
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
/** @description Unauthorized */
|
|
762
|
+
401: {
|
|
763
|
+
headers: {
|
|
764
|
+
[name: string]: unknown;
|
|
765
|
+
};
|
|
766
|
+
content?: never;
|
|
767
|
+
};
|
|
768
|
+
/** @description Forbidden */
|
|
769
|
+
403: {
|
|
770
|
+
headers: {
|
|
771
|
+
[name: string]: unknown;
|
|
772
|
+
};
|
|
773
|
+
content?: never;
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
createApp: {
|
|
778
|
+
parameters: {
|
|
779
|
+
query?: never;
|
|
780
|
+
header?: never;
|
|
781
|
+
path?: never;
|
|
782
|
+
cookie?: never;
|
|
783
|
+
};
|
|
784
|
+
/** @description App data */
|
|
785
|
+
requestBody: {
|
|
786
|
+
content: {
|
|
787
|
+
'application/json': {
|
|
788
|
+
type: string;
|
|
789
|
+
branchId: string | null;
|
|
790
|
+
name: string;
|
|
791
|
+
description?: string | null;
|
|
792
|
+
config?: {
|
|
793
|
+
[key: string]: unknown;
|
|
794
|
+
} | null;
|
|
795
|
+
};
|
|
796
|
+
};
|
|
797
|
+
};
|
|
798
|
+
responses: {
|
|
799
|
+
/** @description OK */
|
|
800
|
+
200: {
|
|
801
|
+
headers: {
|
|
802
|
+
[name: string]: unknown;
|
|
803
|
+
};
|
|
804
|
+
content: {
|
|
805
|
+
'application/json': components['schemas']['ExistingApp'];
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
/** @description Unauthorized */
|
|
809
|
+
401: {
|
|
810
|
+
headers: {
|
|
811
|
+
[name: string]: unknown;
|
|
812
|
+
};
|
|
813
|
+
content?: never;
|
|
814
|
+
};
|
|
815
|
+
/** @description Unprocessable Entity */
|
|
816
|
+
422: {
|
|
817
|
+
headers: {
|
|
818
|
+
[name: string]: unknown;
|
|
819
|
+
};
|
|
820
|
+
content?: never;
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
getApp: {
|
|
825
|
+
parameters: {
|
|
826
|
+
query?: never;
|
|
827
|
+
header?: never;
|
|
828
|
+
path: {
|
|
829
|
+
appId: string;
|
|
830
|
+
};
|
|
831
|
+
cookie?: never;
|
|
832
|
+
};
|
|
833
|
+
requestBody?: never;
|
|
834
|
+
responses: {
|
|
835
|
+
/** @description OK */
|
|
836
|
+
200: {
|
|
837
|
+
headers: {
|
|
838
|
+
[name: string]: unknown;
|
|
839
|
+
};
|
|
840
|
+
content: {
|
|
841
|
+
'application/json': components['schemas']['ExistingApp'];
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
/** @description Unauthorized */
|
|
845
|
+
401: {
|
|
846
|
+
headers: {
|
|
847
|
+
[name: string]: unknown;
|
|
848
|
+
};
|
|
849
|
+
content?: never;
|
|
850
|
+
};
|
|
851
|
+
/** @description Forbidden */
|
|
852
|
+
403: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content?: never;
|
|
857
|
+
};
|
|
858
|
+
/** @description Not Found */
|
|
859
|
+
404: {
|
|
860
|
+
headers: {
|
|
861
|
+
[name: string]: unknown;
|
|
862
|
+
};
|
|
863
|
+
content?: never;
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
deleteApp: {
|
|
868
|
+
parameters: {
|
|
869
|
+
query?: never;
|
|
870
|
+
header?: never;
|
|
871
|
+
path: {
|
|
872
|
+
appId: string;
|
|
873
|
+
};
|
|
874
|
+
cookie?: never;
|
|
875
|
+
};
|
|
876
|
+
requestBody?: never;
|
|
877
|
+
responses: {
|
|
878
|
+
/** @description Accepted */
|
|
879
|
+
202: {
|
|
880
|
+
headers: {
|
|
881
|
+
[name: string]: unknown;
|
|
882
|
+
};
|
|
883
|
+
content?: never;
|
|
884
|
+
};
|
|
885
|
+
/** @description Unauthorized */
|
|
886
|
+
401: {
|
|
887
|
+
headers: {
|
|
888
|
+
[name: string]: unknown;
|
|
889
|
+
};
|
|
890
|
+
content?: never;
|
|
891
|
+
};
|
|
892
|
+
/** @description Forbidden */
|
|
893
|
+
403: {
|
|
894
|
+
headers: {
|
|
895
|
+
[name: string]: unknown;
|
|
896
|
+
};
|
|
897
|
+
content?: never;
|
|
898
|
+
};
|
|
899
|
+
/** @description Not Found */
|
|
900
|
+
404: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content?: never;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
patchApp: {
|
|
909
|
+
parameters: {
|
|
910
|
+
query?: never;
|
|
911
|
+
header?: never;
|
|
912
|
+
path: {
|
|
913
|
+
appId: string;
|
|
914
|
+
};
|
|
915
|
+
cookie?: never;
|
|
916
|
+
};
|
|
917
|
+
/** @description App state */
|
|
918
|
+
requestBody: {
|
|
919
|
+
content: {
|
|
920
|
+
'application/json': {
|
|
921
|
+
/** @enum {string} */
|
|
922
|
+
desiredState?: 'running' | 'stopped';
|
|
923
|
+
/** Format: date-time */
|
|
924
|
+
lastRequestTimestamp?: string;
|
|
925
|
+
/** @description If set to `true`, the application will be restarted. Valid only in combination with the `desiredState: "running"`. */
|
|
926
|
+
restartIfRunning?: boolean;
|
|
927
|
+
/** @description If set, the app will be updated to the specified configuration version. Valid only in combination with the `desiredState: "running", restartIfRunning: true`. */
|
|
928
|
+
configVersion?: string;
|
|
929
|
+
/** @description If set to `true`, latest package versions are installed during app startup, instead of using frozen versions. Valid only in combination with the `desiredState: "running", restartIfRunning: true`. */
|
|
930
|
+
updateDependencies?: boolean;
|
|
931
|
+
};
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
responses: {
|
|
935
|
+
/** @description OK */
|
|
936
|
+
200: {
|
|
937
|
+
headers: {
|
|
938
|
+
[name: string]: unknown;
|
|
939
|
+
};
|
|
940
|
+
content: {
|
|
941
|
+
'application/json': components['schemas']['ExistingApp'];
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
/** @description Unauthorized */
|
|
945
|
+
401: {
|
|
946
|
+
headers: {
|
|
947
|
+
[name: string]: unknown;
|
|
948
|
+
};
|
|
949
|
+
content?: never;
|
|
950
|
+
};
|
|
951
|
+
/** @description Forbidden */
|
|
952
|
+
403: {
|
|
953
|
+
headers: {
|
|
954
|
+
[name: string]: unknown;
|
|
955
|
+
};
|
|
956
|
+
content?: never;
|
|
957
|
+
};
|
|
958
|
+
/** @description Not Found */
|
|
959
|
+
404: {
|
|
960
|
+
headers: {
|
|
961
|
+
[name: string]: unknown;
|
|
962
|
+
};
|
|
963
|
+
content?: never;
|
|
964
|
+
};
|
|
965
|
+
/** @description Unprocessable Entity */
|
|
966
|
+
422: {
|
|
967
|
+
headers: {
|
|
968
|
+
[name: string]: unknown;
|
|
969
|
+
};
|
|
970
|
+
content?: never;
|
|
971
|
+
};
|
|
972
|
+
};
|
|
973
|
+
};
|
|
974
|
+
getAppProxyConfig: {
|
|
975
|
+
parameters: {
|
|
976
|
+
query?: never;
|
|
977
|
+
header?: {
|
|
978
|
+
'If-None-Match'?: string;
|
|
979
|
+
};
|
|
980
|
+
path: {
|
|
981
|
+
appId: string;
|
|
982
|
+
};
|
|
983
|
+
cookie?: never;
|
|
984
|
+
};
|
|
985
|
+
requestBody?: never;
|
|
986
|
+
responses: {
|
|
987
|
+
/** @description OK */
|
|
988
|
+
200: {
|
|
989
|
+
headers: {
|
|
990
|
+
/** @description Response content hash. Client should use this value in `If-None-Match` header in following requests to avoid unnecessary responses. */
|
|
991
|
+
ETag?: string;
|
|
992
|
+
/**
|
|
993
|
+
* @description Client should respect this header and cache the response for the specified time to avoid unnecessary requests.
|
|
994
|
+
* @example max-age=30
|
|
995
|
+
*/
|
|
996
|
+
'Cache-Control'?: string;
|
|
997
|
+
[name: string]: unknown;
|
|
998
|
+
};
|
|
999
|
+
content: {
|
|
1000
|
+
/**
|
|
1001
|
+
* @example {
|
|
1002
|
+
* "upstreamAppUrl": "http://data-app-123.sandbox.svc.cluster.local:8888",
|
|
1003
|
+
* "authProviders": [
|
|
1004
|
+
* {
|
|
1005
|
+
* "id": "okta",
|
|
1006
|
+
* "type": "oidc",
|
|
1007
|
+
* "allowedRoles": [
|
|
1008
|
+
* "user"
|
|
1009
|
+
* ],
|
|
1010
|
+
* "clientId": "foo",
|
|
1011
|
+
* "#clientSecret": "bar",
|
|
1012
|
+
* "issuerUrl": null
|
|
1013
|
+
* }
|
|
1014
|
+
* ],
|
|
1015
|
+
* "authRules": [
|
|
1016
|
+
* {
|
|
1017
|
+
* "type": "pathPrefix",
|
|
1018
|
+
* "value": "/",
|
|
1019
|
+
* "auth": [
|
|
1020
|
+
* "okta"
|
|
1021
|
+
* ]
|
|
1022
|
+
* }
|
|
1023
|
+
* ]
|
|
1024
|
+
* }
|
|
1025
|
+
*/
|
|
1026
|
+
'application/json': {
|
|
1027
|
+
appId: string;
|
|
1028
|
+
appName: string;
|
|
1029
|
+
projectId: string;
|
|
1030
|
+
upstreamAppUrl: string;
|
|
1031
|
+
authProviders: {
|
|
1032
|
+
[key: string]: {
|
|
1033
|
+
/** @description ID of the provider. Used to reference provider in `authRules`. Each provider ID must be unique. */
|
|
1034
|
+
id: string;
|
|
1035
|
+
type: string;
|
|
1036
|
+
allowedRoles?: string[];
|
|
1037
|
+
} & {
|
|
1038
|
+
[key: string]: unknown;
|
|
1039
|
+
};
|
|
1040
|
+
}[];
|
|
1041
|
+
authRules: ({
|
|
1042
|
+
type: string;
|
|
1043
|
+
auth: string[];
|
|
1044
|
+
} & {
|
|
1045
|
+
[key: string]: unknown;
|
|
1046
|
+
})[];
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
};
|
|
1050
|
+
/** @description Not Modified. Returned when `If-None-Match` header is specified and the value matches the current response content hash. If returned, client should use the previous cached response. */
|
|
1051
|
+
304: {
|
|
1052
|
+
headers: {
|
|
1053
|
+
/** @description Response content hash. Client should use this value in `If-None-Match` header in following requests to avoid unnecessary responses. */
|
|
1054
|
+
ETag?: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* @description Client should respect this header and cache the response for the specified time to avoid unnecessary requests.
|
|
1057
|
+
* @example max-age=30
|
|
1058
|
+
*/
|
|
1059
|
+
'Cache-Control'?: string;
|
|
1060
|
+
[name: string]: unknown;
|
|
1061
|
+
};
|
|
1062
|
+
content?: never;
|
|
1063
|
+
};
|
|
1064
|
+
/** @description Unauthorized */
|
|
1065
|
+
401: {
|
|
1066
|
+
headers: {
|
|
1067
|
+
[name: string]: unknown;
|
|
1068
|
+
};
|
|
1069
|
+
content?: never;
|
|
1070
|
+
};
|
|
1071
|
+
/** @description Forbidden */
|
|
1072
|
+
403: {
|
|
1073
|
+
headers: {
|
|
1074
|
+
[name: string]: unknown;
|
|
1075
|
+
};
|
|
1076
|
+
content?: never;
|
|
1077
|
+
};
|
|
1078
|
+
/** @description Not Found */
|
|
1079
|
+
404: {
|
|
1080
|
+
headers: {
|
|
1081
|
+
[name: string]: unknown;
|
|
1082
|
+
};
|
|
1083
|
+
content?: never;
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
};
|
|
1087
|
+
getAppPassword: {
|
|
1088
|
+
parameters: {
|
|
1089
|
+
query?: never;
|
|
1090
|
+
header?: never;
|
|
1091
|
+
path: {
|
|
1092
|
+
appId: string;
|
|
1093
|
+
};
|
|
1094
|
+
cookie?: never;
|
|
1095
|
+
};
|
|
1096
|
+
requestBody?: never;
|
|
1097
|
+
responses: {
|
|
1098
|
+
/** @description OK */
|
|
1099
|
+
200: {
|
|
1100
|
+
headers: {
|
|
1101
|
+
[name: string]: unknown;
|
|
1102
|
+
};
|
|
1103
|
+
content: {
|
|
1104
|
+
'application/json': {
|
|
1105
|
+
password?: string;
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
/** @description Unauthorized */
|
|
1110
|
+
401: {
|
|
1111
|
+
headers: {
|
|
1112
|
+
[name: string]: unknown;
|
|
1113
|
+
};
|
|
1114
|
+
content?: never;
|
|
1115
|
+
};
|
|
1116
|
+
/** @description Forbidden */
|
|
1117
|
+
403: {
|
|
1118
|
+
headers: {
|
|
1119
|
+
[name: string]: unknown;
|
|
1120
|
+
};
|
|
1121
|
+
content?: never;
|
|
1122
|
+
};
|
|
1123
|
+
/** @description Not Found */
|
|
1124
|
+
404: {
|
|
1125
|
+
headers: {
|
|
1126
|
+
[name: string]: unknown;
|
|
1127
|
+
};
|
|
1128
|
+
content?: never;
|
|
1129
|
+
};
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
resetAppPassword: {
|
|
1133
|
+
parameters: {
|
|
1134
|
+
query?: never;
|
|
1135
|
+
header?: never;
|
|
1136
|
+
path: {
|
|
1137
|
+
appId: string;
|
|
1138
|
+
};
|
|
1139
|
+
cookie?: never;
|
|
1140
|
+
};
|
|
1141
|
+
requestBody?: never;
|
|
1142
|
+
responses: {
|
|
1143
|
+
/** @description OK */
|
|
1144
|
+
200: {
|
|
1145
|
+
headers: {
|
|
1146
|
+
[name: string]: unknown;
|
|
1147
|
+
};
|
|
1148
|
+
content: {
|
|
1149
|
+
'application/json': components['schemas']['ExistingApp'];
|
|
1150
|
+
};
|
|
1151
|
+
};
|
|
1152
|
+
/** @description Unauthorized */
|
|
1153
|
+
401: {
|
|
1154
|
+
headers: {
|
|
1155
|
+
[name: string]: unknown;
|
|
1156
|
+
};
|
|
1157
|
+
content?: never;
|
|
1158
|
+
};
|
|
1159
|
+
/** @description Forbidden */
|
|
1160
|
+
403: {
|
|
1161
|
+
headers: {
|
|
1162
|
+
[name: string]: unknown;
|
|
1163
|
+
};
|
|
1164
|
+
content?: never;
|
|
1165
|
+
};
|
|
1166
|
+
/** @description Not Found */
|
|
1167
|
+
404: {
|
|
1168
|
+
headers: {
|
|
1169
|
+
[name: string]: unknown;
|
|
1170
|
+
};
|
|
1171
|
+
content?: never;
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
};
|
|
1175
|
+
downloadAppLogs: {
|
|
1176
|
+
parameters: {
|
|
1177
|
+
query?: never;
|
|
1178
|
+
header?: never;
|
|
1179
|
+
path: {
|
|
1180
|
+
appId: string;
|
|
1181
|
+
};
|
|
1182
|
+
cookie?: never;
|
|
1183
|
+
};
|
|
1184
|
+
requestBody?: never;
|
|
1185
|
+
responses: {
|
|
1186
|
+
/** @description OK */
|
|
1187
|
+
200: {
|
|
1188
|
+
headers: {
|
|
1189
|
+
[name: string]: unknown;
|
|
1190
|
+
};
|
|
1191
|
+
content: {
|
|
1192
|
+
'text/plain': string;
|
|
1193
|
+
};
|
|
1194
|
+
};
|
|
1195
|
+
/** @description Unauthorized */
|
|
1196
|
+
401: {
|
|
1197
|
+
headers: {
|
|
1198
|
+
[name: string]: unknown;
|
|
1199
|
+
};
|
|
1200
|
+
content?: never;
|
|
1201
|
+
};
|
|
1202
|
+
/** @description Forbidden */
|
|
1203
|
+
403: {
|
|
1204
|
+
headers: {
|
|
1205
|
+
[name: string]: unknown;
|
|
1206
|
+
};
|
|
1207
|
+
content?: never;
|
|
1208
|
+
};
|
|
1209
|
+
/** @description Not Found */
|
|
1210
|
+
404: {
|
|
1211
|
+
headers: {
|
|
1212
|
+
[name: string]: unknown;
|
|
1213
|
+
};
|
|
1214
|
+
content?: never;
|
|
1215
|
+
};
|
|
1216
|
+
};
|
|
1217
|
+
};
|
|
1218
|
+
tailAppLogs: {
|
|
1219
|
+
parameters: {
|
|
1220
|
+
query?: {
|
|
1221
|
+
since?: string;
|
|
1222
|
+
lines?: number;
|
|
1223
|
+
};
|
|
1224
|
+
header?: never;
|
|
1225
|
+
path: {
|
|
1226
|
+
appId: string;
|
|
1227
|
+
};
|
|
1228
|
+
cookie?: never;
|
|
1229
|
+
};
|
|
1230
|
+
requestBody?: never;
|
|
1231
|
+
responses: {
|
|
1232
|
+
/** @description OK */
|
|
1233
|
+
200: {
|
|
1234
|
+
headers: {
|
|
1235
|
+
[name: string]: unknown;
|
|
1236
|
+
};
|
|
1237
|
+
content: {
|
|
1238
|
+
'text/plain': string;
|
|
1239
|
+
};
|
|
1240
|
+
};
|
|
1241
|
+
/** @description Unauthorized */
|
|
1242
|
+
401: {
|
|
1243
|
+
headers: {
|
|
1244
|
+
[name: string]: unknown;
|
|
1245
|
+
};
|
|
1246
|
+
content?: never;
|
|
1247
|
+
};
|
|
1248
|
+
/** @description Forbidden */
|
|
1249
|
+
403: {
|
|
1250
|
+
headers: {
|
|
1251
|
+
[name: string]: unknown;
|
|
1252
|
+
};
|
|
1253
|
+
content?: never;
|
|
1254
|
+
};
|
|
1255
|
+
/** @description Not Found */
|
|
1256
|
+
404: {
|
|
1257
|
+
headers: {
|
|
1258
|
+
[name: string]: unknown;
|
|
1259
|
+
};
|
|
1260
|
+
content?: never;
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
};
|
|
1264
|
+
listAppRuns: {
|
|
1265
|
+
parameters: {
|
|
1266
|
+
query?: {
|
|
1267
|
+
offset?: number;
|
|
1268
|
+
limit?: number;
|
|
1269
|
+
};
|
|
1270
|
+
header?: never;
|
|
1271
|
+
path: {
|
|
1272
|
+
appId: string;
|
|
1273
|
+
};
|
|
1274
|
+
cookie?: never;
|
|
1275
|
+
};
|
|
1276
|
+
requestBody?: never;
|
|
1277
|
+
responses: {
|
|
1278
|
+
/** @description OK */
|
|
1279
|
+
200: {
|
|
1280
|
+
headers: {
|
|
1281
|
+
[name: string]: unknown;
|
|
1282
|
+
};
|
|
1283
|
+
content: {
|
|
1284
|
+
'application/json': components['schemas']['AppRun'][];
|
|
1285
|
+
};
|
|
1286
|
+
};
|
|
1287
|
+
/** @description Unauthorized */
|
|
1288
|
+
401: {
|
|
1289
|
+
headers: {
|
|
1290
|
+
[name: string]: unknown;
|
|
1291
|
+
};
|
|
1292
|
+
content?: never;
|
|
1293
|
+
};
|
|
1294
|
+
/** @description Forbidden */
|
|
1295
|
+
403: {
|
|
1296
|
+
headers: {
|
|
1297
|
+
[name: string]: unknown;
|
|
1298
|
+
};
|
|
1299
|
+
content?: never;
|
|
1300
|
+
};
|
|
1301
|
+
/** @description Not Found */
|
|
1302
|
+
404: {
|
|
1303
|
+
headers: {
|
|
1304
|
+
[name: string]: unknown;
|
|
1305
|
+
};
|
|
1306
|
+
content?: never;
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
};
|
|
1310
|
+
getAppRun: {
|
|
1311
|
+
parameters: {
|
|
1312
|
+
query?: never;
|
|
1313
|
+
header?: never;
|
|
1314
|
+
path: {
|
|
1315
|
+
appId: string;
|
|
1316
|
+
runId: string;
|
|
1317
|
+
};
|
|
1318
|
+
cookie?: never;
|
|
1319
|
+
};
|
|
1320
|
+
requestBody?: never;
|
|
1321
|
+
responses: {
|
|
1322
|
+
/** @description OK */
|
|
1323
|
+
200: {
|
|
1324
|
+
headers: {
|
|
1325
|
+
[name: string]: unknown;
|
|
1326
|
+
};
|
|
1327
|
+
content: {
|
|
1328
|
+
'application/json': components['schemas']['AppRun'];
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
/** @description Unauthorized */
|
|
1332
|
+
401: {
|
|
1333
|
+
headers: {
|
|
1334
|
+
[name: string]: unknown;
|
|
1335
|
+
};
|
|
1336
|
+
content?: never;
|
|
1337
|
+
};
|
|
1338
|
+
/** @description Forbidden */
|
|
1339
|
+
403: {
|
|
1340
|
+
headers: {
|
|
1341
|
+
[name: string]: unknown;
|
|
1342
|
+
};
|
|
1343
|
+
content?: never;
|
|
1344
|
+
};
|
|
1345
|
+
/** @description Not Found */
|
|
1346
|
+
404: {
|
|
1347
|
+
headers: {
|
|
1348
|
+
[name: string]: unknown;
|
|
1349
|
+
};
|
|
1350
|
+
content?: never;
|
|
1351
|
+
};
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
createSandbox: {
|
|
1355
|
+
parameters: {
|
|
1356
|
+
query?: never;
|
|
1357
|
+
header?: never;
|
|
1358
|
+
path?: never;
|
|
1359
|
+
cookie?: never;
|
|
1360
|
+
};
|
|
1361
|
+
requestBody: {
|
|
1362
|
+
content: {
|
|
1363
|
+
'application/json': {
|
|
1364
|
+
/** @description Keboola component ID (e.g. keboola.sandboxes) */
|
|
1365
|
+
componentId: string;
|
|
1366
|
+
/** @description Keboola configuration ID */
|
|
1367
|
+
configurationId: string;
|
|
1368
|
+
/** @description Configuration version to use. If omitted, the latest version is resolved automatically. */
|
|
1369
|
+
configurationVersion?: string;
|
|
1370
|
+
/**
|
|
1371
|
+
* @description Sandbox type
|
|
1372
|
+
* @enum {string}
|
|
1373
|
+
*/
|
|
1374
|
+
type: 'python' | 'r' | 'snowflake' | 'bigquery' | 'streamlit' | 'python-js';
|
|
1375
|
+
/** @description Physical identifier of the underlying resource (e.g. Snowflake schema name) */
|
|
1376
|
+
physicalId?: string;
|
|
1377
|
+
/** @description Hostname of the underlying resource */
|
|
1378
|
+
host: string;
|
|
1379
|
+
/** @enum {string|null} */
|
|
1380
|
+
size?: 'micro' | 'tiny' | 'small' | 'medium' | 'large' | null;
|
|
1381
|
+
branchId?: string | null;
|
|
1382
|
+
user?: string | null;
|
|
1383
|
+
password?: string | null;
|
|
1384
|
+
url?: string | null;
|
|
1385
|
+
active?: boolean;
|
|
1386
|
+
shared?: boolean;
|
|
1387
|
+
imageVersion?: string | null;
|
|
1388
|
+
/** @deprecated */
|
|
1389
|
+
packages?: string[];
|
|
1390
|
+
autoSuspendAfterSeconds?: number | null;
|
|
1391
|
+
} & {
|
|
1392
|
+
[key: string]: unknown;
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
};
|
|
1396
|
+
responses: {
|
|
1397
|
+
/** @description Sandbox created successfully */
|
|
1398
|
+
201: {
|
|
1399
|
+
headers: {
|
|
1400
|
+
[name: string]: unknown;
|
|
1401
|
+
};
|
|
1402
|
+
content: {
|
|
1403
|
+
'application/json': components['schemas']['SandboxResponse'];
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
/** @description Unauthorized */
|
|
1407
|
+
401: {
|
|
1408
|
+
headers: {
|
|
1409
|
+
[name: string]: unknown;
|
|
1410
|
+
};
|
|
1411
|
+
content?: never;
|
|
1412
|
+
};
|
|
1413
|
+
/** @description Forbidden */
|
|
1414
|
+
403: {
|
|
1415
|
+
headers: {
|
|
1416
|
+
[name: string]: unknown;
|
|
1417
|
+
};
|
|
1418
|
+
content?: never;
|
|
1419
|
+
};
|
|
1420
|
+
/** @description Unprocessable Entity */
|
|
1421
|
+
422: {
|
|
1422
|
+
headers: {
|
|
1423
|
+
[name: string]: unknown;
|
|
1424
|
+
};
|
|
1425
|
+
content?: never;
|
|
1426
|
+
};
|
|
1427
|
+
};
|
|
1428
|
+
};
|
|
1429
|
+
getSandbox: {
|
|
1430
|
+
parameters: {
|
|
1431
|
+
query?: never;
|
|
1432
|
+
header?: never;
|
|
1433
|
+
path: {
|
|
1434
|
+
appId: string;
|
|
1435
|
+
};
|
|
1436
|
+
cookie?: never;
|
|
1437
|
+
};
|
|
1438
|
+
requestBody?: never;
|
|
1439
|
+
responses: {
|
|
1440
|
+
/** @description OK */
|
|
1441
|
+
200: {
|
|
1442
|
+
headers: {
|
|
1443
|
+
[name: string]: unknown;
|
|
1444
|
+
};
|
|
1445
|
+
content: {
|
|
1446
|
+
'application/json': components['schemas']['SandboxResponse'];
|
|
1447
|
+
};
|
|
1448
|
+
};
|
|
1449
|
+
/** @description Unauthorized */
|
|
1450
|
+
401: {
|
|
1451
|
+
headers: {
|
|
1452
|
+
[name: string]: unknown;
|
|
1453
|
+
};
|
|
1454
|
+
content?: never;
|
|
1455
|
+
};
|
|
1456
|
+
/** @description Forbidden */
|
|
1457
|
+
403: {
|
|
1458
|
+
headers: {
|
|
1459
|
+
[name: string]: unknown;
|
|
1460
|
+
};
|
|
1461
|
+
content?: never;
|
|
1462
|
+
};
|
|
1463
|
+
/** @description Sandbox not found */
|
|
1464
|
+
404: {
|
|
1465
|
+
headers: {
|
|
1466
|
+
[name: string]: unknown;
|
|
1467
|
+
};
|
|
1468
|
+
content?: never;
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
deleteSandbox: {
|
|
1473
|
+
parameters: {
|
|
1474
|
+
query?: never;
|
|
1475
|
+
header?: never;
|
|
1476
|
+
path: {
|
|
1477
|
+
appId: string;
|
|
1478
|
+
};
|
|
1479
|
+
cookie?: never;
|
|
1480
|
+
};
|
|
1481
|
+
requestBody?: never;
|
|
1482
|
+
responses: {
|
|
1483
|
+
/** @description Sandbox deleted successfully */
|
|
1484
|
+
204: {
|
|
1485
|
+
headers: {
|
|
1486
|
+
[name: string]: unknown;
|
|
1487
|
+
};
|
|
1488
|
+
content?: never;
|
|
1489
|
+
};
|
|
1490
|
+
/** @description Unauthorized */
|
|
1491
|
+
401: {
|
|
1492
|
+
headers: {
|
|
1493
|
+
[name: string]: unknown;
|
|
1494
|
+
};
|
|
1495
|
+
content?: never;
|
|
1496
|
+
};
|
|
1497
|
+
/** @description Forbidden */
|
|
1498
|
+
403: {
|
|
1499
|
+
headers: {
|
|
1500
|
+
[name: string]: unknown;
|
|
1501
|
+
};
|
|
1502
|
+
content?: never;
|
|
1503
|
+
};
|
|
1504
|
+
/** @description Sandbox not found */
|
|
1505
|
+
404: {
|
|
1506
|
+
headers: {
|
|
1507
|
+
[name: string]: unknown;
|
|
1508
|
+
};
|
|
1509
|
+
content?: never;
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
};
|
|
1513
|
+
patchSandbox: {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query?: never;
|
|
1516
|
+
header?: never;
|
|
1517
|
+
path: {
|
|
1518
|
+
appId: string;
|
|
1519
|
+
};
|
|
1520
|
+
cookie?: never;
|
|
1521
|
+
};
|
|
1522
|
+
requestBody: {
|
|
1523
|
+
content: {
|
|
1524
|
+
'application/json': {
|
|
1525
|
+
configurationVersion: string;
|
|
1526
|
+
active?: boolean | null;
|
|
1527
|
+
url?: string | null;
|
|
1528
|
+
expirationAfterHours?: number | null;
|
|
1529
|
+
autoSuspendAfterSeconds?: number | null;
|
|
1530
|
+
password?: string | null;
|
|
1531
|
+
/** @description Persistent volume claim data; populated by the sandboxes component after PVC provisioning. */
|
|
1532
|
+
persistentStorage?: {
|
|
1533
|
+
/** @description Name of the PVC in Kubernetes (e.g. "sandbox-123"). */
|
|
1534
|
+
pvcName?: string | null;
|
|
1535
|
+
/** @description Serialized YAML of the PVC Kubernetes manifest. */
|
|
1536
|
+
k8sManifest?: string | null;
|
|
1537
|
+
/** @description Whether persistent storage is enabled for this sandbox. */
|
|
1538
|
+
isEnabled?: boolean;
|
|
1539
|
+
/** @description Whether the project-level persistent storage is ready. */
|
|
1540
|
+
ready?: boolean | null;
|
|
1541
|
+
/** @description Kubernetes StorageClass name for the project's persistent storage. */
|
|
1542
|
+
k8sStorageClassName?: string | null;
|
|
1543
|
+
} | null;
|
|
1544
|
+
/** @description Size parameters for the sandbox; used to store the PVC storage size. */
|
|
1545
|
+
sizeParameters?: {
|
|
1546
|
+
/** @description PVC storage size in GB. */
|
|
1547
|
+
storageSize_GB?: number | null;
|
|
1548
|
+
} | null;
|
|
1549
|
+
} & {
|
|
1550
|
+
[key: string]: unknown;
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
responses: {
|
|
1555
|
+
/** @description Sandbox updated successfully. */
|
|
1556
|
+
200: {
|
|
1557
|
+
headers: {
|
|
1558
|
+
[name: string]: unknown;
|
|
1559
|
+
};
|
|
1560
|
+
content: {
|
|
1561
|
+
'application/json': components['schemas']['SandboxResponse'];
|
|
1562
|
+
};
|
|
1563
|
+
};
|
|
1564
|
+
/** @description Unauthorized */
|
|
1565
|
+
401: {
|
|
1566
|
+
headers: {
|
|
1567
|
+
[name: string]: unknown;
|
|
1568
|
+
};
|
|
1569
|
+
content?: never;
|
|
1570
|
+
};
|
|
1571
|
+
/** @description Forbidden */
|
|
1572
|
+
403: {
|
|
1573
|
+
headers: {
|
|
1574
|
+
[name: string]: unknown;
|
|
1575
|
+
};
|
|
1576
|
+
content?: never;
|
|
1577
|
+
};
|
|
1578
|
+
/** @description Sandbox not found */
|
|
1579
|
+
404: {
|
|
1580
|
+
headers: {
|
|
1581
|
+
[name: string]: unknown;
|
|
1582
|
+
};
|
|
1583
|
+
content?: never;
|
|
1584
|
+
};
|
|
1585
|
+
/** @description Unprocessable Entity */
|
|
1586
|
+
422: {
|
|
1587
|
+
headers: {
|
|
1588
|
+
[name: string]: unknown;
|
|
1589
|
+
};
|
|
1590
|
+
content?: never;
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
};
|
|
1594
|
+
listRuntimes: {
|
|
1595
|
+
parameters: {
|
|
1596
|
+
query?: {
|
|
1597
|
+
type?: string;
|
|
1598
|
+
includeExpired?: boolean;
|
|
1599
|
+
limit?: number;
|
|
1600
|
+
offset?: number;
|
|
1601
|
+
};
|
|
1602
|
+
header?: never;
|
|
1603
|
+
path?: never;
|
|
1604
|
+
cookie?: never;
|
|
1605
|
+
};
|
|
1606
|
+
requestBody?: never;
|
|
1607
|
+
responses: {
|
|
1608
|
+
/** @description OK */
|
|
1609
|
+
200: {
|
|
1610
|
+
headers: {
|
|
1611
|
+
[name: string]: unknown;
|
|
1612
|
+
};
|
|
1613
|
+
content: {
|
|
1614
|
+
'application/json': components['schemas']['Runtime'][];
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
|
|
1621
|
+
type GetAppsQuery = OpenapiQueryType<paths['/apps']['get']>;
|
|
1622
|
+
type CreateDataAppBody = OpenapiBodyType<paths['/apps']['post']>;
|
|
1623
|
+
type GetDataAppPath = OpenapiPathType<paths['/apps/{appId}']['get']>;
|
|
1624
|
+
type DeleteDataAppPath = OpenapiPathType<paths['/apps/{appId}']['delete']>;
|
|
1625
|
+
type GetDataAppPasswordPath = OpenapiPathType<paths['/apps/{appId}/password']['get']>;
|
|
1626
|
+
type ResetDataAppPasswordPath = OpenapiPathType<paths['/apps/{appId}/reset-password']['post']>;
|
|
1627
|
+
type GetDataAppRunsPath = OpenapiPathType<paths['/apps/{appId}/runs']['get']>;
|
|
1628
|
+
type GetDataAppRunsQuery = OpenapiQueryType<paths['/apps/{appId}/runs']['get']>;
|
|
1629
|
+
type GetDataAppRunPath = OpenapiPathType<paths['/apps/{appId}/runs/{runId}']['get']>;
|
|
1630
|
+
type RawAppRun = OpenapiReturnType<paths['/apps/{appId}/runs']['get']>[number];
|
|
1631
|
+
type DataAppRun = Omit<RawAppRun, 'state'> & {
|
|
1632
|
+
state: 'running' | 'failed' | 'starting' | 'finished';
|
|
1633
|
+
};
|
|
1634
|
+
type GetDataAppLogsDownloadPath = OpenapiPathType<paths['/apps/{appId}/logs/download']['get']>;
|
|
1635
|
+
type GetDataAppLogsTailPath = OpenapiPathType<paths['/apps/{appId}/logs/tail']['get']>;
|
|
1636
|
+
type GetDataAppLogsTailQuery = OpenapiQueryType<paths['/apps/{appId}/logs/tail']['get']>;
|
|
1637
|
+
type GetSandboxPath = OpenapiPathType<paths['/sandboxes/{appId}']['get']>;
|
|
1638
|
+
type DataApp = OpenapiReturnType<paths['/apps/{appId}']['get']>;
|
|
1639
|
+
type Sandbox = OpenapiReturnType<paths['/sandboxes/{appId}']['get']>;
|
|
1640
|
+
type Runtime = OpenapiReturnType<paths['/runtimes']['get']>[number];
|
|
1641
|
+
type RuntimeImageKey = Extract<keyof Runtime, 'imageTag' | 'sandboxImageTag' | 'transformationComponentTag'>;
|
|
1642
|
+
type PatchDataAppPath = OpenapiPathType<paths['/apps/{appId}']['patch']>;
|
|
1643
|
+
type PatchDataAppBodyRunning = {
|
|
1644
|
+
desiredState: 'running';
|
|
1645
|
+
} & Omit<OpenapiBodyType<paths['/apps/{appId}']['patch']>, 'desiredState'>;
|
|
1646
|
+
type PatchDataAppBodyStopped = {
|
|
1647
|
+
desiredState: 'stopped';
|
|
1648
|
+
};
|
|
1649
|
+
type PatchDataAppBody = PatchDataAppBodyRunning | PatchDataAppBodyStopped;
|
|
1650
|
+
|
|
1651
|
+
type LogEntry = {
|
|
1652
|
+
timestamp: string | null;
|
|
1653
|
+
message: string;
|
|
1654
|
+
};
|
|
1655
|
+
declare const parseLogLines: (raw: unknown) => LogEntry[];
|
|
1656
|
+
|
|
1657
|
+
export { type CreateDataAppBody as C, type DeleteDataAppPath as D, type GetDataAppRunsPath as G, type LogEntry as L, type PatchDataAppPath as P, type ResetDataAppPasswordPath as R, type Sandbox as S, type GetDataAppRunsQuery as a, type GetDataAppRunPath as b, type GetDataAppLogsDownloadPath as c, type GetDataAppLogsTailPath as d, type GetDataAppLogsTailQuery as e, type GetAppsQuery as f, type GetDataAppPath as g, type PatchDataAppBody as h, type GetDataAppPasswordPath as i, type GetSandboxPath as j, type DataApp as k, type DataAppRun as l, type RawAppRun as m, type Runtime as n, type RuntimeImageKey as o, parseLogLines as p };
|