@knowledge-stack/ksapi 1.111.0 → 1.112.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/.openapi-generator/FILES +6 -0
- package/README.md +6 -2
- package/dist/apis/DataSourcesApi.d.ts +46 -5
- package/dist/apis/DataSourcesApi.js +53 -2
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/WorkflowDefinitionsApi.d.ts +6 -0
- package/dist/apis/WorkflowDefinitionsApi.js +6 -0
- package/dist/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/apis/WorkflowRunsApi.js +2 -2
- package/dist/esm/apis/DataSourcesApi.d.ts +46 -5
- package/dist/esm/apis/DataSourcesApi.js +54 -3
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +6 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.js +6 -0
- package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/esm/apis/WorkflowRunsApi.js +2 -2
- package/dist/esm/models/CatalogColumnResponse.d.ts +7 -0
- package/dist/esm/models/CatalogColumnResponse.js +3 -0
- package/dist/esm/models/CatalogTableResponse.d.ts +6 -0
- package/dist/esm/models/CatalogTableResponse.js +4 -0
- package/dist/esm/models/ColumnConfig.d.ts +7 -0
- package/dist/esm/models/ColumnConfig.js +3 -0
- package/dist/esm/models/ColumnReference.d.ts +59 -0
- package/dist/esm/models/ColumnReference.js +50 -0
- package/dist/esm/models/DataSourceSchemaListResponse.d.ts +48 -0
- package/dist/esm/models/DataSourceSchemaListResponse.js +45 -0
- package/dist/esm/models/DataSourceSchemaResponse.d.ts +53 -0
- package/dist/esm/models/DataSourceSchemaResponse.js +48 -0
- package/dist/esm/models/DataSourceTableResponse.d.ts +6 -0
- package/dist/esm/models/DataSourceTableResponse.js +2 -0
- package/dist/esm/models/ModelTableRequest.d.ts +6 -0
- package/dist/esm/models/ModelTableRequest.js +2 -0
- package/dist/esm/models/UpdateWorkflowRunRequest.d.ts +12 -0
- package/dist/esm/models/UpdateWorkflowRunRequest.js +7 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +12 -0
- package/dist/esm/models/WorkflowRunResponse.js +6 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/CatalogColumnResponse.d.ts +7 -0
- package/dist/models/CatalogColumnResponse.js +3 -0
- package/dist/models/CatalogTableResponse.d.ts +6 -0
- package/dist/models/CatalogTableResponse.js +4 -0
- package/dist/models/ColumnConfig.d.ts +7 -0
- package/dist/models/ColumnConfig.js +3 -0
- package/dist/models/ColumnReference.d.ts +59 -0
- package/dist/models/ColumnReference.js +58 -0
- package/dist/models/DataSourceSchemaListResponse.d.ts +48 -0
- package/dist/models/DataSourceSchemaListResponse.js +53 -0
- package/dist/models/DataSourceSchemaResponse.d.ts +53 -0
- package/dist/models/DataSourceSchemaResponse.js +56 -0
- package/dist/models/DataSourceTableResponse.d.ts +6 -0
- package/dist/models/DataSourceTableResponse.js +2 -0
- package/dist/models/ModelTableRequest.d.ts +6 -0
- package/dist/models/ModelTableRequest.js +2 -0
- package/dist/models/UpdateWorkflowRunRequest.d.ts +12 -0
- package/dist/models/UpdateWorkflowRunRequest.js +7 -0
- package/dist/models/WorkflowRunResponse.d.ts +12 -0
- package/dist/models/WorkflowRunResponse.js +6 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/CatalogColumnResponse.md +2 -0
- package/docs/CatalogTableResponse.md +2 -0
- package/docs/ColumnConfig.md +2 -0
- package/docs/ColumnReference.md +39 -0
- package/docs/DataSourceSchemaListResponse.md +35 -0
- package/docs/DataSourceSchemaResponse.md +36 -0
- package/docs/DataSourceTableResponse.md +2 -0
- package/docs/DataSourcesApi.md +81 -2
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md +6 -0
- package/docs/ModelTableRequest.md +2 -0
- package/docs/UpdateWorkflowRunRequest.md +4 -0
- package/docs/WorkflowDefinitionsApi.md +7 -1
- package/docs/WorkflowRunResponse.md +4 -0
- package/docs/WorkflowRunsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/DataSourcesApi.ts +97 -4
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/WorkflowDefinitionsApi.ts +14 -0
- package/src/apis/WorkflowRunsApi.ts +4 -4
- package/src/models/CatalogColumnResponse.ts +16 -0
- package/src/models/CatalogTableResponse.ts +9 -0
- package/src/models/ColumnConfig.ts +16 -0
- package/src/models/ColumnReference.ts +100 -0
- package/src/models/DataSourceSchemaListResponse.ts +91 -0
- package/src/models/DataSourceSchemaResponse.ts +92 -0
- package/src/models/DataSourceTableResponse.ts +8 -0
- package/src/models/ModelTableRequest.ts +8 -0
- package/src/models/UpdateWorkflowRunRequest.ts +19 -0
- package/src/models/WorkflowRunResponse.ts +17 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -49,6 +49,7 @@ docs/CitedChunk.md
|
|
|
49
49
|
docs/ClearVersionContentsResponse.md
|
|
50
50
|
docs/CloneWorkflowRunRequest.md
|
|
51
51
|
docs/ColumnConfig.md
|
|
52
|
+
docs/ColumnReference.md
|
|
52
53
|
docs/ConnectionConfig.md
|
|
53
54
|
docs/CreateApiConnectionRequest.md
|
|
54
55
|
docs/CreateApiKeyRequest.md
|
|
@@ -74,6 +75,8 @@ docs/DataSourceEngine.md
|
|
|
74
75
|
docs/DataSourceQueryRequest.md
|
|
75
76
|
docs/DataSourceQueryResponse.md
|
|
76
77
|
docs/DataSourceResponse.md
|
|
78
|
+
docs/DataSourceSchemaListResponse.md
|
|
79
|
+
docs/DataSourceSchemaResponse.md
|
|
77
80
|
docs/DataSourceTableResponse.md
|
|
78
81
|
docs/DataSourcesApi.md
|
|
79
82
|
docs/DefaultApi.md
|
|
@@ -405,6 +408,7 @@ src/models/CitedChunk.ts
|
|
|
405
408
|
src/models/ClearVersionContentsResponse.ts
|
|
406
409
|
src/models/CloneWorkflowRunRequest.ts
|
|
407
410
|
src/models/ColumnConfig.ts
|
|
411
|
+
src/models/ColumnReference.ts
|
|
408
412
|
src/models/ConnectionConfig.ts
|
|
409
413
|
src/models/CreateApiConnectionRequest.ts
|
|
410
414
|
src/models/CreateApiKeyRequest.ts
|
|
@@ -430,6 +434,8 @@ src/models/DataSourceEngine.ts
|
|
|
430
434
|
src/models/DataSourceQueryRequest.ts
|
|
431
435
|
src/models/DataSourceQueryResponse.ts
|
|
432
436
|
src/models/DataSourceResponse.ts
|
|
437
|
+
src/models/DataSourceSchemaListResponse.ts
|
|
438
|
+
src/models/DataSourceSchemaResponse.ts
|
|
433
439
|
src/models/DataSourceTableResponse.ts
|
|
434
440
|
src/models/DiffFormat.ts
|
|
435
441
|
src/models/DiffRow.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.112.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -104,6 +104,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
104
104
|
*DataSourcesApi* | [**deleteDataSource**](docs/DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler
|
|
105
105
|
*DataSourcesApi* | [**getDataSource**](docs/DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler
|
|
106
106
|
*DataSourcesApi* | [**getDataSourceCatalog**](docs/DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler
|
|
107
|
+
*DataSourcesApi* | [**listDataSourceSchemas**](docs/DataSourcesApi.md#listdatasourceschemas) | **GET** /v1/data-sources/{data_source_id}/schemas | List Data Source Schemas Handler
|
|
107
108
|
*DataSourcesApi* | [**modelDataSourceTable**](docs/DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler
|
|
108
109
|
*DataSourcesApi* | [**queryDataSource**](docs/DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler
|
|
109
110
|
*DataSourcesApi* | [**testDataSourceConnection**](docs/DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler
|
|
@@ -300,6 +301,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
300
301
|
- [ClearVersionContentsResponse](docs/ClearVersionContentsResponse.md)
|
|
301
302
|
- [CloneWorkflowRunRequest](docs/CloneWorkflowRunRequest.md)
|
|
302
303
|
- [ColumnConfig](docs/ColumnConfig.md)
|
|
304
|
+
- [ColumnReference](docs/ColumnReference.md)
|
|
303
305
|
- [ConnectionConfig](docs/ConnectionConfig.md)
|
|
304
306
|
- [CreateApiConnectionRequest](docs/CreateApiConnectionRequest.md)
|
|
305
307
|
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
@@ -325,6 +327,8 @@ All URIs are relative to *http://localhost:8000*
|
|
|
325
327
|
- [DataSourceQueryRequest](docs/DataSourceQueryRequest.md)
|
|
326
328
|
- [DataSourceQueryResponse](docs/DataSourceQueryResponse.md)
|
|
327
329
|
- [DataSourceResponse](docs/DataSourceResponse.md)
|
|
330
|
+
- [DataSourceSchemaListResponse](docs/DataSourceSchemaListResponse.md)
|
|
331
|
+
- [DataSourceSchemaResponse](docs/DataSourceSchemaResponse.md)
|
|
328
332
|
- [DataSourceTableResponse](docs/DataSourceTableResponse.md)
|
|
329
333
|
- [DiffFormat](docs/DiffFormat.md)
|
|
330
334
|
- [DiffRow](docs/DiffRow.md)
|
|
@@ -577,7 +581,7 @@ and is automatically generated by the
|
|
|
577
581
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
578
582
|
|
|
579
583
|
- API version: `0.1.0`
|
|
580
|
-
- Package version: `1.
|
|
584
|
+
- Package version: `1.112.0`
|
|
581
585
|
- Generator version: `7.21.0`
|
|
582
586
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
583
587
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
|
|
13
|
+
import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
|
|
14
14
|
export interface CreateDataSourceOperationRequest {
|
|
15
15
|
createDataSourceRequest: CreateDataSourceRequest;
|
|
16
16
|
}
|
|
@@ -22,6 +22,10 @@ export interface GetDataSourceRequest {
|
|
|
22
22
|
}
|
|
23
23
|
export interface GetDataSourceCatalogRequest {
|
|
24
24
|
dataSourceId: string;
|
|
25
|
+
schema?: string | null;
|
|
26
|
+
}
|
|
27
|
+
export interface ListDataSourceSchemasRequest {
|
|
28
|
+
dataSourceId: string;
|
|
25
29
|
}
|
|
26
30
|
export interface ModelDataSourceTableRequest {
|
|
27
31
|
dataSourceId: string;
|
|
@@ -112,24 +116,47 @@ export interface DataSourcesApiInterface {
|
|
|
112
116
|
/**
|
|
113
117
|
* Creates request options for getDataSourceCatalog without sending the request
|
|
114
118
|
* @param {string} dataSourceId
|
|
119
|
+
* @param {string} [schema] Schema/namespace to introspect (default: connection default)
|
|
115
120
|
* @throws {RequiredError}
|
|
116
121
|
* @memberof DataSourcesApiInterface
|
|
117
122
|
*/
|
|
118
123
|
getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
|
|
119
124
|
/**
|
|
120
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
125
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
121
126
|
* @summary Get Data Source Catalog Handler
|
|
122
127
|
* @param {string} dataSourceId
|
|
128
|
+
* @param {string} [schema] Schema/namespace to introspect (default: connection default)
|
|
123
129
|
* @param {*} [options] Override http request option.
|
|
124
130
|
* @throws {RequiredError}
|
|
125
131
|
* @memberof DataSourcesApiInterface
|
|
126
132
|
*/
|
|
127
133
|
getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
|
|
128
134
|
/**
|
|
129
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
135
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
130
136
|
* Get Data Source Catalog Handler
|
|
131
137
|
*/
|
|
132
138
|
getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
141
|
+
* @param {string} dataSourceId
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
* @memberof DataSourcesApiInterface
|
|
144
|
+
*/
|
|
145
|
+
listDataSourceSchemasRequestOpts(requestParameters: ListDataSourceSchemasRequest): Promise<runtime.RequestOpts>;
|
|
146
|
+
/**
|
|
147
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
148
|
+
* @summary List Data Source Schemas Handler
|
|
149
|
+
* @param {string} dataSourceId
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
* @memberof DataSourcesApiInterface
|
|
153
|
+
*/
|
|
154
|
+
listDataSourceSchemasRaw(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSchemaListResponse>>;
|
|
155
|
+
/**
|
|
156
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
157
|
+
* List Data Source Schemas Handler
|
|
158
|
+
*/
|
|
159
|
+
listDataSourceSchemas(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSchemaListResponse>;
|
|
133
160
|
/**
|
|
134
161
|
* Creates request options for modelDataSourceTable without sending the request
|
|
135
162
|
* @param {string} dataSourceId
|
|
@@ -274,15 +301,29 @@ export declare class DataSourcesApi extends runtime.BaseAPI implements DataSourc
|
|
|
274
301
|
*/
|
|
275
302
|
getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
|
|
276
303
|
/**
|
|
277
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
304
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
278
305
|
* Get Data Source Catalog Handler
|
|
279
306
|
*/
|
|
280
307
|
getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
|
|
281
308
|
/**
|
|
282
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
309
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
283
310
|
* Get Data Source Catalog Handler
|
|
284
311
|
*/
|
|
285
312
|
getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
315
|
+
*/
|
|
316
|
+
listDataSourceSchemasRequestOpts(requestParameters: ListDataSourceSchemasRequest): Promise<runtime.RequestOpts>;
|
|
317
|
+
/**
|
|
318
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
319
|
+
* List Data Source Schemas Handler
|
|
320
|
+
*/
|
|
321
|
+
listDataSourceSchemasRaw(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSchemaListResponse>>;
|
|
322
|
+
/**
|
|
323
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
324
|
+
* List Data Source Schemas Handler
|
|
325
|
+
*/
|
|
326
|
+
listDataSourceSchemas(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSchemaListResponse>;
|
|
286
327
|
/**
|
|
287
328
|
* Creates request options for modelDataSourceTable without sending the request
|
|
288
329
|
*/
|
|
@@ -215,6 +215,9 @@ class DataSourcesApi extends runtime.BaseAPI {
|
|
|
215
215
|
throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling getDataSourceCatalog().');
|
|
216
216
|
}
|
|
217
217
|
const queryParameters = {};
|
|
218
|
+
if (requestParameters['schema'] != null) {
|
|
219
|
+
queryParameters['schema'] = requestParameters['schema'];
|
|
220
|
+
}
|
|
218
221
|
const headerParameters = {};
|
|
219
222
|
if (this.configuration && this.configuration.accessToken) {
|
|
220
223
|
const token = this.configuration.accessToken;
|
|
@@ -234,7 +237,7 @@ class DataSourcesApi extends runtime.BaseAPI {
|
|
|
234
237
|
});
|
|
235
238
|
}
|
|
236
239
|
/**
|
|
237
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
240
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
238
241
|
* Get Data Source Catalog Handler
|
|
239
242
|
*/
|
|
240
243
|
getDataSourceCatalogRaw(requestParameters, initOverrides) {
|
|
@@ -245,7 +248,7 @@ class DataSourcesApi extends runtime.BaseAPI {
|
|
|
245
248
|
});
|
|
246
249
|
}
|
|
247
250
|
/**
|
|
248
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
251
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
249
252
|
* Get Data Source Catalog Handler
|
|
250
253
|
*/
|
|
251
254
|
getDataSourceCatalog(requestParameters, initOverrides) {
|
|
@@ -254,6 +257,54 @@ class DataSourcesApi extends runtime.BaseAPI {
|
|
|
254
257
|
return yield response.value();
|
|
255
258
|
});
|
|
256
259
|
}
|
|
260
|
+
/**
|
|
261
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
262
|
+
*/
|
|
263
|
+
listDataSourceSchemasRequestOpts(requestParameters) {
|
|
264
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
265
|
+
if (requestParameters['dataSourceId'] == null) {
|
|
266
|
+
throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling listDataSourceSchemas().');
|
|
267
|
+
}
|
|
268
|
+
const queryParameters = {};
|
|
269
|
+
const headerParameters = {};
|
|
270
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
271
|
+
const token = this.configuration.accessToken;
|
|
272
|
+
const tokenString = yield token("bearerAuth", []);
|
|
273
|
+
if (tokenString) {
|
|
274
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
let urlPath = `/v1/data-sources/{data_source_id}/schemas`;
|
|
278
|
+
urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
|
|
279
|
+
return {
|
|
280
|
+
path: urlPath,
|
|
281
|
+
method: 'GET',
|
|
282
|
+
headers: headerParameters,
|
|
283
|
+
query: queryParameters,
|
|
284
|
+
};
|
|
285
|
+
});
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
289
|
+
* List Data Source Schemas Handler
|
|
290
|
+
*/
|
|
291
|
+
listDataSourceSchemasRaw(requestParameters, initOverrides) {
|
|
292
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
293
|
+
const requestOptions = yield this.listDataSourceSchemasRequestOpts(requestParameters);
|
|
294
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
295
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DataSourceSchemaListResponseFromJSON)(jsonValue));
|
|
296
|
+
});
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
300
|
+
* List Data Source Schemas Handler
|
|
301
|
+
*/
|
|
302
|
+
listDataSourceSchemas(requestParameters, initOverrides) {
|
|
303
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
304
|
+
const response = yield this.listDataSourceSchemasRaw(requestParameters, initOverrides);
|
|
305
|
+
return yield response.value();
|
|
306
|
+
});
|
|
307
|
+
}
|
|
257
308
|
/**
|
|
258
309
|
* Creates request options for modelDataSourceTable without sending the request
|
|
259
310
|
*/
|
|
@@ -297,7 +297,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
297
297
|
*/
|
|
298
298
|
updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
|
|
299
299
|
/**
|
|
300
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
300
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
301
301
|
* @summary Update Document Version Metadata Handler
|
|
302
302
|
* @param {string} versionId DocumentVersion ID
|
|
303
303
|
* @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
|
|
@@ -307,7 +307,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
307
307
|
*/
|
|
308
308
|
updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
|
|
309
309
|
/**
|
|
310
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
310
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
311
311
|
* Update Document Version Metadata Handler
|
|
312
312
|
*/
|
|
313
313
|
updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
@@ -445,12 +445,12 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
|
|
|
445
445
|
*/
|
|
446
446
|
updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
|
|
447
447
|
/**
|
|
448
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
448
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
449
449
|
* Update Document Version Metadata Handler
|
|
450
450
|
*/
|
|
451
451
|
updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
|
|
452
452
|
/**
|
|
453
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
453
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
454
454
|
* Update Document Version Metadata Handler
|
|
455
455
|
*/
|
|
456
456
|
updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
@@ -580,7 +580,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
580
580
|
});
|
|
581
581
|
}
|
|
582
582
|
/**
|
|
583
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
583
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
584
584
|
* Update Document Version Metadata Handler
|
|
585
585
|
*/
|
|
586
586
|
updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
|
|
@@ -591,7 +591,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
591
591
|
});
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
|
|
594
|
+
* Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
595
595
|
* Update Document Version Metadata Handler
|
|
596
596
|
*/
|
|
597
597
|
updateDocumentVersionMetadata(requestParameters, initOverrides) {
|
|
@@ -19,6 +19,8 @@ export interface CreateWorkflowRunRequest {
|
|
|
19
19
|
files?: Array<Blob>;
|
|
20
20
|
inputScope?: string | null;
|
|
21
21
|
idempotencyKey?: string | null;
|
|
22
|
+
autoStart?: boolean;
|
|
23
|
+
userMessage?: string | null;
|
|
22
24
|
}
|
|
23
25
|
export interface DeleteWorkflowDefinitionRequest {
|
|
24
26
|
definitionId: string;
|
|
@@ -90,6 +92,8 @@ export interface WorkflowDefinitionsApiInterface {
|
|
|
90
92
|
* @param {Array<Blob>} [files] DEPRECATED — do not send files here. Carrying file bytes on run creation makes the call block on synchronous S3 upload (the ~30s \\\'Create run\\\' wait). Instead create an empty draft (omit this field), then upload each file to the run\\\'s ``inputs/`` folder via ``POST /v1/documents/ingest`` with ``path_part_id`` set to the run\\\'s ``inputs_path_part_id``; that path ingests asynchronously and auto-syncs the run\\\'s state. This field will be removed once the FE has migrated.
|
|
91
93
|
* @param {string} [inputScope] JSON array of ``DOCUMENT`` or ``FOLDER`` path_part UUIDs referenced from the existing knowledge base, pinned onto the new draft\\\'s input scope. Optional — omit for an empty draft and add references later via PATCH.
|
|
92
94
|
* @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
|
|
95
|
+
* @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
|
|
96
|
+
* @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
|
|
93
97
|
* @throws {RequiredError}
|
|
94
98
|
* @memberof WorkflowDefinitionsApiInterface
|
|
95
99
|
*/
|
|
@@ -101,6 +105,8 @@ export interface WorkflowDefinitionsApiInterface {
|
|
|
101
105
|
* @param {Array<Blob>} [files] DEPRECATED — do not send files here. Carrying file bytes on run creation makes the call block on synchronous S3 upload (the ~30s \\\'Create run\\\' wait). Instead create an empty draft (omit this field), then upload each file to the run\\\'s ``inputs/`` folder via ``POST /v1/documents/ingest`` with ``path_part_id`` set to the run\\\'s ``inputs_path_part_id``; that path ingests asynchronously and auto-syncs the run\\\'s state. This field will be removed once the FE has migrated.
|
|
102
106
|
* @param {string} [inputScope] JSON array of ``DOCUMENT`` or ``FOLDER`` path_part UUIDs referenced from the existing knowledge base, pinned onto the new draft\\\'s input scope. Optional — omit for an empty draft and add references later via PATCH.
|
|
103
107
|
* @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
|
|
108
|
+
* @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
|
|
109
|
+
* @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
|
|
104
110
|
* @param {*} [options] Override http request option.
|
|
105
111
|
* @throws {RequiredError}
|
|
106
112
|
* @memberof WorkflowDefinitionsApiInterface
|
|
@@ -152,6 +152,12 @@ class WorkflowDefinitionsApi extends runtime.BaseAPI {
|
|
|
152
152
|
if (requestParameters['idempotencyKey'] != null) {
|
|
153
153
|
formParams.append('idempotency_key', requestParameters['idempotencyKey']);
|
|
154
154
|
}
|
|
155
|
+
if (requestParameters['autoStart'] != null) {
|
|
156
|
+
formParams.append('auto_start', requestParameters['autoStart']);
|
|
157
|
+
}
|
|
158
|
+
if (requestParameters['userMessage'] != null) {
|
|
159
|
+
formParams.append('user_message', requestParameters['userMessage']);
|
|
160
|
+
}
|
|
155
161
|
let urlPath = `/v1/workflow-definitions/{definition_id}/runs`;
|
|
156
162
|
urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
|
|
157
163
|
return {
|
|
@@ -300,7 +300,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
300
300
|
*/
|
|
301
301
|
updateWorkflowRunRequestOpts(requestParameters: UpdateWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
|
|
302
302
|
/**
|
|
303
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
303
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
304
304
|
* @summary Update Workflow Run Handler
|
|
305
305
|
* @param {string} runId
|
|
306
306
|
* @param {UpdateWorkflowRunRequest} updateWorkflowRunRequest
|
|
@@ -310,7 +310,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
310
310
|
*/
|
|
311
311
|
updateWorkflowRunRaw(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
312
312
|
/**
|
|
313
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
313
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
314
314
|
* Update Workflow Run Handler
|
|
315
315
|
*/
|
|
316
316
|
updateWorkflowRun(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -469,12 +469,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
469
469
|
*/
|
|
470
470
|
updateWorkflowRunRequestOpts(requestParameters: UpdateWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
|
|
471
471
|
/**
|
|
472
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
472
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
473
473
|
* Update Workflow Run Handler
|
|
474
474
|
*/
|
|
475
475
|
updateWorkflowRunRaw(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
476
476
|
/**
|
|
477
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
477
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
478
478
|
* Update Workflow Run Handler
|
|
479
479
|
*/
|
|
480
480
|
updateWorkflowRun(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -574,7 +574,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
574
574
|
});
|
|
575
575
|
}
|
|
576
576
|
/**
|
|
577
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
577
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
578
578
|
* Update Workflow Run Handler
|
|
579
579
|
*/
|
|
580
580
|
updateWorkflowRunRaw(requestParameters, initOverrides) {
|
|
@@ -585,7 +585,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
585
585
|
});
|
|
586
586
|
}
|
|
587
587
|
/**
|
|
588
|
-
* Edit a NOT_STARTED run\'s KB scope and / or
|
|
588
|
+
* Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation. Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
|
|
589
589
|
* Update Workflow Run Handler
|
|
590
590
|
*/
|
|
591
591
|
updateWorkflowRun(requestParameters, initOverrides) {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
|
|
13
|
+
import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
|
|
14
14
|
export interface CreateDataSourceOperationRequest {
|
|
15
15
|
createDataSourceRequest: CreateDataSourceRequest;
|
|
16
16
|
}
|
|
@@ -22,6 +22,10 @@ export interface GetDataSourceRequest {
|
|
|
22
22
|
}
|
|
23
23
|
export interface GetDataSourceCatalogRequest {
|
|
24
24
|
dataSourceId: string;
|
|
25
|
+
schema?: string | null;
|
|
26
|
+
}
|
|
27
|
+
export interface ListDataSourceSchemasRequest {
|
|
28
|
+
dataSourceId: string;
|
|
25
29
|
}
|
|
26
30
|
export interface ModelDataSourceTableRequest {
|
|
27
31
|
dataSourceId: string;
|
|
@@ -112,24 +116,47 @@ export interface DataSourcesApiInterface {
|
|
|
112
116
|
/**
|
|
113
117
|
* Creates request options for getDataSourceCatalog without sending the request
|
|
114
118
|
* @param {string} dataSourceId
|
|
119
|
+
* @param {string} [schema] Schema/namespace to introspect (default: connection default)
|
|
115
120
|
* @throws {RequiredError}
|
|
116
121
|
* @memberof DataSourcesApiInterface
|
|
117
122
|
*/
|
|
118
123
|
getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
|
|
119
124
|
/**
|
|
120
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
125
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
121
126
|
* @summary Get Data Source Catalog Handler
|
|
122
127
|
* @param {string} dataSourceId
|
|
128
|
+
* @param {string} [schema] Schema/namespace to introspect (default: connection default)
|
|
123
129
|
* @param {*} [options] Override http request option.
|
|
124
130
|
* @throws {RequiredError}
|
|
125
131
|
* @memberof DataSourcesApiInterface
|
|
126
132
|
*/
|
|
127
133
|
getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
|
|
128
134
|
/**
|
|
129
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
135
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
130
136
|
* Get Data Source Catalog Handler
|
|
131
137
|
*/
|
|
132
138
|
getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
141
|
+
* @param {string} dataSourceId
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
* @memberof DataSourcesApiInterface
|
|
144
|
+
*/
|
|
145
|
+
listDataSourceSchemasRequestOpts(requestParameters: ListDataSourceSchemasRequest): Promise<runtime.RequestOpts>;
|
|
146
|
+
/**
|
|
147
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
148
|
+
* @summary List Data Source Schemas Handler
|
|
149
|
+
* @param {string} dataSourceId
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
* @memberof DataSourcesApiInterface
|
|
153
|
+
*/
|
|
154
|
+
listDataSourceSchemasRaw(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSchemaListResponse>>;
|
|
155
|
+
/**
|
|
156
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
157
|
+
* List Data Source Schemas Handler
|
|
158
|
+
*/
|
|
159
|
+
listDataSourceSchemas(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSchemaListResponse>;
|
|
133
160
|
/**
|
|
134
161
|
* Creates request options for modelDataSourceTable without sending the request
|
|
135
162
|
* @param {string} dataSourceId
|
|
@@ -274,15 +301,29 @@ export declare class DataSourcesApi extends runtime.BaseAPI implements DataSourc
|
|
|
274
301
|
*/
|
|
275
302
|
getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
|
|
276
303
|
/**
|
|
277
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
304
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
278
305
|
* Get Data Source Catalog Handler
|
|
279
306
|
*/
|
|
280
307
|
getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
|
|
281
308
|
/**
|
|
282
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
309
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
283
310
|
* Get Data Source Catalog Handler
|
|
284
311
|
*/
|
|
285
312
|
getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
315
|
+
*/
|
|
316
|
+
listDataSourceSchemasRequestOpts(requestParameters: ListDataSourceSchemasRequest): Promise<runtime.RequestOpts>;
|
|
317
|
+
/**
|
|
318
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
319
|
+
* List Data Source Schemas Handler
|
|
320
|
+
*/
|
|
321
|
+
listDataSourceSchemasRaw(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSchemaListResponse>>;
|
|
322
|
+
/**
|
|
323
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
324
|
+
* List Data Source Schemas Handler
|
|
325
|
+
*/
|
|
326
|
+
listDataSourceSchemas(requestParameters: ListDataSourceSchemasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSchemaListResponse>;
|
|
286
327
|
/**
|
|
287
328
|
* Creates request options for modelDataSourceTable without sending the request
|
|
288
329
|
*/
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { CreateDataSourceRequestToJSON, DataSourceCatalogResponseFromJSON, DataSourceDetailResponseFromJSON, DataSourceQueryRequestToJSON, DataSourceQueryResponseFromJSON, DataSourceResponseFromJSON, DataSourceTableResponseFromJSON, ModelTableRequestToJSON, UpdateTableRequestToJSON, } from '../models/index';
|
|
24
|
+
import { CreateDataSourceRequestToJSON, DataSourceCatalogResponseFromJSON, DataSourceDetailResponseFromJSON, DataSourceQueryRequestToJSON, DataSourceQueryResponseFromJSON, DataSourceResponseFromJSON, DataSourceSchemaListResponseFromJSON, DataSourceTableResponseFromJSON, ModelTableRequestToJSON, UpdateTableRequestToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -179,6 +179,9 @@ export class DataSourcesApi extends runtime.BaseAPI {
|
|
|
179
179
|
throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling getDataSourceCatalog().');
|
|
180
180
|
}
|
|
181
181
|
const queryParameters = {};
|
|
182
|
+
if (requestParameters['schema'] != null) {
|
|
183
|
+
queryParameters['schema'] = requestParameters['schema'];
|
|
184
|
+
}
|
|
182
185
|
const headerParameters = {};
|
|
183
186
|
if (this.configuration && this.configuration.accessToken) {
|
|
184
187
|
const token = this.configuration.accessToken;
|
|
@@ -198,7 +201,7 @@ export class DataSourcesApi extends runtime.BaseAPI {
|
|
|
198
201
|
});
|
|
199
202
|
}
|
|
200
203
|
/**
|
|
201
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
204
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
202
205
|
* Get Data Source Catalog Handler
|
|
203
206
|
*/
|
|
204
207
|
getDataSourceCatalogRaw(requestParameters, initOverrides) {
|
|
@@ -209,7 +212,7 @@ export class DataSourcesApi extends runtime.BaseAPI {
|
|
|
209
212
|
});
|
|
210
213
|
}
|
|
211
214
|
/**
|
|
212
|
-
* Live-introspect the external DB so an admin can pick tables
|
|
215
|
+
* Live-introspect a schema of the external DB so an admin can pick tables.
|
|
213
216
|
* Get Data Source Catalog Handler
|
|
214
217
|
*/
|
|
215
218
|
getDataSourceCatalog(requestParameters, initOverrides) {
|
|
@@ -218,6 +221,54 @@ export class DataSourcesApi extends runtime.BaseAPI {
|
|
|
218
221
|
return yield response.value();
|
|
219
222
|
});
|
|
220
223
|
}
|
|
224
|
+
/**
|
|
225
|
+
* Creates request options for listDataSourceSchemas without sending the request
|
|
226
|
+
*/
|
|
227
|
+
listDataSourceSchemasRequestOpts(requestParameters) {
|
|
228
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
229
|
+
if (requestParameters['dataSourceId'] == null) {
|
|
230
|
+
throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling listDataSourceSchemas().');
|
|
231
|
+
}
|
|
232
|
+
const queryParameters = {};
|
|
233
|
+
const headerParameters = {};
|
|
234
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
235
|
+
const token = this.configuration.accessToken;
|
|
236
|
+
const tokenString = yield token("bearerAuth", []);
|
|
237
|
+
if (tokenString) {
|
|
238
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
let urlPath = `/v1/data-sources/{data_source_id}/schemas`;
|
|
242
|
+
urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
|
|
243
|
+
return {
|
|
244
|
+
path: urlPath,
|
|
245
|
+
method: 'GET',
|
|
246
|
+
headers: headerParameters,
|
|
247
|
+
query: queryParameters,
|
|
248
|
+
};
|
|
249
|
+
});
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
253
|
+
* List Data Source Schemas Handler
|
|
254
|
+
*/
|
|
255
|
+
listDataSourceSchemasRaw(requestParameters, initOverrides) {
|
|
256
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
257
|
+
const requestOptions = yield this.listDataSourceSchemasRequestOpts(requestParameters);
|
|
258
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
259
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceSchemaListResponseFromJSON(jsonValue));
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* List the source\'s user namespaces (PG schemas / MySQL databases).
|
|
264
|
+
* List Data Source Schemas Handler
|
|
265
|
+
*/
|
|
266
|
+
listDataSourceSchemas(requestParameters, initOverrides) {
|
|
267
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
268
|
+
const response = yield this.listDataSourceSchemasRaw(requestParameters, initOverrides);
|
|
269
|
+
return yield response.value();
|
|
270
|
+
});
|
|
271
|
+
}
|
|
221
272
|
/**
|
|
222
273
|
* Creates request options for modelDataSourceTable without sending the request
|
|
223
274
|
*/
|