@knowledge-stack/ksapi 1.111.1 → 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.
Files changed (93) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +6 -2
  3. package/dist/apis/DataSourcesApi.d.ts +46 -5
  4. package/dist/apis/DataSourcesApi.js +53 -2
  5. package/dist/apis/DocumentVersionsApi.d.ts +4 -4
  6. package/dist/apis/DocumentVersionsApi.js +2 -2
  7. package/dist/apis/WorkflowDefinitionsApi.d.ts +6 -0
  8. package/dist/apis/WorkflowDefinitionsApi.js +6 -0
  9. package/dist/apis/WorkflowRunsApi.d.ts +4 -4
  10. package/dist/apis/WorkflowRunsApi.js +2 -2
  11. package/dist/esm/apis/DataSourcesApi.d.ts +46 -5
  12. package/dist/esm/apis/DataSourcesApi.js +54 -3
  13. package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
  14. package/dist/esm/apis/DocumentVersionsApi.js +2 -2
  15. package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +6 -0
  16. package/dist/esm/apis/WorkflowDefinitionsApi.js +6 -0
  17. package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -4
  18. package/dist/esm/apis/WorkflowRunsApi.js +2 -2
  19. package/dist/esm/models/CatalogColumnResponse.d.ts +7 -0
  20. package/dist/esm/models/CatalogColumnResponse.js +3 -0
  21. package/dist/esm/models/CatalogTableResponse.d.ts +6 -0
  22. package/dist/esm/models/CatalogTableResponse.js +4 -0
  23. package/dist/esm/models/ColumnConfig.d.ts +7 -0
  24. package/dist/esm/models/ColumnConfig.js +3 -0
  25. package/dist/esm/models/ColumnReference.d.ts +59 -0
  26. package/dist/esm/models/ColumnReference.js +50 -0
  27. package/dist/esm/models/DataSourceSchemaListResponse.d.ts +48 -0
  28. package/dist/esm/models/DataSourceSchemaListResponse.js +45 -0
  29. package/dist/esm/models/DataSourceSchemaResponse.d.ts +53 -0
  30. package/dist/esm/models/DataSourceSchemaResponse.js +48 -0
  31. package/dist/esm/models/DataSourceTableResponse.d.ts +6 -0
  32. package/dist/esm/models/DataSourceTableResponse.js +2 -0
  33. package/dist/esm/models/ModelTableRequest.d.ts +6 -0
  34. package/dist/esm/models/ModelTableRequest.js +2 -0
  35. package/dist/esm/models/UpdateWorkflowRunRequest.d.ts +12 -0
  36. package/dist/esm/models/UpdateWorkflowRunRequest.js +7 -0
  37. package/dist/esm/models/WorkflowRunResponse.d.ts +12 -0
  38. package/dist/esm/models/WorkflowRunResponse.js +6 -0
  39. package/dist/esm/models/index.d.ts +3 -0
  40. package/dist/esm/models/index.js +3 -0
  41. package/dist/models/CatalogColumnResponse.d.ts +7 -0
  42. package/dist/models/CatalogColumnResponse.js +3 -0
  43. package/dist/models/CatalogTableResponse.d.ts +6 -0
  44. package/dist/models/CatalogTableResponse.js +4 -0
  45. package/dist/models/ColumnConfig.d.ts +7 -0
  46. package/dist/models/ColumnConfig.js +3 -0
  47. package/dist/models/ColumnReference.d.ts +59 -0
  48. package/dist/models/ColumnReference.js +58 -0
  49. package/dist/models/DataSourceSchemaListResponse.d.ts +48 -0
  50. package/dist/models/DataSourceSchemaListResponse.js +53 -0
  51. package/dist/models/DataSourceSchemaResponse.d.ts +53 -0
  52. package/dist/models/DataSourceSchemaResponse.js +56 -0
  53. package/dist/models/DataSourceTableResponse.d.ts +6 -0
  54. package/dist/models/DataSourceTableResponse.js +2 -0
  55. package/dist/models/ModelTableRequest.d.ts +6 -0
  56. package/dist/models/ModelTableRequest.js +2 -0
  57. package/dist/models/UpdateWorkflowRunRequest.d.ts +12 -0
  58. package/dist/models/UpdateWorkflowRunRequest.js +7 -0
  59. package/dist/models/WorkflowRunResponse.d.ts +12 -0
  60. package/dist/models/WorkflowRunResponse.js +6 -0
  61. package/dist/models/index.d.ts +3 -0
  62. package/dist/models/index.js +3 -0
  63. package/docs/CatalogColumnResponse.md +2 -0
  64. package/docs/CatalogTableResponse.md +2 -0
  65. package/docs/ColumnConfig.md +2 -0
  66. package/docs/ColumnReference.md +39 -0
  67. package/docs/DataSourceSchemaListResponse.md +35 -0
  68. package/docs/DataSourceSchemaResponse.md +36 -0
  69. package/docs/DataSourceTableResponse.md +2 -0
  70. package/docs/DataSourcesApi.md +81 -2
  71. package/docs/DocumentVersionsApi.md +1 -1
  72. package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md +6 -0
  73. package/docs/ModelTableRequest.md +2 -0
  74. package/docs/UpdateWorkflowRunRequest.md +4 -0
  75. package/docs/WorkflowDefinitionsApi.md +7 -1
  76. package/docs/WorkflowRunResponse.md +4 -0
  77. package/docs/WorkflowRunsApi.md +1 -1
  78. package/package.json +1 -1
  79. package/src/apis/DataSourcesApi.ts +97 -4
  80. package/src/apis/DocumentVersionsApi.ts +4 -4
  81. package/src/apis/WorkflowDefinitionsApi.ts +14 -0
  82. package/src/apis/WorkflowRunsApi.ts +4 -4
  83. package/src/models/CatalogColumnResponse.ts +16 -0
  84. package/src/models/CatalogTableResponse.ts +9 -0
  85. package/src/models/ColumnConfig.ts +16 -0
  86. package/src/models/ColumnReference.ts +100 -0
  87. package/src/models/DataSourceSchemaListResponse.ts +91 -0
  88. package/src/models/DataSourceSchemaResponse.ts +92 -0
  89. package/src/models/DataSourceTableResponse.ts +8 -0
  90. package/src/models/ModelTableRequest.ts +8 -0
  91. package/src/models/UpdateWorkflowRunRequest.ts +19 -0
  92. package/src/models/WorkflowRunResponse.ts +17 -0
  93. package/src/models/index.ts +3 -0
@@ -32,6 +32,18 @@ export interface UpdateWorkflowRunRequest {
32
32
  * @memberof UpdateWorkflowRunRequest
33
33
  */
34
34
  name?: string | null;
35
+ /**
36
+ * Arm (or disarm) auto-start on a draft run. When set true, the run dispatches itself once its ``inputs/`` uploads finish ingesting (see ``CreateWorkflowRunRequest.auto_start``). Arm a PENDING run after queuing all uploads to avoid a partial-input start. ``null`` leaves the current setting unchanged.
37
+ * @type {boolean}
38
+ * @memberof UpdateWorkflowRunRequest
39
+ */
40
+ autoStart?: boolean | null;
41
+ /**
42
+ * Set the note applied when this run auto-starts (see ``CreateWorkflowRunRequest.user_message``). ``null`` leaves the stored message unchanged; send an empty string to clear it.
43
+ * @type {string}
44
+ * @memberof UpdateWorkflowRunRequest
45
+ */
46
+ userMessage?: string | null;
35
47
  }
36
48
  export declare const UpdateWorkflowRunRequestPropertyValidationAttributesMap: {
37
49
  [property: string]: {
@@ -28,6 +28,9 @@ exports.UpdateWorkflowRunRequestPropertyValidationAttributesMap = {
28
28
  maxLength: 255,
29
29
  minLength: 1,
30
30
  },
31
+ userMessage: {
32
+ maxLength: 4000,
33
+ },
31
34
  };
32
35
  /**
33
36
  * Check if a given object implements the UpdateWorkflowRunRequest interface.
@@ -45,6 +48,8 @@ function UpdateWorkflowRunRequestFromJSONTyped(json, ignoreDiscriminator) {
45
48
  return {
46
49
  'inputScope': json['input_scope'] == null ? undefined : json['input_scope'],
47
50
  'name': json['name'] == null ? undefined : json['name'],
51
+ 'autoStart': json['auto_start'] == null ? undefined : json['auto_start'],
52
+ 'userMessage': json['user_message'] == null ? undefined : json['user_message'],
48
53
  };
49
54
  }
50
55
  function UpdateWorkflowRunRequestToJSON(json) {
@@ -57,5 +62,7 @@ function UpdateWorkflowRunRequestToJSONTyped(value, ignoreDiscriminator = false)
57
62
  return {
58
63
  'input_scope': value['inputScope'],
59
64
  'name': value['name'],
65
+ 'auto_start': value['autoStart'],
66
+ 'user_message': value['userMessage'],
60
67
  };
61
68
  }
@@ -120,6 +120,18 @@ export interface WorkflowRunResponse {
120
120
  * @memberof WorkflowRunResponse
121
121
  */
122
122
  error: string | null;
123
+ /**
124
+ * Whether the run dispatches itself once its ``inputs/`` uploads finish ingesting, with no separate Start call.
125
+ * @type {boolean}
126
+ * @memberof WorkflowRunResponse
127
+ */
128
+ autoStart: boolean;
129
+ /**
130
+ * The note applied when this run auto-starts (set via create / PATCH ``user_message``); null when none was supplied.
131
+ * @type {string}
132
+ * @memberof WorkflowRunResponse
133
+ */
134
+ autoStartUserMessage?: string | null;
123
135
  /**
124
136
  * FOLDER path_part of the run's ``inputs/`` subfolder
125
137
  * @type {string}
@@ -63,6 +63,8 @@ function instanceOfWorkflowRunResponse(value) {
63
63
  return false;
64
64
  if (!('error' in value) || value['error'] === undefined)
65
65
  return false;
66
+ if (!('autoStart' in value) || value['autoStart'] === undefined)
67
+ return false;
66
68
  if (!('inputsPathPartId' in value) || value['inputsPathPartId'] === undefined)
67
69
  return false;
68
70
  if (!('outputsPathPartId' in value) || value['outputsPathPartId'] === undefined)
@@ -100,6 +102,8 @@ function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
100
102
  'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
101
103
  'runSnapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotFromJSON)(json['run_snapshot']),
102
104
  'error': json['error'],
105
+ 'autoStart': json['auto_start'],
106
+ 'autoStartUserMessage': json['auto_start_user_message'] == null ? undefined : json['auto_start_user_message'],
103
107
  'inputsPathPartId': json['inputs_path_part_id'],
104
108
  'outputsPathPartId': json['outputs_path_part_id'],
105
109
  'discussionsPathPartId': json['discussions_path_part_id'],
@@ -135,6 +139,8 @@ function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
135
139
  'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
136
140
  'run_snapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotToJSON)(value['runSnapshot']),
137
141
  'error': value['error'],
142
+ 'auto_start': value['autoStart'],
143
+ 'auto_start_user_message': value['autoStartUserMessage'],
138
144
  'inputs_path_part_id': value['inputsPathPartId'],
139
145
  'outputs_path_part_id': value['outputsPathPartId'],
140
146
  'discussions_path_part_id': value['discussionsPathPartId'],
@@ -38,6 +38,7 @@ export * from './CitedChunk';
38
38
  export * from './ClearVersionContentsResponse';
39
39
  export * from './CloneWorkflowRunRequest';
40
40
  export * from './ColumnConfig';
41
+ export * from './ColumnReference';
41
42
  export * from './ConnectionConfig';
42
43
  export * from './CreateApiConnectionRequest';
43
44
  export * from './CreateApiKeyRequest';
@@ -63,6 +64,8 @@ export * from './DataSourceEngine';
63
64
  export * from './DataSourceQueryRequest';
64
65
  export * from './DataSourceQueryResponse';
65
66
  export * from './DataSourceResponse';
67
+ export * from './DataSourceSchemaListResponse';
68
+ export * from './DataSourceSchemaResponse';
66
69
  export * from './DataSourceTableResponse';
67
70
  export * from './DiffFormat';
68
71
  export * from './DiffRow';
@@ -56,6 +56,7 @@ __exportStar(require("./CitedChunk"), exports);
56
56
  __exportStar(require("./ClearVersionContentsResponse"), exports);
57
57
  __exportStar(require("./CloneWorkflowRunRequest"), exports);
58
58
  __exportStar(require("./ColumnConfig"), exports);
59
+ __exportStar(require("./ColumnReference"), exports);
59
60
  __exportStar(require("./ConnectionConfig"), exports);
60
61
  __exportStar(require("./CreateApiConnectionRequest"), exports);
61
62
  __exportStar(require("./CreateApiKeyRequest"), exports);
@@ -81,6 +82,8 @@ __exportStar(require("./DataSourceEngine"), exports);
81
82
  __exportStar(require("./DataSourceQueryRequest"), exports);
82
83
  __exportStar(require("./DataSourceQueryResponse"), exports);
83
84
  __exportStar(require("./DataSourceResponse"), exports);
85
+ __exportStar(require("./DataSourceSchemaListResponse"), exports);
86
+ __exportStar(require("./DataSourceSchemaResponse"), exports);
84
87
  __exportStar(require("./DataSourceTableResponse"), exports);
85
88
  __exportStar(require("./DiffFormat"), exports);
86
89
  __exportStar(require("./DiffRow"), exports);
@@ -9,6 +9,7 @@ Name | Type
9
9
  `name` | string
10
10
  `dataType` | string
11
11
  `isPk` | boolean
12
+ `references` | [ColumnReference](ColumnReference.md)
12
13
 
13
14
  ## Example
14
15
 
@@ -20,6 +21,7 @@ const example = {
20
21
  "name": null,
21
22
  "dataType": null,
22
23
  "isPk": null,
24
+ "references": null,
23
25
  } satisfies CatalogColumnResponse
24
26
 
25
27
  console.log(example)
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `name` | string
10
+ `schemaName` | string
10
11
  `columns` | [Array<CatalogColumnResponse>](CatalogColumnResponse.md)
11
12
 
12
13
  ## Example
@@ -17,6 +18,7 @@ import type { CatalogTableResponse } from '@knowledge-stack/ksapi'
17
18
  // TODO: Update the object below with actual values
18
19
  const example = {
19
20
  "name": null,
21
+ "schemaName": null,
20
22
  "columns": null,
21
23
  } satisfies CatalogTableResponse
22
24
 
@@ -12,6 +12,7 @@ Name | Type
12
12
  `comment` | string
13
13
  `isPk` | boolean
14
14
  `exposed` | boolean
15
+ `references` | [ColumnReference](ColumnReference.md)
15
16
 
16
17
  ## Example
17
18
 
@@ -25,6 +26,7 @@ const example = {
25
26
  "comment": null,
26
27
  "isPk": null,
27
28
  "exposed": null,
29
+ "references": null,
28
30
  } satisfies ColumnConfig
29
31
 
30
32
  console.log(example)
@@ -0,0 +1,39 @@
1
+
2
+ # ColumnReference
3
+
4
+ The table+column a foreign-key column points at.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `schemaName` | string
11
+ `table` | string
12
+ `column` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { ColumnReference } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "schemaName": null,
22
+ "table": null,
23
+ "column": null,
24
+ } satisfies ColumnReference
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as ColumnReference
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,35 @@
1
+
2
+ # DataSourceSchemaListResponse
3
+
4
+ The source\'s user namespaces (PG schemas / MySQL databases).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `schemas` | [Array<DataSourceSchemaResponse>](DataSourceSchemaResponse.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { DataSourceSchemaListResponse } from '@knowledge-stack/ksapi'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "schemas": null,
20
+ } satisfies DataSourceSchemaListResponse
21
+
22
+ console.log(example)
23
+
24
+ // Convert the instance to a JSON string
25
+ const exampleJSON: string = JSON.stringify(example)
26
+ console.log(exampleJSON)
27
+
28
+ // Parse the JSON string back to an object
29
+ const exampleParsed = JSON.parse(exampleJSON) as DataSourceSchemaListResponse
30
+ console.log(exampleParsed)
31
+ ```
32
+
33
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
34
+
35
+
@@ -0,0 +1,36 @@
1
+
2
+ # DataSourceSchemaResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `isDefault` | boolean
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { DataSourceSchemaResponse } from '@knowledge-stack/ksapi'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "name": null,
20
+ "isDefault": null,
21
+ } satisfies DataSourceSchemaResponse
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as DataSourceSchemaResponse
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -16,6 +16,7 @@ Name | Type
16
16
  `name` | string
17
17
  `dataSourceId` | string
18
18
  `tableName` | string
19
+ `schemaName` | string
19
20
  `description` | string
20
21
  `columnConfig` | Array<{ [key: string]: any; }>
21
22
  `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
@@ -39,6 +40,7 @@ const example = {
39
40
  "name": null,
40
41
  "dataSourceId": null,
41
42
  "tableName": null,
43
+ "schemaName": null,
42
44
  "description": null,
43
45
  "columnConfig": null,
44
46
  "approvalState": null,
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
8
8
  | [**deleteDataSource**](DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler |
9
9
  | [**getDataSource**](DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler |
10
10
  | [**getDataSourceCatalog**](DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler |
11
+ | [**listDataSourceSchemas**](DataSourcesApi.md#listdatasourceschemas) | **GET** /v1/data-sources/{data_source_id}/schemas | List Data Source Schemas Handler |
11
12
  | [**modelDataSourceTable**](DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler |
12
13
  | [**queryDataSource**](DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler |
13
14
  | [**testDataSourceConnection**](DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler |
@@ -242,11 +243,11 @@ example().catch(console.error);
242
243
 
243
244
  ## getDataSourceCatalog
244
245
 
245
- > DataSourceCatalogResponse getDataSourceCatalog(dataSourceId)
246
+ > DataSourceCatalogResponse getDataSourceCatalog(dataSourceId, schema)
246
247
 
247
248
  Get Data Source Catalog Handler
248
249
 
249
- Live-introspect the external DB so an admin can pick tables to model.
250
+ Live-introspect a schema of the external DB so an admin can pick tables.
250
251
 
251
252
  ### Example
252
253
 
@@ -270,6 +271,8 @@ async function example() {
270
271
  const body = {
271
272
  // string
272
273
  dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
274
+ // string | Schema/namespace to introspect (default: connection default) (optional)
275
+ schema: schema_example,
273
276
  } satisfies GetDataSourceCatalogRequest;
274
277
 
275
278
  try {
@@ -290,6 +293,7 @@ example().catch(console.error);
290
293
  | Name | Type | Description | Notes |
291
294
  |------------- | ------------- | ------------- | -------------|
292
295
  | **dataSourceId** | `string` | | [Defaults to `undefined`] |
296
+ | **schema** | `string` | Schema/namespace to introspect (default: connection default) | [Optional] [Defaults to `undefined`] |
293
297
 
294
298
  ### Return type
295
299
 
@@ -315,6 +319,81 @@ example().catch(console.error);
315
319
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
316
320
 
317
321
 
322
+ ## listDataSourceSchemas
323
+
324
+ > DataSourceSchemaListResponse listDataSourceSchemas(dataSourceId)
325
+
326
+ List Data Source Schemas Handler
327
+
328
+ List the source\'s user namespaces (PG schemas / MySQL databases).
329
+
330
+ ### Example
331
+
332
+ ```ts
333
+ import {
334
+ Configuration,
335
+ DataSourcesApi,
336
+ } from '@knowledge-stack/ksapi';
337
+ import type { ListDataSourceSchemasRequest } from '@knowledge-stack/ksapi';
338
+
339
+ async function example() {
340
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
341
+ const config = new Configuration({
342
+ // To configure API key authorization: cookieAuth
343
+ apiKey: "YOUR API KEY",
344
+ // Configure HTTP bearer authorization: bearerAuth
345
+ accessToken: "YOUR BEARER TOKEN",
346
+ });
347
+ const api = new DataSourcesApi(config);
348
+
349
+ const body = {
350
+ // string
351
+ dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
352
+ } satisfies ListDataSourceSchemasRequest;
353
+
354
+ try {
355
+ const data = await api.listDataSourceSchemas(body);
356
+ console.log(data);
357
+ } catch (error) {
358
+ console.error(error);
359
+ }
360
+ }
361
+
362
+ // Run the test
363
+ example().catch(console.error);
364
+ ```
365
+
366
+ ### Parameters
367
+
368
+
369
+ | Name | Type | Description | Notes |
370
+ |------------- | ------------- | ------------- | -------------|
371
+ | **dataSourceId** | `string` | | [Defaults to `undefined`] |
372
+
373
+ ### Return type
374
+
375
+ [**DataSourceSchemaListResponse**](DataSourceSchemaListResponse.md)
376
+
377
+ ### Authorization
378
+
379
+ [cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: Not defined
384
+ - **Accept**: `application/json`
385
+
386
+
387
+ ### HTTP response details
388
+ | Status code | Description | Response headers |
389
+ |-------------|-------------|------------------|
390
+ | **200** | Successful Response | - |
391
+ | **422** | Validation Error | - |
392
+ | **0** | Error response. | - |
393
+
394
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
395
+
396
+
318
397
  ## modelDataSourceTable
319
398
 
320
399
  > DataSourceTableResponse modelDataSourceTable(dataSourceId, modelTableRequest)
@@ -747,7 +747,7 @@ example().catch(console.error);
747
747
 
748
748
  Update Document Version Metadata Handler
749
749
 
750
- 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.
750
+ 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``).
751
751
 
752
752
  ### Example
753
753
 
@@ -41,6 +41,8 @@ Name | Type
41
41
  `completedAt` | Date
42
42
  `runSnapshot` | [WorkflowRunSnapshot](WorkflowRunSnapshot.md)
43
43
  `error` | string
44
+ `autoStart` | boolean
45
+ `autoStartUserMessage` | string
44
46
  `inputsPathPartId` | string
45
47
  `outputsPathPartId` | string
46
48
  `discussionsPathPartId` | string
@@ -50,6 +52,7 @@ Name | Type
50
52
  `engine` | [DataSourceEngine](DataSourceEngine.md)
51
53
  `dataSourceId` | string
52
54
  `tableName` | string
55
+ `schemaName` | string
53
56
  `columnConfig` | Array<{ [key: string]: any; }>
54
57
  `baseUrl` | string
55
58
  `networkClass` | [NetworkClass](NetworkClass.md)
@@ -100,6 +103,8 @@ const example = {
100
103
  "completedAt": null,
101
104
  "runSnapshot": null,
102
105
  "error": null,
106
+ "autoStart": null,
107
+ "autoStartUserMessage": null,
103
108
  "inputsPathPartId": null,
104
109
  "outputsPathPartId": null,
105
110
  "discussionsPathPartId": null,
@@ -109,6 +114,7 @@ const example = {
109
114
  "engine": null,
110
115
  "dataSourceId": null,
111
116
  "tableName": null,
117
+ "schemaName": null,
112
118
  "columnConfig": null,
113
119
  "baseUrl": null,
114
120
  "networkClass": null,
@@ -8,6 +8,7 @@ Model a DB table as a queryable child of the connector.
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `tableName` | string
11
+ `schemaName` | string
11
12
  `name` | string
12
13
  `description` | string
13
14
  `columnConfig` | [Array<ColumnConfig>](ColumnConfig.md)
@@ -20,6 +21,7 @@ import type { ModelTableRequest } from '@knowledge-stack/ksapi'
20
21
  // TODO: Update the object below with actual values
21
22
  const example = {
22
23
  "tableName": null,
24
+ "schemaName": null,
23
25
  "name": null,
24
26
  "description": null,
25
27
  "columnConfig": null,
@@ -9,6 +9,8 @@ Name | Type
9
9
  ------------ | -------------
10
10
  `inputScope` | Array<string>
11
11
  `name` | string
12
+ `autoStart` | boolean
13
+ `userMessage` | string
12
14
 
13
15
  ## Example
14
16
 
@@ -19,6 +21,8 @@ import type { UpdateWorkflowRunRequest } from '@knowledge-stack/ksapi'
19
21
  const example = {
20
22
  "inputScope": null,
21
23
  "name": null,
24
+ "autoStart": null,
25
+ "userMessage": null,
22
26
  } satisfies UpdateWorkflowRunRequest
23
27
 
24
28
  console.log(example)
@@ -90,7 +90,7 @@ example().catch(console.error);
90
90
 
91
91
  ## createWorkflowRun
92
92
 
93
- > WorkflowRunResponse createWorkflowRun(definitionId, files, inputScope, idempotencyKey)
93
+ > WorkflowRunResponse createWorkflowRun(definitionId, files, inputScope, idempotencyKey, autoStart, userMessage)
94
94
 
95
95
  Create Workflow Run Handler
96
96
 
@@ -124,6 +124,10 @@ async function example() {
124
124
  inputScope: inputScope_example,
125
125
  // string | Optional key to prevent duplicate runs from retries. (optional)
126
126
  idempotencyKey: idempotencyKey_example,
127
+ // boolean | 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. (optional)
128
+ autoStart: true,
129
+ // string | 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. (optional)
130
+ userMessage: userMessage_example,
127
131
  } satisfies CreateWorkflowRunRequest;
128
132
 
129
133
  try {
@@ -147,6 +151,8 @@ example().catch(console.error);
147
151
  | **files** | `Array<Blob>` | DEPRECATED — do not send files here. Carrying file bytes on run creation makes the call block on synchronous S3 upload (the ~30s \\\&#39;Create run\\\&#39; wait). Instead create an empty draft (omit this field), then upload each file to the run\\\&#39;s &#x60;&#x60;inputs/&#x60;&#x60; folder via &#x60;&#x60;POST /v1/documents/ingest&#x60;&#x60; with &#x60;&#x60;path_part_id&#x60;&#x60; set to the run\\\&#39;s &#x60;&#x60;inputs_path_part_id&#x60;&#x60;; that path ingests asynchronously and auto-syncs the run\\\&#39;s state. This field will be removed once the FE has migrated. | [Optional] |
148
152
  | **inputScope** | `string` | JSON array of &#x60;&#x60;DOCUMENT&#x60;&#x60; or &#x60;&#x60;FOLDER&#x60;&#x60; path_part UUIDs referenced from the existing knowledge base, pinned onto the new draft\\\&#39;s input scope. Optional — omit for an empty draft and add references later via PATCH. | [Optional] [Defaults to `undefined`] |
149
153
  | **idempotencyKey** | `string` | Optional key to prevent duplicate runs from retries. | [Optional] [Defaults to `undefined`] |
154
+ | **autoStart** | `boolean` | When true, the run starts itself once its &#x60;&#x60;inputs/&#x60;&#x60; uploads finish ingesting — eliminating the separate Start call. If an upload\\\&#39;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. | [Optional] [Defaults to `false`] |
155
+ | **userMessage** | `string` | Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\&#39;s &#x60;&#x60;user_message&#x60;&#x60; for a self-starting run). Applied only when &#x60;&#x60;auto_start&#x60;&#x60; fires. | [Optional] [Defaults to `undefined`] |
150
156
 
151
157
  ### Return type
152
158
 
@@ -22,6 +22,8 @@ Name | Type
22
22
  `completedAt` | Date
23
23
  `runSnapshot` | [WorkflowRunSnapshot](WorkflowRunSnapshot.md)
24
24
  `error` | string
25
+ `autoStart` | boolean
26
+ `autoStartUserMessage` | string
25
27
  `inputsPathPartId` | string
26
28
  `outputsPathPartId` | string
27
29
  `discussionsPathPartId` | string
@@ -55,6 +57,8 @@ const example = {
55
57
  "completedAt": null,
56
58
  "runSnapshot": null,
57
59
  "error": null,
60
+ "autoStart": null,
61
+ "autoStartUserMessage": null,
58
62
  "inputsPathPartId": null,
59
63
  "outputsPathPartId": null,
60
64
  "discussionsPathPartId": null,
@@ -746,7 +746,7 @@ example().catch(console.error);
746
746
 
747
747
  Update Workflow Run Handler
748
748
 
749
- Edit a NOT_STARTED run\&#39;s KB scope and / or display name. Both body fields are optional but at least one must be present. The run must be &#x60;&#x60;NOT_STARTED&#x60;&#x60; (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\&#39;s &#x60;&#x60;runs/&#x60;&#x60; folder maps to a 409 via &#x60;&#x60;IntegrityError&#x60;&#x60; translation.
749
+ Edit a NOT_STARTED run\&#39;s KB scope, name, and / or auto_start. Both body fields are optional but at least one must be present. The run must be &#x60;&#x60;NOT_STARTED&#x60;&#x60; or &#x60;&#x60;PENDING&#x60;&#x60; (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\&#39;s &#x60;&#x60;runs/&#x60;&#x60; folder maps to a 409 via &#x60;&#x60;IntegrityError&#x60;&#x60; translation. Arming &#x60;&#x60;auto_start&#x60;&#x60; on a run that is already &#x60;&#x60;NOT_STARTED&#x60;&#x60; (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A &#x60;&#x60;PENDING&#x60;&#x60; run is left to auto-advance when its uploads finish.
750
750
 
751
751
  ### Example
752
752
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.111.1",
3
+ "version": "1.112.0",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {