@knowledge-stack/ksapi 1.116.0 → 1.118.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.
Files changed (38) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +4 -2
  3. package/dist/apis/DataSourcesApi.d.ts +42 -1
  4. package/dist/apis/DataSourcesApi.js +53 -0
  5. package/dist/esm/apis/DataSourcesApi.d.ts +42 -1
  6. package/dist/esm/apis/DataSourcesApi.js +54 -1
  7. package/dist/esm/models/CloneWorkflowRunRequest.d.ts +1 -1
  8. package/dist/esm/models/InputSnapshot.d.ts +10 -3
  9. package/dist/esm/models/InputSnapshot.js +3 -1
  10. package/dist/esm/models/UpdateApiConnectionRequest.d.ts +16 -0
  11. package/dist/esm/models/UpdateApiConnectionRequest.js +8 -0
  12. package/dist/esm/models/UpdateDataSourceRequest.d.ts +58 -0
  13. package/dist/esm/models/UpdateDataSourceRequest.js +49 -0
  14. package/dist/esm/models/UpdateWorkflowRunRequest.d.ts +1 -1
  15. package/dist/esm/models/index.d.ts +1 -0
  16. package/dist/esm/models/index.js +1 -0
  17. package/dist/models/CloneWorkflowRunRequest.d.ts +1 -1
  18. package/dist/models/InputSnapshot.d.ts +10 -3
  19. package/dist/models/InputSnapshot.js +3 -1
  20. package/dist/models/UpdateApiConnectionRequest.d.ts +16 -0
  21. package/dist/models/UpdateApiConnectionRequest.js +8 -0
  22. package/dist/models/UpdateDataSourceRequest.d.ts +58 -0
  23. package/dist/models/UpdateDataSourceRequest.js +57 -0
  24. package/dist/models/UpdateWorkflowRunRequest.d.ts +1 -1
  25. package/dist/models/index.d.ts +1 -0
  26. package/dist/models/index.js +1 -0
  27. package/docs/DataSourcesApi.md +79 -0
  28. package/docs/InputSnapshot.md +1 -1
  29. package/docs/UpdateApiConnectionRequest.md +5 -1
  30. package/docs/UpdateDataSourceRequest.md +37 -0
  31. package/package.json +1 -1
  32. package/src/apis/DataSourcesApi.ts +99 -0
  33. package/src/models/CloneWorkflowRunRequest.ts +1 -1
  34. package/src/models/InputSnapshot.ts +11 -4
  35. package/src/models/UpdateApiConnectionRequest.ts +24 -0
  36. package/src/models/UpdateDataSourceRequest.ts +99 -0
  37. package/src/models/UpdateWorkflowRunRequest.ts +1 -1
  38. package/src/models/index.ts +1 -0
@@ -285,6 +285,7 @@ docs/TrashItemResponse.md
285
285
  docs/UpdateApiConnectionRequest.md
286
286
  docs/UpdateChunkContentRequest.md
287
287
  docs/UpdateChunkMetadataRequest.md
288
+ docs/UpdateDataSourceRequest.md
288
289
  docs/UpdateDocumentRequest.md
289
290
  docs/UpdateFolderRequest.md
290
291
  docs/UpdateGroupPermissionRequest.md
@@ -625,6 +626,7 @@ src/models/TrashItemResponse.ts
625
626
  src/models/UpdateApiConnectionRequest.ts
626
627
  src/models/UpdateChunkContentRequest.ts
627
628
  src/models/UpdateChunkMetadataRequest.ts
629
+ src/models/UpdateDataSourceRequest.ts
628
630
  src/models/UpdateDocumentRequest.ts
629
631
  src/models/UpdateFolderRequest.ts
630
632
  src/models/UpdateGroupPermissionRequest.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.116.0
1
+ # @knowledge-stack/ksapi@1.118.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -109,6 +109,7 @@ All URIs are relative to *http://localhost:8000*
109
109
  *DataSourcesApi* | [**modelDataSourceTable**](docs/DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler
110
110
  *DataSourcesApi* | [**queryDataSource**](docs/DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler
111
111
  *DataSourcesApi* | [**testDataSourceConnection**](docs/DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler
112
+ *DataSourcesApi* | [**updateDataSource**](docs/DataSourcesApi.md#updatedatasourceoperation) | **PATCH** /v1/data-sources/{data_source_id} | Update Data Source Handler
112
113
  *DataSourcesApi* | [**updateDataSourceTable**](docs/DataSourcesApi.md#updatedatasourcetable) | **PATCH** /v1/data-sources/{data_source_id}/tables/{table_id} | Update Data Source Table Handler
113
114
  *DefaultApi* | [**healthCheck**](docs/DefaultApi.md#healthcheck) | **GET** /healthz | Health Check Handler
114
115
  *DefaultApi* | [**hello**](docs/DefaultApi.md#hello) | **GET** / | Root Handler
@@ -516,6 +517,7 @@ All URIs are relative to *http://localhost:8000*
516
517
  - [UpdateApiConnectionRequest](docs/UpdateApiConnectionRequest.md)
517
518
  - [UpdateChunkContentRequest](docs/UpdateChunkContentRequest.md)
518
519
  - [UpdateChunkMetadataRequest](docs/UpdateChunkMetadataRequest.md)
520
+ - [UpdateDataSourceRequest](docs/UpdateDataSourceRequest.md)
519
521
  - [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)
520
522
  - [UpdateFolderRequest](docs/UpdateFolderRequest.md)
521
523
  - [UpdateGroupPermissionRequest](docs/UpdateGroupPermissionRequest.md)
@@ -583,7 +585,7 @@ and is automatically generated by the
583
585
  [OpenAPI Generator](https://openapi-generator.tech) project:
584
586
 
585
587
  - API version: `0.1.0`
586
- - Package version: `1.116.0`
588
+ - Package version: `1.118.0`
587
589
  - Generator version: `7.21.0`
588
590
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
589
591
 
@@ -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, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
13
+ import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateDataSourceRequest, UpdateTableRequest } from '../models/index';
14
14
  export interface CreateDataSourceOperationRequest {
15
15
  createDataSourceRequest: CreateDataSourceRequest;
16
16
  }
@@ -38,6 +38,10 @@ export interface QueryDataSourceRequest {
38
38
  export interface TestDataSourceConnectionRequest {
39
39
  dataSourceId: string;
40
40
  }
41
+ export interface UpdateDataSourceOperationRequest {
42
+ dataSourceId: string;
43
+ updateDataSourceRequest: UpdateDataSourceRequest;
44
+ }
41
45
  export interface UpdateDataSourceTableRequest {
42
46
  dataSourceId: string;
43
47
  tableId: string;
@@ -224,6 +228,29 @@ export interface DataSourcesApiInterface {
224
228
  * Test Data Source Connection Handler
225
229
  */
226
230
  testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
231
+ /**
232
+ * Creates request options for updateDataSource without sending the request
233
+ * @param {string} dataSourceId
234
+ * @param {UpdateDataSourceRequest} updateDataSourceRequest
235
+ * @throws {RequiredError}
236
+ * @memberof DataSourcesApiInterface
237
+ */
238
+ updateDataSourceRequestOpts(requestParameters: UpdateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
239
+ /**
240
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
241
+ * @summary Update Data Source Handler
242
+ * @param {string} dataSourceId
243
+ * @param {UpdateDataSourceRequest} updateDataSourceRequest
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ * @memberof DataSourcesApiInterface
247
+ */
248
+ updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
249
+ /**
250
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
251
+ * Update Data Source Handler
252
+ */
253
+ updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
227
254
  /**
228
255
  * Creates request options for updateDataSourceTable without sending the request
229
256
  * @param {string} dataSourceId
@@ -366,6 +393,20 @@ export declare class DataSourcesApi extends runtime.BaseAPI implements DataSourc
366
393
  * Test Data Source Connection Handler
367
394
  */
368
395
  testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
396
+ /**
397
+ * Creates request options for updateDataSource without sending the request
398
+ */
399
+ updateDataSourceRequestOpts(requestParameters: UpdateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
400
+ /**
401
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
402
+ * Update Data Source Handler
403
+ */
404
+ updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
405
+ /**
406
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
407
+ * Update Data Source Handler
408
+ */
409
+ updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
369
410
  /**
370
411
  * Creates request options for updateDataSourceTable without sending the request
371
412
  */
@@ -458,6 +458,59 @@ class DataSourcesApi extends runtime.BaseAPI {
458
458
  yield this.testDataSourceConnectionRaw(requestParameters, initOverrides);
459
459
  });
460
460
  }
461
+ /**
462
+ * Creates request options for updateDataSource without sending the request
463
+ */
464
+ updateDataSourceRequestOpts(requestParameters) {
465
+ return __awaiter(this, void 0, void 0, function* () {
466
+ if (requestParameters['dataSourceId'] == null) {
467
+ throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling updateDataSource().');
468
+ }
469
+ if (requestParameters['updateDataSourceRequest'] == null) {
470
+ throw new runtime.RequiredError('updateDataSourceRequest', 'Required parameter "updateDataSourceRequest" was null or undefined when calling updateDataSource().');
471
+ }
472
+ const queryParameters = {};
473
+ const headerParameters = {};
474
+ headerParameters['Content-Type'] = 'application/json';
475
+ if (this.configuration && this.configuration.accessToken) {
476
+ const token = this.configuration.accessToken;
477
+ const tokenString = yield token("bearerAuth", []);
478
+ if (tokenString) {
479
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
480
+ }
481
+ }
482
+ let urlPath = `/v1/data-sources/{data_source_id}`;
483
+ urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
484
+ return {
485
+ path: urlPath,
486
+ method: 'PATCH',
487
+ headers: headerParameters,
488
+ query: queryParameters,
489
+ body: (0, index_1.UpdateDataSourceRequestToJSON)(requestParameters['updateDataSourceRequest']),
490
+ };
491
+ });
492
+ }
493
+ /**
494
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
495
+ * Update Data Source Handler
496
+ */
497
+ updateDataSourceRaw(requestParameters, initOverrides) {
498
+ return __awaiter(this, void 0, void 0, function* () {
499
+ const requestOptions = yield this.updateDataSourceRequestOpts(requestParameters);
500
+ const response = yield this.request(requestOptions, initOverrides);
501
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DataSourceResponseFromJSON)(jsonValue));
502
+ });
503
+ }
504
+ /**
505
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
506
+ * Update Data Source Handler
507
+ */
508
+ updateDataSource(requestParameters, initOverrides) {
509
+ return __awaiter(this, void 0, void 0, function* () {
510
+ const response = yield this.updateDataSourceRaw(requestParameters, initOverrides);
511
+ return yield response.value();
512
+ });
513
+ }
461
514
  /**
462
515
  * Creates request options for updateDataSourceTable without sending the request
463
516
  */
@@ -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, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
13
+ import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceSchemaListResponse, DataSourceTableResponse, ModelTableRequest, UpdateDataSourceRequest, UpdateTableRequest } from '../models/index';
14
14
  export interface CreateDataSourceOperationRequest {
15
15
  createDataSourceRequest: CreateDataSourceRequest;
16
16
  }
@@ -38,6 +38,10 @@ export interface QueryDataSourceRequest {
38
38
  export interface TestDataSourceConnectionRequest {
39
39
  dataSourceId: string;
40
40
  }
41
+ export interface UpdateDataSourceOperationRequest {
42
+ dataSourceId: string;
43
+ updateDataSourceRequest: UpdateDataSourceRequest;
44
+ }
41
45
  export interface UpdateDataSourceTableRequest {
42
46
  dataSourceId: string;
43
47
  tableId: string;
@@ -224,6 +228,29 @@ export interface DataSourcesApiInterface {
224
228
  * Test Data Source Connection Handler
225
229
  */
226
230
  testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
231
+ /**
232
+ * Creates request options for updateDataSource without sending the request
233
+ * @param {string} dataSourceId
234
+ * @param {UpdateDataSourceRequest} updateDataSourceRequest
235
+ * @throws {RequiredError}
236
+ * @memberof DataSourcesApiInterface
237
+ */
238
+ updateDataSourceRequestOpts(requestParameters: UpdateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
239
+ /**
240
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
241
+ * @summary Update Data Source Handler
242
+ * @param {string} dataSourceId
243
+ * @param {UpdateDataSourceRequest} updateDataSourceRequest
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ * @memberof DataSourcesApiInterface
247
+ */
248
+ updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
249
+ /**
250
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
251
+ * Update Data Source Handler
252
+ */
253
+ updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
227
254
  /**
228
255
  * Creates request options for updateDataSourceTable without sending the request
229
256
  * @param {string} dataSourceId
@@ -366,6 +393,20 @@ export declare class DataSourcesApi extends runtime.BaseAPI implements DataSourc
366
393
  * Test Data Source Connection Handler
367
394
  */
368
395
  testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
396
+ /**
397
+ * Creates request options for updateDataSource without sending the request
398
+ */
399
+ updateDataSourceRequestOpts(requestParameters: UpdateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
400
+ /**
401
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
402
+ * Update Data Source Handler
403
+ */
404
+ updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
405
+ /**
406
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
407
+ * Update Data Source Handler
408
+ */
409
+ updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
369
410
  /**
370
411
  * Creates request options for updateDataSourceTable without sending the request
371
412
  */
@@ -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, DataSourceSchemaListResponseFromJSON, DataSourceTableResponseFromJSON, ModelTableRequestToJSON, UpdateTableRequestToJSON, } from '../models/index';
24
+ import { CreateDataSourceRequestToJSON, DataSourceCatalogResponseFromJSON, DataSourceDetailResponseFromJSON, DataSourceQueryRequestToJSON, DataSourceQueryResponseFromJSON, DataSourceResponseFromJSON, DataSourceSchemaListResponseFromJSON, DataSourceTableResponseFromJSON, ModelTableRequestToJSON, UpdateDataSourceRequestToJSON, UpdateTableRequestToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -422,6 +422,59 @@ export class DataSourcesApi extends runtime.BaseAPI {
422
422
  yield this.testDataSourceConnectionRaw(requestParameters, initOverrides);
423
423
  });
424
424
  }
425
+ /**
426
+ * Creates request options for updateDataSource without sending the request
427
+ */
428
+ updateDataSourceRequestOpts(requestParameters) {
429
+ return __awaiter(this, void 0, void 0, function* () {
430
+ if (requestParameters['dataSourceId'] == null) {
431
+ throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling updateDataSource().');
432
+ }
433
+ if (requestParameters['updateDataSourceRequest'] == null) {
434
+ throw new runtime.RequiredError('updateDataSourceRequest', 'Required parameter "updateDataSourceRequest" was null or undefined when calling updateDataSource().');
435
+ }
436
+ const queryParameters = {};
437
+ const headerParameters = {};
438
+ headerParameters['Content-Type'] = 'application/json';
439
+ if (this.configuration && this.configuration.accessToken) {
440
+ const token = this.configuration.accessToken;
441
+ const tokenString = yield token("bearerAuth", []);
442
+ if (tokenString) {
443
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
444
+ }
445
+ }
446
+ let urlPath = `/v1/data-sources/{data_source_id}`;
447
+ urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
448
+ return {
449
+ path: urlPath,
450
+ method: 'PATCH',
451
+ headers: headerParameters,
452
+ query: queryParameters,
453
+ body: UpdateDataSourceRequestToJSON(requestParameters['updateDataSourceRequest']),
454
+ };
455
+ });
456
+ }
457
+ /**
458
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
459
+ * Update Data Source Handler
460
+ */
461
+ updateDataSourceRaw(requestParameters, initOverrides) {
462
+ return __awaiter(this, void 0, void 0, function* () {
463
+ const requestOptions = yield this.updateDataSourceRequestOpts(requestParameters);
464
+ const response = yield this.request(requestOptions, initOverrides);
465
+ return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceResponseFromJSON(jsonValue));
466
+ });
467
+ }
468
+ /**
469
+ * Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
470
+ * Update Data Source Handler
471
+ */
472
+ updateDataSource(requestParameters, initOverrides) {
473
+ return __awaiter(this, void 0, void 0, function* () {
474
+ const response = yield this.updateDataSourceRaw(requestParameters, initOverrides);
475
+ return yield response.value();
476
+ });
477
+ }
425
478
  /**
426
479
  * Creates request options for updateDataSourceTable without sending the request
427
480
  */
@@ -23,7 +23,7 @@
23
23
  */
24
24
  export interface CloneWorkflowRunRequest {
25
25
  /**
26
- * When True, the new run's input_path_part_ids are pinned from the source run's snapshotted inputs (DOCUMENT_VERSION + FOLDER path_parts). When False, the new run is created with an empty input scope.
26
+ * When True, the new run's input_path_part_ids are pinned from the source run's snapshotted inputs (DOCUMENT_VERSION, FOLDER, DATA_SOURCE, API_CONNECTION path_parts). When False, the new run is created with an empty input scope.
27
27
  * @type {boolean}
28
28
  * @memberof CloneWorkflowRunRequest
29
29
  */
@@ -22,15 +22,20 @@
22
22
  * FOLDER path_part itself; its contents are NOT captured here and
23
23
  * are enumerated live by the runner (see ``materialized_path`` for
24
24
  * subtree scoping).
25
+ * * ``DATA_SOURCE`` / ``API_CONNECTION`` — a live connector reference
26
+ * (DB / API). ``path_part_id`` is the connector path_part itself; the
27
+ * runner queries it live via its connector tools, nothing is captured
28
+ * here.
25
29
  *
26
- * The underlying PDO id (DocumentVersion or Folder) is resolved live at
27
- * run time from ``path_part.metadata_obj_id``, not stored here.
30
+ * The underlying PDO id (DocumentVersion / Folder / connector) is
31
+ * resolved live at run time from ``path_part.metadata_obj_id``, not
32
+ * stored here.
28
33
  * @export
29
34
  * @interface InputSnapshot
30
35
  */
31
36
  export interface InputSnapshot {
32
37
  /**
33
- * DOCUMENT_VERSION path_part of the pinned input version, or the FOLDER path_part of a live folder reference — see ``part_type``.
38
+ * DOCUMENT_VERSION path_part of the pinned input version, or the path_part of a live FOLDER / DATA_SOURCE / API_CONNECTION reference — see ``part_type``.
34
39
  * @type {string}
35
40
  * @memberof InputSnapshot
36
41
  */
@@ -54,6 +59,8 @@ export interface InputSnapshot {
54
59
  export declare const InputSnapshotPartTypeEnum: {
55
60
  readonly DocumentVersion: "DOCUMENT_VERSION";
56
61
  readonly Folder: "FOLDER";
62
+ readonly DataSource: "DATA_SOURCE";
63
+ readonly ApiConnection: "API_CONNECTION";
57
64
  };
58
65
  export type InputSnapshotPartTypeEnum = typeof InputSnapshotPartTypeEnum[keyof typeof InputSnapshotPartTypeEnum];
59
66
  export declare const InputSnapshotPropertyValidationAttributesMap: {
@@ -16,7 +16,9 @@
16
16
  */
17
17
  export const InputSnapshotPartTypeEnum = {
18
18
  DocumentVersion: 'DOCUMENT_VERSION',
19
- Folder: 'FOLDER'
19
+ Folder: 'FOLDER',
20
+ DataSource: 'DATA_SOURCE',
21
+ ApiConnection: 'API_CONNECTION'
20
22
  };
21
23
  export const InputSnapshotPropertyValidationAttributesMap = {};
22
24
  /**
@@ -13,10 +13,26 @@ import type { NetworkClass } from './NetworkClass';
13
13
  import type { ApiAuthConfig } from './ApiAuthConfig';
14
14
  /**
15
15
  * Partial update (PATCH). A risk-increasing change re-arms the disclaimer.
16
+ *
17
+ * ``name`` renames the connection and ``parent_path_part_id`` moves it under
18
+ * a new FOLDER; neither is a risk-increasing change, so a rename/move alone
19
+ * leaves the disclaimer intact.
16
20
  * @export
17
21
  * @interface UpdateApiConnectionRequest
18
22
  */
19
23
  export interface UpdateApiConnectionRequest {
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof UpdateApiConnectionRequest
28
+ */
29
+ name?: string | null;
30
+ /**
31
+ * New parent FOLDER path_part to move the connection under.
32
+ * @type {string}
33
+ * @memberof UpdateApiConnectionRequest
34
+ */
35
+ parentPathPartId?: string | null;
20
36
  /**
21
37
  *
22
38
  * @type {string}
@@ -14,6 +14,10 @@
14
14
  import { NetworkClassFromJSON, NetworkClassToJSON, } from './NetworkClass';
15
15
  import { ApiAuthConfigFromJSON, ApiAuthConfigToJSON, } from './ApiAuthConfig';
16
16
  export const UpdateApiConnectionRequestPropertyValidationAttributesMap = {
17
+ name: {
18
+ maxLength: 255,
19
+ minLength: 1,
20
+ },
17
21
  baseUrl: {
18
22
  maxLength: 2048,
19
23
  },
@@ -35,6 +39,8 @@ export function UpdateApiConnectionRequestFromJSONTyped(json, ignoreDiscriminato
35
39
  return json;
36
40
  }
37
41
  return {
42
+ 'name': json['name'] == null ? undefined : json['name'],
43
+ 'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
38
44
  'baseUrl': json['base_url'] == null ? undefined : json['base_url'],
39
45
  'networkClass': json['network_class'] == null ? undefined : NetworkClassFromJSON(json['network_class']),
40
46
  'verifyTls': json['verify_tls'] == null ? undefined : json['verify_tls'],
@@ -50,6 +56,8 @@ export function UpdateApiConnectionRequestToJSONTyped(value, ignoreDiscriminator
50
56
  return value;
51
57
  }
52
58
  return {
59
+ 'name': value['name'],
60
+ 'parent_path_part_id': value['parentPathPartId'],
53
61
  'base_url': value['baseUrl'],
54
62
  'network_class': NetworkClassToJSON(value['networkClass']),
55
63
  'verify_tls': value['verifyTls'],
@@ -0,0 +1,58 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Rename and/or move a connector (PATCH). Both fields optional.
14
+ *
15
+ * A body with both ``None`` is rejected as a no-op 400. ``name`` renames
16
+ * the connector path_part; ``parent_path_part_id`` moves it under a new
17
+ * FOLDER (the move cascades ``materialized_path`` to the modeled-table
18
+ * children). Connection credentials and engine are not editable here.
19
+ * @export
20
+ * @interface UpdateDataSourceRequest
21
+ */
22
+ export interface UpdateDataSourceRequest {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof UpdateDataSourceRequest
27
+ */
28
+ name?: string | null;
29
+ /**
30
+ * New parent FOLDER path_part to move the connector under.
31
+ * @type {string}
32
+ * @memberof UpdateDataSourceRequest
33
+ */
34
+ parentPathPartId?: string | null;
35
+ }
36
+ export declare const UpdateDataSourceRequestPropertyValidationAttributesMap: {
37
+ [property: string]: {
38
+ maxLength?: number;
39
+ minLength?: number;
40
+ pattern?: string;
41
+ maximum?: number;
42
+ exclusiveMaximum?: boolean;
43
+ minimum?: number;
44
+ exclusiveMinimum?: boolean;
45
+ multipleOf?: number;
46
+ maxItems?: number;
47
+ minItems?: number;
48
+ uniqueItems?: boolean;
49
+ };
50
+ };
51
+ /**
52
+ * Check if a given object implements the UpdateDataSourceRequest interface.
53
+ */
54
+ export declare function instanceOfUpdateDataSourceRequest(value: object): value is UpdateDataSourceRequest;
55
+ export declare function UpdateDataSourceRequestFromJSON(json: any): UpdateDataSourceRequest;
56
+ export declare function UpdateDataSourceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDataSourceRequest;
57
+ export declare function UpdateDataSourceRequestToJSON(json: any): UpdateDataSourceRequest;
58
+ export declare function UpdateDataSourceRequestToJSONTyped(value?: UpdateDataSourceRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,49 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const UpdateDataSourceRequestPropertyValidationAttributesMap = {
15
+ name: {
16
+ maxLength: 255,
17
+ minLength: 1,
18
+ },
19
+ };
20
+ /**
21
+ * Check if a given object implements the UpdateDataSourceRequest interface.
22
+ */
23
+ export function instanceOfUpdateDataSourceRequest(value) {
24
+ return true;
25
+ }
26
+ export function UpdateDataSourceRequestFromJSON(json) {
27
+ return UpdateDataSourceRequestFromJSONTyped(json, false);
28
+ }
29
+ export function UpdateDataSourceRequestFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'name': json['name'] == null ? undefined : json['name'],
35
+ 'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
36
+ };
37
+ }
38
+ export function UpdateDataSourceRequestToJSON(json) {
39
+ return UpdateDataSourceRequestToJSONTyped(json, false);
40
+ }
41
+ export function UpdateDataSourceRequestToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'name': value['name'],
47
+ 'parent_path_part_id': value['parentPathPartId'],
48
+ };
49
+ }
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface UpdateWorkflowRunRequest {
23
23
  /**
24
- * New KB-reference scope (DOCUMENT + FOLDER pp_ids). Replaces the row's ``input_path_part_ids`` wholesale. Uploaded files live in ``inputs/`` and are walked at Start; they are not part of this list.
24
+ * New KB-reference scope (DOCUMENT + FOLDER + DATA_SOURCE + API_CONNECTION pp_ids). Replaces the row's ``input_path_part_ids`` wholesale. Uploaded files live in ``inputs/`` and are walked at Start; they are not part of this list.
25
25
  * @type {Array<string>}
26
26
  * @memberof UpdateWorkflowRunRequest
27
27
  */
@@ -252,6 +252,7 @@ export * from './TrashItemResponse';
252
252
  export * from './UpdateApiConnectionRequest';
253
253
  export * from './UpdateChunkContentRequest';
254
254
  export * from './UpdateChunkMetadataRequest';
255
+ export * from './UpdateDataSourceRequest';
255
256
  export * from './UpdateDocumentRequest';
256
257
  export * from './UpdateFolderRequest';
257
258
  export * from './UpdateGroupPermissionRequest';
@@ -254,6 +254,7 @@ export * from './TrashItemResponse';
254
254
  export * from './UpdateApiConnectionRequest';
255
255
  export * from './UpdateChunkContentRequest';
256
256
  export * from './UpdateChunkMetadataRequest';
257
+ export * from './UpdateDataSourceRequest';
257
258
  export * from './UpdateDocumentRequest';
258
259
  export * from './UpdateFolderRequest';
259
260
  export * from './UpdateGroupPermissionRequest';
@@ -23,7 +23,7 @@
23
23
  */
24
24
  export interface CloneWorkflowRunRequest {
25
25
  /**
26
- * When True, the new run's input_path_part_ids are pinned from the source run's snapshotted inputs (DOCUMENT_VERSION + FOLDER path_parts). When False, the new run is created with an empty input scope.
26
+ * When True, the new run's input_path_part_ids are pinned from the source run's snapshotted inputs (DOCUMENT_VERSION, FOLDER, DATA_SOURCE, API_CONNECTION path_parts). When False, the new run is created with an empty input scope.
27
27
  * @type {boolean}
28
28
  * @memberof CloneWorkflowRunRequest
29
29
  */
@@ -22,15 +22,20 @@
22
22
  * FOLDER path_part itself; its contents are NOT captured here and
23
23
  * are enumerated live by the runner (see ``materialized_path`` for
24
24
  * subtree scoping).
25
+ * * ``DATA_SOURCE`` / ``API_CONNECTION`` — a live connector reference
26
+ * (DB / API). ``path_part_id`` is the connector path_part itself; the
27
+ * runner queries it live via its connector tools, nothing is captured
28
+ * here.
25
29
  *
26
- * The underlying PDO id (DocumentVersion or Folder) is resolved live at
27
- * run time from ``path_part.metadata_obj_id``, not stored here.
30
+ * The underlying PDO id (DocumentVersion / Folder / connector) is
31
+ * resolved live at run time from ``path_part.metadata_obj_id``, not
32
+ * stored here.
28
33
  * @export
29
34
  * @interface InputSnapshot
30
35
  */
31
36
  export interface InputSnapshot {
32
37
  /**
33
- * DOCUMENT_VERSION path_part of the pinned input version, or the FOLDER path_part of a live folder reference — see ``part_type``.
38
+ * DOCUMENT_VERSION path_part of the pinned input version, or the path_part of a live FOLDER / DATA_SOURCE / API_CONNECTION reference — see ``part_type``.
34
39
  * @type {string}
35
40
  * @memberof InputSnapshot
36
41
  */
@@ -54,6 +59,8 @@ export interface InputSnapshot {
54
59
  export declare const InputSnapshotPartTypeEnum: {
55
60
  readonly DocumentVersion: "DOCUMENT_VERSION";
56
61
  readonly Folder: "FOLDER";
62
+ readonly DataSource: "DATA_SOURCE";
63
+ readonly ApiConnection: "API_CONNECTION";
57
64
  };
58
65
  export type InputSnapshotPartTypeEnum = typeof InputSnapshotPartTypeEnum[keyof typeof InputSnapshotPartTypeEnum];
59
66
  export declare const InputSnapshotPropertyValidationAttributesMap: {
@@ -24,7 +24,9 @@ exports.InputSnapshotToJSONTyped = InputSnapshotToJSONTyped;
24
24
  */
25
25
  exports.InputSnapshotPartTypeEnum = {
26
26
  DocumentVersion: 'DOCUMENT_VERSION',
27
- Folder: 'FOLDER'
27
+ Folder: 'FOLDER',
28
+ DataSource: 'DATA_SOURCE',
29
+ ApiConnection: 'API_CONNECTION'
28
30
  };
29
31
  exports.InputSnapshotPropertyValidationAttributesMap = {};
30
32
  /**
@@ -13,10 +13,26 @@ import type { NetworkClass } from './NetworkClass';
13
13
  import type { ApiAuthConfig } from './ApiAuthConfig';
14
14
  /**
15
15
  * Partial update (PATCH). A risk-increasing change re-arms the disclaimer.
16
+ *
17
+ * ``name`` renames the connection and ``parent_path_part_id`` moves it under
18
+ * a new FOLDER; neither is a risk-increasing change, so a rename/move alone
19
+ * leaves the disclaimer intact.
16
20
  * @export
17
21
  * @interface UpdateApiConnectionRequest
18
22
  */
19
23
  export interface UpdateApiConnectionRequest {
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof UpdateApiConnectionRequest
28
+ */
29
+ name?: string | null;
30
+ /**
31
+ * New parent FOLDER path_part to move the connection under.
32
+ * @type {string}
33
+ * @memberof UpdateApiConnectionRequest
34
+ */
35
+ parentPathPartId?: string | null;
20
36
  /**
21
37
  *
22
38
  * @type {string}