@knowledge-stack/ksapi 1.117.0 → 1.119.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 +40 -4
- package/README.md +27 -4
- package/dist/apis/DataSourcesApi.d.ts +211 -9
- package/dist/apis/DataSourcesApi.js +260 -4
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/FoldersApi.d.ts +9 -9
- package/dist/apis/FoldersApi.js +2 -2
- package/dist/esm/apis/DataSourcesApi.d.ts +211 -9
- package/dist/esm/apis/DataSourcesApi.js +261 -5
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/FoldersApi.d.ts +9 -9
- package/dist/esm/apis/FoldersApi.js +3 -3
- package/dist/esm/models/BlockChangeType.d.ts +26 -0
- package/dist/esm/models/BlockChangeType.js +44 -0
- package/dist/esm/models/BlockKind.d.ts +28 -0
- package/dist/esm/models/BlockKind.js +46 -0
- package/dist/esm/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesRequest.js +50 -0
- package/dist/esm/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesResponse.js +45 -0
- package/dist/esm/models/CellChange.d.ts +47 -0
- package/dist/esm/models/CellChange.js +14 -0
- package/dist/esm/models/CellDiff.d.ts +7 -0
- package/dist/esm/models/CellDiff.js +5 -0
- package/dist/esm/models/ChangeClass.d.ts +29 -0
- package/dist/esm/models/ChangeClass.js +47 -0
- package/dist/esm/models/CloneWorkflowRunRequest.d.ts +1 -1
- package/dist/esm/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/esm/models/DataSourceDescriptionResponse.js +48 -0
- package/dist/esm/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/esm/models/DataSourceDetailResponse.js +6 -4
- package/dist/esm/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/esm/models/DataSourceSchemaListItem.js +48 -0
- package/dist/esm/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/esm/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/esm/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/esm/models/DataSourceSchemaResponse.js +61 -0
- package/dist/esm/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/esm/models/DataSourceTableResponse.js +4 -2
- package/dist/esm/models/DiffFormat.d.ts +2 -0
- package/dist/esm/models/DiffFormat.js +3 -1
- package/dist/esm/models/DocumentBlockChange.d.ts +174 -0
- package/dist/esm/models/DocumentBlockChange.js +97 -0
- package/dist/esm/models/DocumentDiff.d.ts +102 -0
- package/dist/esm/models/DocumentDiff.js +77 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
- package/dist/esm/models/InputSnapshot.d.ts +10 -3
- package/dist/esm/models/InputSnapshot.js +3 -1
- package/dist/esm/models/ModelTableResult.d.ts +81 -0
- package/dist/esm/models/ModelTableResult.js +63 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
- package/dist/esm/models/PartType.d.ts +1 -0
- package/dist/esm/models/PartType.js +1 -0
- package/dist/esm/models/PixelRegion.d.ts +65 -0
- package/dist/esm/models/PixelRegion.js +56 -0
- package/dist/esm/models/ReferenceType.d.ts +1 -0
- package/dist/esm/models/ReferenceType.js +1 -0
- package/dist/esm/models/RevisionEdit.d.ts +71 -0
- package/dist/esm/models/RevisionEdit.js +57 -0
- package/dist/esm/models/SearchablePartType.d.ts +2 -0
- package/dist/esm/models/SearchablePartType.js +2 -0
- package/dist/esm/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/esm/models/SheetVisibilityChange.js +52 -0
- package/dist/esm/models/StructuredChange.d.ts +69 -0
- package/dist/esm/models/StructuredChange.js +57 -0
- package/dist/esm/models/StructuredChangeType.d.ts +26 -0
- package/dist/esm/models/StructuredChangeType.js +44 -0
- package/dist/esm/models/StructuredDiff.d.ts +82 -0
- package/dist/esm/models/StructuredDiff.js +65 -0
- package/dist/esm/models/TableCellChange.d.ts +72 -0
- package/dist/esm/models/TableCellChange.js +61 -0
- package/dist/esm/models/UpdateApiConnectionRequest.d.ts +16 -0
- package/dist/esm/models/UpdateApiConnectionRequest.js +8 -0
- package/dist/esm/models/UpdateDataSourceRequest.d.ts +58 -0
- package/dist/esm/models/UpdateDataSourceRequest.js +49 -0
- package/dist/esm/models/UpdateWorkflowRunRequest.d.ts +1 -1
- package/dist/esm/models/VersionDiffResponse.d.ts +72 -1
- package/dist/esm/models/VersionDiffResponse.js +25 -0
- package/dist/esm/models/index.d.ts +20 -2
- package/dist/esm/models/index.js +20 -2
- package/dist/models/BlockChangeType.d.ts +26 -0
- package/dist/models/BlockChangeType.js +52 -0
- package/dist/models/BlockKind.d.ts +28 -0
- package/dist/models/BlockKind.js +54 -0
- package/dist/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/models/BulkModelTablesRequest.js +58 -0
- package/dist/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/models/BulkModelTablesResponse.js +53 -0
- package/dist/models/CellChange.d.ts +47 -0
- package/dist/models/CellChange.js +14 -0
- package/dist/models/CellDiff.d.ts +7 -0
- package/dist/models/CellDiff.js +5 -0
- package/dist/models/ChangeClass.d.ts +29 -0
- package/dist/models/ChangeClass.js +55 -0
- package/dist/models/CloneWorkflowRunRequest.d.ts +1 -1
- package/dist/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/models/DataSourceDescriptionResponse.js +56 -0
- package/dist/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/models/DataSourceDetailResponse.js +6 -4
- package/dist/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/models/DataSourceSchemaListItem.js +56 -0
- package/dist/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/models/DataSourceSchemaResponse.js +62 -1
- package/dist/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/models/DataSourceTableResponse.js +4 -2
- package/dist/models/DiffFormat.d.ts +2 -0
- package/dist/models/DiffFormat.js +3 -1
- package/dist/models/DocumentBlockChange.d.ts +174 -0
- package/dist/models/DocumentBlockChange.js +105 -0
- package/dist/models/DocumentDiff.d.ts +102 -0
- package/dist/models/DocumentDiff.js +85 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
- package/dist/models/InputSnapshot.d.ts +10 -3
- package/dist/models/InputSnapshot.js +3 -1
- package/dist/models/ModelTableResult.d.ts +81 -0
- package/dist/models/ModelTableResult.js +71 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
- package/dist/models/PartType.d.ts +1 -0
- package/dist/models/PartType.js +1 -0
- package/dist/models/PixelRegion.d.ts +65 -0
- package/dist/models/PixelRegion.js +64 -0
- package/dist/models/ReferenceType.d.ts +1 -0
- package/dist/models/ReferenceType.js +1 -0
- package/dist/models/RevisionEdit.d.ts +71 -0
- package/dist/models/RevisionEdit.js +65 -0
- package/dist/models/SearchablePartType.d.ts +2 -0
- package/dist/models/SearchablePartType.js +2 -0
- package/dist/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/models/SheetVisibilityChange.js +60 -0
- package/dist/models/StructuredChange.d.ts +69 -0
- package/dist/models/StructuredChange.js +65 -0
- package/dist/models/StructuredChangeType.d.ts +26 -0
- package/dist/models/StructuredChangeType.js +52 -0
- package/dist/models/StructuredDiff.d.ts +82 -0
- package/dist/models/StructuredDiff.js +73 -0
- package/dist/models/TableCellChange.d.ts +72 -0
- package/dist/models/TableCellChange.js +69 -0
- package/dist/models/UpdateApiConnectionRequest.d.ts +16 -0
- package/dist/models/UpdateApiConnectionRequest.js +8 -0
- package/dist/models/UpdateDataSourceRequest.d.ts +58 -0
- package/dist/models/UpdateDataSourceRequest.js +57 -0
- package/dist/models/UpdateWorkflowRunRequest.d.ts +1 -1
- package/dist/models/VersionDiffResponse.d.ts +72 -1
- package/dist/models/VersionDiffResponse.js +25 -0
- package/dist/models/index.d.ts +20 -2
- package/dist/models/index.js +20 -2
- package/docs/BlockChangeType.md +32 -0
- package/docs/BlockKind.md +32 -0
- package/docs/BulkModelTablesRequest.md +35 -0
- package/docs/BulkModelTablesResponse.md +35 -0
- package/docs/CellChange.md +15 -1
- package/docs/CellDiff.md +2 -0
- package/docs/ChangeClass.md +33 -0
- package/docs/ChunksApi.md +1 -1
- package/docs/DataSourceDescriptionResponse.md +37 -0
- package/docs/DataSourceDetailResponse.md +5 -3
- package/docs/DataSourceSchemaListItem.md +37 -0
- package/docs/DataSourceSchemaListResponse.md +1 -1
- package/docs/DataSourceSchemaResponse.md +29 -0
- package/docs/DataSourceTableResponse.md +3 -3
- package/docs/DataSourcesApi.md +394 -2
- package/docs/DocumentBlockChange.md +73 -0
- package/docs/DocumentDiff.md +51 -0
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +12 -6
- package/docs/FoldersApi.md +5 -5
- package/docs/InputSnapshot.md +1 -1
- package/docs/ModelTableResult.md +43 -0
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
- package/docs/PixelRegion.md +41 -0
- package/docs/RevisionEdit.md +41 -0
- package/docs/SheetVisibilityChange.md +39 -0
- package/docs/StructuredChange.md +41 -0
- package/docs/StructuredChangeType.md +32 -0
- package/docs/StructuredDiff.md +45 -0
- package/docs/TableCellChange.md +43 -0
- package/docs/UpdateApiConnectionRequest.md +5 -1
- package/docs/UpdateDataSourceRequest.md +37 -0
- package/docs/VersionDiffResponse.md +23 -1
- package/package.json +1 -1
- package/src/apis/DataSourcesApi.ts +481 -8
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/FoldersApi.ts +13 -13
- package/src/models/BlockChangeType.ts +54 -0
- package/src/models/BlockKind.ts +56 -0
- package/src/models/BulkModelTablesRequest.ts +95 -0
- package/src/models/BulkModelTablesResponse.ts +91 -0
- package/src/models/CellChange.ts +61 -0
- package/src/models/CellDiff.ts +16 -0
- package/src/models/ChangeClass.ts +57 -0
- package/src/models/CloneWorkflowRunRequest.ts +1 -1
- package/src/models/DataSourceDescriptionResponse.ts +92 -0
- package/src/models/DataSourceDetailResponse.ts +24 -13
- package/src/models/DataSourceSchemaListItem.ts +92 -0
- package/src/models/DataSourceSchemaListResponse.ts +10 -10
- package/src/models/DataSourceSchemaResponse.ts +157 -1
- package/src/models/DataSourceTableResponse.ts +11 -7
- package/src/models/DiffFormat.ts +3 -1
- package/src/models/DocumentBlockChange.ts +297 -0
- package/src/models/DocumentDiff.ts +169 -0
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
- package/src/models/InputSnapshot.ts +11 -4
- package/src/models/ModelTableResult.ts +136 -0
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
- package/src/models/PartType.ts +1 -0
- package/src/models/PixelRegion.ts +110 -0
- package/src/models/ReferenceType.ts +1 -0
- package/src/models/RevisionEdit.ts +125 -0
- package/src/models/SearchablePartType.ts +2 -0
- package/src/models/SheetVisibilityChange.ts +105 -0
- package/src/models/StructuredChange.ts +123 -0
- package/src/models/StructuredChangeType.ts +54 -0
- package/src/models/StructuredDiff.ts +140 -0
- package/src/models/TableCellChange.ts +129 -0
- package/src/models/UpdateApiConnectionRequest.ts +24 -0
- package/src/models/UpdateDataSourceRequest.ts +99 -0
- package/src/models/UpdateWorkflowRunRequest.ts +1 -1
- package/src/models/VersionDiffResponse.ts +112 -1
- package/src/models/index.ts +20 -2
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
package/docs/DataSourcesApi.md
CHANGED
|
@@ -6,12 +6,17 @@ All URIs are relative to *http://localhost:8000*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createDataSource**](DataSourcesApi.md#createdatasourceoperation) | **POST** /v1/data-sources | Create Data Source Handler |
|
|
8
8
|
| [**deleteDataSource**](DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler |
|
|
9
|
+
| [**deleteDataSourceSchema**](DataSourcesApi.md#deletedatasourceschema) | **DELETE** /v1/data-sources/{data_source_id}/schemas/{schema_id} | Delete Data Source Schema Handler |
|
|
10
|
+
| [**deleteDataSourceTable**](DataSourcesApi.md#deletedatasourcetable) | **DELETE** /v1/data-sources/{data_source_id}/tables/{table_id} | Delete Data Source Table Handler |
|
|
11
|
+
| [**generateDataSourceDescription**](DataSourcesApi.md#generatedatasourcedescription) | **POST** /v1/data-sources/{data_source_id}/describe | Generate Data Source Description Handler |
|
|
9
12
|
| [**getDataSource**](DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler |
|
|
10
13
|
| [**getDataSourceCatalog**](DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler |
|
|
11
14
|
| [**listDataSourceSchemas**](DataSourcesApi.md#listdatasourceschemas) | **GET** /v1/data-sources/{data_source_id}/schemas | List Data Source Schemas Handler |
|
|
12
15
|
| [**modelDataSourceTable**](DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler |
|
|
16
|
+
| [**modelDataSourceTables**](DataSourcesApi.md#modeldatasourcetables) | **POST** /v1/data-sources/{data_source_id}/tables/batch | Model Data Source Tables Handler |
|
|
13
17
|
| [**queryDataSource**](DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler |
|
|
14
18
|
| [**testDataSourceConnection**](DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler |
|
|
19
|
+
| [**updateDataSource**](DataSourcesApi.md#updatedatasourceoperation) | **PATCH** /v1/data-sources/{data_source_id} | Update Data Source Handler |
|
|
15
20
|
| [**updateDataSourceTable**](DataSourcesApi.md#updatedatasourcetable) | **PATCH** /v1/data-sources/{data_source_id}/tables/{table_id} | Update Data Source Table Handler |
|
|
16
21
|
|
|
17
22
|
|
|
@@ -97,7 +102,7 @@ example().catch(console.error);
|
|
|
97
102
|
|
|
98
103
|
Delete Data Source Handler
|
|
99
104
|
|
|
100
|
-
Move a connector and its
|
|
105
|
+
Move a connector and its schemas/tables to trash. Soft-delete via the path_part subtree (schemas + tables are children, so they trash with it). The connector\'s generated ``.overview`` description Document IS ingested, so its Qdrant points are flipped to trashed via the set-trashed workflow (best-effort, mirrors the document delete path).
|
|
101
106
|
|
|
102
107
|
### Example
|
|
103
108
|
|
|
@@ -166,6 +171,237 @@ example().catch(console.error);
|
|
|
166
171
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
167
172
|
|
|
168
173
|
|
|
174
|
+
## deleteDataSourceSchema
|
|
175
|
+
|
|
176
|
+
> deleteDataSourceSchema(dataSourceId, schemaId)
|
|
177
|
+
|
|
178
|
+
Delete Data Source Schema Handler
|
|
179
|
+
|
|
180
|
+
Un-model a schema and the tables under it (hard-delete the namespace).
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
import {
|
|
186
|
+
Configuration,
|
|
187
|
+
DataSourcesApi,
|
|
188
|
+
} from '@knowledge-stack/ksapi';
|
|
189
|
+
import type { DeleteDataSourceSchemaRequest } from '@knowledge-stack/ksapi';
|
|
190
|
+
|
|
191
|
+
async function example() {
|
|
192
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
193
|
+
const config = new Configuration({
|
|
194
|
+
// To configure API key authorization: cookieAuth
|
|
195
|
+
apiKey: "YOUR API KEY",
|
|
196
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
197
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
198
|
+
});
|
|
199
|
+
const api = new DataSourcesApi(config);
|
|
200
|
+
|
|
201
|
+
const body = {
|
|
202
|
+
// string
|
|
203
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
204
|
+
// string
|
|
205
|
+
schemaId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
206
|
+
} satisfies DeleteDataSourceSchemaRequest;
|
|
207
|
+
|
|
208
|
+
try {
|
|
209
|
+
const data = await api.deleteDataSourceSchema(body);
|
|
210
|
+
console.log(data);
|
|
211
|
+
} catch (error) {
|
|
212
|
+
console.error(error);
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// Run the test
|
|
217
|
+
example().catch(console.error);
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
| Name | Type | Description | Notes |
|
|
224
|
+
|------------- | ------------- | ------------- | -------------|
|
|
225
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
226
|
+
| **schemaId** | `string` | | [Defaults to `undefined`] |
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
`void` (Empty response body)
|
|
231
|
+
|
|
232
|
+
### Authorization
|
|
233
|
+
|
|
234
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
235
|
+
|
|
236
|
+
### HTTP request headers
|
|
237
|
+
|
|
238
|
+
- **Content-Type**: Not defined
|
|
239
|
+
- **Accept**: `application/json`
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### HTTP response details
|
|
243
|
+
| Status code | Description | Response headers |
|
|
244
|
+
|-------------|-------------|------------------|
|
|
245
|
+
| **204** | Successful Response | - |
|
|
246
|
+
| **422** | Validation Error | - |
|
|
247
|
+
| **0** | Error response. | - |
|
|
248
|
+
|
|
249
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
## deleteDataSourceTable
|
|
253
|
+
|
|
254
|
+
> deleteDataSourceTable(dataSourceId, tableId)
|
|
255
|
+
|
|
256
|
+
Delete Data Source Table Handler
|
|
257
|
+
|
|
258
|
+
Un-model a single table (hard-delete it from its schema).
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```ts
|
|
263
|
+
import {
|
|
264
|
+
Configuration,
|
|
265
|
+
DataSourcesApi,
|
|
266
|
+
} from '@knowledge-stack/ksapi';
|
|
267
|
+
import type { DeleteDataSourceTableRequest } from '@knowledge-stack/ksapi';
|
|
268
|
+
|
|
269
|
+
async function example() {
|
|
270
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
271
|
+
const config = new Configuration({
|
|
272
|
+
// To configure API key authorization: cookieAuth
|
|
273
|
+
apiKey: "YOUR API KEY",
|
|
274
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
275
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
276
|
+
});
|
|
277
|
+
const api = new DataSourcesApi(config);
|
|
278
|
+
|
|
279
|
+
const body = {
|
|
280
|
+
// string
|
|
281
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
282
|
+
// string
|
|
283
|
+
tableId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
284
|
+
} satisfies DeleteDataSourceTableRequest;
|
|
285
|
+
|
|
286
|
+
try {
|
|
287
|
+
const data = await api.deleteDataSourceTable(body);
|
|
288
|
+
console.log(data);
|
|
289
|
+
} catch (error) {
|
|
290
|
+
console.error(error);
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
// Run the test
|
|
295
|
+
example().catch(console.error);
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
| Name | Type | Description | Notes |
|
|
302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
303
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
304
|
+
| **tableId** | `string` | | [Defaults to `undefined`] |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
`void` (Empty response body)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: Not defined
|
|
317
|
+
- **Accept**: `application/json`
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### HTTP response details
|
|
321
|
+
| Status code | Description | Response headers |
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
| **204** | Successful Response | - |
|
|
324
|
+
| **422** | Validation Error | - |
|
|
325
|
+
| **0** | Error response. | - |
|
|
326
|
+
|
|
327
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
## generateDataSourceDescription
|
|
331
|
+
|
|
332
|
+
> DataSourceDescriptionResponse generateDataSourceDescription(dataSourceId)
|
|
333
|
+
|
|
334
|
+
Generate Data Source Description Handler
|
|
335
|
+
|
|
336
|
+
(Re)generate the connector\'s hidden, searchable \'Database overview\' Document. Requires ``can_write`` on the connector. The structural overview is deterministic; an LLM prose summary is prepended best-effort. The document ingests through the normal pipeline so the agent\'s semantic search finds it.
|
|
337
|
+
|
|
338
|
+
### Example
|
|
339
|
+
|
|
340
|
+
```ts
|
|
341
|
+
import {
|
|
342
|
+
Configuration,
|
|
343
|
+
DataSourcesApi,
|
|
344
|
+
} from '@knowledge-stack/ksapi';
|
|
345
|
+
import type { GenerateDataSourceDescriptionRequest } from '@knowledge-stack/ksapi';
|
|
346
|
+
|
|
347
|
+
async function example() {
|
|
348
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
349
|
+
const config = new Configuration({
|
|
350
|
+
// To configure API key authorization: cookieAuth
|
|
351
|
+
apiKey: "YOUR API KEY",
|
|
352
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
353
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
354
|
+
});
|
|
355
|
+
const api = new DataSourcesApi(config);
|
|
356
|
+
|
|
357
|
+
const body = {
|
|
358
|
+
// string
|
|
359
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
360
|
+
} satisfies GenerateDataSourceDescriptionRequest;
|
|
361
|
+
|
|
362
|
+
try {
|
|
363
|
+
const data = await api.generateDataSourceDescription(body);
|
|
364
|
+
console.log(data);
|
|
365
|
+
} catch (error) {
|
|
366
|
+
console.error(error);
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
// Run the test
|
|
371
|
+
example().catch(console.error);
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
| Name | Type | Description | Notes |
|
|
378
|
+
|------------- | ------------- | ------------- | -------------|
|
|
379
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
[**DataSourceDescriptionResponse**](DataSourceDescriptionResponse.md)
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: Not defined
|
|
392
|
+
- **Accept**: `application/json`
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
| **200** | Successful Response | - |
|
|
399
|
+
| **422** | Validation Error | - |
|
|
400
|
+
| **0** | Error response. | - |
|
|
401
|
+
|
|
402
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
403
|
+
|
|
404
|
+
|
|
169
405
|
## getDataSource
|
|
170
406
|
|
|
171
407
|
> DataSourceDetailResponse getDataSource(dataSourceId)
|
|
@@ -400,7 +636,7 @@ example().catch(console.error);
|
|
|
400
636
|
|
|
401
637
|
Model Data Source Table Handler
|
|
402
638
|
|
|
403
|
-
Model a table
|
|
639
|
+
Model a table under its (auto-created) Schema PDO; auto-introspect columns.
|
|
404
640
|
|
|
405
641
|
### Example
|
|
406
642
|
|
|
@@ -472,6 +708,84 @@ example().catch(console.error);
|
|
|
472
708
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
473
709
|
|
|
474
710
|
|
|
711
|
+
## modelDataSourceTables
|
|
712
|
+
|
|
713
|
+
> BulkModelTablesResponse modelDataSourceTables(dataSourceId, bulkModelTablesRequest)
|
|
714
|
+
|
|
715
|
+
Model Data Source Tables Handler
|
|
716
|
+
|
|
717
|
+
Import several tables across one or more schemas; per-item results. Schemas are auto find-or-created. Duplicates are pre-checked against the already-modeled tables and earlier items in the same batch (so a conflict never triggers a failed INSERT, which would otherwise roll back the batch\'s prior writes); introspection failures are reported per item. One bad item never aborts the batch.
|
|
718
|
+
|
|
719
|
+
### Example
|
|
720
|
+
|
|
721
|
+
```ts
|
|
722
|
+
import {
|
|
723
|
+
Configuration,
|
|
724
|
+
DataSourcesApi,
|
|
725
|
+
} from '@knowledge-stack/ksapi';
|
|
726
|
+
import type { ModelDataSourceTablesRequest } from '@knowledge-stack/ksapi';
|
|
727
|
+
|
|
728
|
+
async function example() {
|
|
729
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
730
|
+
const config = new Configuration({
|
|
731
|
+
// To configure API key authorization: cookieAuth
|
|
732
|
+
apiKey: "YOUR API KEY",
|
|
733
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
734
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
735
|
+
});
|
|
736
|
+
const api = new DataSourcesApi(config);
|
|
737
|
+
|
|
738
|
+
const body = {
|
|
739
|
+
// string
|
|
740
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
741
|
+
// BulkModelTablesRequest
|
|
742
|
+
bulkModelTablesRequest: ...,
|
|
743
|
+
} satisfies ModelDataSourceTablesRequest;
|
|
744
|
+
|
|
745
|
+
try {
|
|
746
|
+
const data = await api.modelDataSourceTables(body);
|
|
747
|
+
console.log(data);
|
|
748
|
+
} catch (error) {
|
|
749
|
+
console.error(error);
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
// Run the test
|
|
754
|
+
example().catch(console.error);
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
### Parameters
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
| Name | Type | Description | Notes |
|
|
761
|
+
|------------- | ------------- | ------------- | -------------|
|
|
762
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
763
|
+
| **bulkModelTablesRequest** | [BulkModelTablesRequest](BulkModelTablesRequest.md) | | |
|
|
764
|
+
|
|
765
|
+
### Return type
|
|
766
|
+
|
|
767
|
+
[**BulkModelTablesResponse**](BulkModelTablesResponse.md)
|
|
768
|
+
|
|
769
|
+
### Authorization
|
|
770
|
+
|
|
771
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
772
|
+
|
|
773
|
+
### HTTP request headers
|
|
774
|
+
|
|
775
|
+
- **Content-Type**: `application/json`
|
|
776
|
+
- **Accept**: `application/json`
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### HTTP response details
|
|
780
|
+
| Status code | Description | Response headers |
|
|
781
|
+
|-------------|-------------|------------------|
|
|
782
|
+
| **201** | Successful Response | - |
|
|
783
|
+
| **422** | Validation Error | - |
|
|
784
|
+
| **0** | Error response. | - |
|
|
785
|
+
|
|
786
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
787
|
+
|
|
788
|
+
|
|
475
789
|
## queryDataSource
|
|
476
790
|
|
|
477
791
|
> DataSourceQueryResponse queryDataSource(dataSourceId, dataSourceQueryRequest)
|
|
@@ -625,6 +939,84 @@ example().catch(console.error);
|
|
|
625
939
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
626
940
|
|
|
627
941
|
|
|
942
|
+
## updateDataSource
|
|
943
|
+
|
|
944
|
+
> DataSourceResponse updateDataSource(dataSourceId, updateDataSourceRequest)
|
|
945
|
+
|
|
946
|
+
Update Data Source Handler
|
|
947
|
+
|
|
948
|
+
Rename and/or move a connector. Requires ``can_write`` on the connector (and on the destination folder for a move).
|
|
949
|
+
|
|
950
|
+
### Example
|
|
951
|
+
|
|
952
|
+
```ts
|
|
953
|
+
import {
|
|
954
|
+
Configuration,
|
|
955
|
+
DataSourcesApi,
|
|
956
|
+
} from '@knowledge-stack/ksapi';
|
|
957
|
+
import type { UpdateDataSourceOperationRequest } from '@knowledge-stack/ksapi';
|
|
958
|
+
|
|
959
|
+
async function example() {
|
|
960
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
961
|
+
const config = new Configuration({
|
|
962
|
+
// To configure API key authorization: cookieAuth
|
|
963
|
+
apiKey: "YOUR API KEY",
|
|
964
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
965
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
966
|
+
});
|
|
967
|
+
const api = new DataSourcesApi(config);
|
|
968
|
+
|
|
969
|
+
const body = {
|
|
970
|
+
// string
|
|
971
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
972
|
+
// UpdateDataSourceRequest
|
|
973
|
+
updateDataSourceRequest: ...,
|
|
974
|
+
} satisfies UpdateDataSourceOperationRequest;
|
|
975
|
+
|
|
976
|
+
try {
|
|
977
|
+
const data = await api.updateDataSource(body);
|
|
978
|
+
console.log(data);
|
|
979
|
+
} catch (error) {
|
|
980
|
+
console.error(error);
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
|
|
984
|
+
// Run the test
|
|
985
|
+
example().catch(console.error);
|
|
986
|
+
```
|
|
987
|
+
|
|
988
|
+
### Parameters
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
| Name | Type | Description | Notes |
|
|
992
|
+
|------------- | ------------- | ------------- | -------------|
|
|
993
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
994
|
+
| **updateDataSourceRequest** | [UpdateDataSourceRequest](UpdateDataSourceRequest.md) | | |
|
|
995
|
+
|
|
996
|
+
### Return type
|
|
997
|
+
|
|
998
|
+
[**DataSourceResponse**](DataSourceResponse.md)
|
|
999
|
+
|
|
1000
|
+
### Authorization
|
|
1001
|
+
|
|
1002
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: `application/json`
|
|
1007
|
+
- **Accept**: `application/json`
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
### HTTP response details
|
|
1011
|
+
| Status code | Description | Response headers |
|
|
1012
|
+
|-------------|-------------|------------------|
|
|
1013
|
+
| **200** | Successful Response | - |
|
|
1014
|
+
| **422** | Validation Error | - |
|
|
1015
|
+
| **0** | Error response. | - |
|
|
1016
|
+
|
|
1017
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1018
|
+
|
|
1019
|
+
|
|
628
1020
|
## updateDataSourceTable
|
|
629
1021
|
|
|
630
1022
|
> DataSourceTableResponse updateDataSourceTable(dataSourceId, tableId, updateTableRequest)
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
|
|
2
|
+
# DocumentBlockChange
|
|
3
|
+
|
|
4
|
+
One changed block in a Word document, ordered by position. ``from_paragraph_index``/``to_paragraph_index`` are the 0-based position of the ``<w:p>`` in ``word/document.xml`` body (the same index citation anchors use, so the frontend aligns changes to its docx render). ``anchor_text`` is a text-match fallback for that alignment. ``old``/``new`` are null on the absent side; ``*_spans`` mark changed word ranges (CJK-aware).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`type` | [BlockChangeType](BlockChangeType.md)
|
|
11
|
+
`kind` | [BlockKind](BlockKind.md)
|
|
12
|
+
`changeClass` | [ChangeClass](ChangeClass.md)
|
|
13
|
+
`fromParagraphIndex` | number
|
|
14
|
+
`toParagraphIndex` | number
|
|
15
|
+
`oldText` | string
|
|
16
|
+
`newText` | string
|
|
17
|
+
`oldSpans` | [Array<DiffSpan>](DiffSpan.md)
|
|
18
|
+
`newSpans` | [Array<DiffSpan>](DiffSpan.md)
|
|
19
|
+
`formattingChanged` | boolean
|
|
20
|
+
`numericDelta` | string
|
|
21
|
+
`numericPct` | string
|
|
22
|
+
`anchorText` | string
|
|
23
|
+
`surface` | string
|
|
24
|
+
`cellChanges` | [Array<TableCellChange>](TableCellChange.md)
|
|
25
|
+
`revisions` | [Array<RevisionEdit>](RevisionEdit.md)
|
|
26
|
+
`oldImageRef` | string
|
|
27
|
+
`newImageRef` | string
|
|
28
|
+
`imageRegions` | [Array<PixelRegion>](PixelRegion.md)
|
|
29
|
+
`imageNote` | string
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import type { DocumentBlockChange } from '@knowledge-stack/ksapi'
|
|
35
|
+
|
|
36
|
+
// TODO: Update the object below with actual values
|
|
37
|
+
const example = {
|
|
38
|
+
"type": null,
|
|
39
|
+
"kind": null,
|
|
40
|
+
"changeClass": null,
|
|
41
|
+
"fromParagraphIndex": null,
|
|
42
|
+
"toParagraphIndex": null,
|
|
43
|
+
"oldText": null,
|
|
44
|
+
"newText": null,
|
|
45
|
+
"oldSpans": null,
|
|
46
|
+
"newSpans": null,
|
|
47
|
+
"formattingChanged": null,
|
|
48
|
+
"numericDelta": null,
|
|
49
|
+
"numericPct": null,
|
|
50
|
+
"anchorText": null,
|
|
51
|
+
"surface": null,
|
|
52
|
+
"cellChanges": null,
|
|
53
|
+
"revisions": null,
|
|
54
|
+
"oldImageRef": null,
|
|
55
|
+
"newImageRef": null,
|
|
56
|
+
"imageRegions": null,
|
|
57
|
+
"imageNote": null,
|
|
58
|
+
} satisfies DocumentBlockChange
|
|
59
|
+
|
|
60
|
+
console.log(example)
|
|
61
|
+
|
|
62
|
+
// Convert the instance to a JSON string
|
|
63
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
64
|
+
console.log(exampleJSON)
|
|
65
|
+
|
|
66
|
+
// Parse the JSON string back to an object
|
|
67
|
+
const exampleParsed = JSON.parse(exampleJSON) as DocumentBlockChange
|
|
68
|
+
console.log(exampleParsed)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
72
|
+
|
|
73
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
|
|
2
|
+
# DocumentDiff
|
|
3
|
+
|
|
4
|
+
A structured block diff of two Word (.docx) versions. ``added``/``removed``/``modified`` are full totals; ``blocks`` is capped and ``omitted_blocks`` reports exactly how many were dropped (never a silent cap). ``surfaces_checked`` attests which OOXML surfaces were diffed, ``unaccepted_revisions`` counts tracked changes present (the rendered text may not be final), and ``decode_degraded`` flags a partial parse.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`blocks` | [Array<DocumentBlockChange>](DocumentBlockChange.md)
|
|
11
|
+
`added` | number
|
|
12
|
+
`removed` | number
|
|
13
|
+
`modified` | number
|
|
14
|
+
`truncated` | boolean
|
|
15
|
+
`omittedBlocks` | number
|
|
16
|
+
`surfacesChecked` | Array<string>
|
|
17
|
+
`unacceptedRevisions` | number
|
|
18
|
+
`decodeDegraded` | boolean
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { DocumentDiff } from '@knowledge-stack/ksapi'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"blocks": null,
|
|
28
|
+
"added": null,
|
|
29
|
+
"removed": null,
|
|
30
|
+
"modified": null,
|
|
31
|
+
"truncated": null,
|
|
32
|
+
"omittedBlocks": null,
|
|
33
|
+
"surfacesChecked": null,
|
|
34
|
+
"unacceptedRevisions": null,
|
|
35
|
+
"decodeDegraded": null,
|
|
36
|
+
} satisfies DocumentDiff
|
|
37
|
+
|
|
38
|
+
console.log(example)
|
|
39
|
+
|
|
40
|
+
// Convert the instance to a JSON string
|
|
41
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
42
|
+
console.log(exampleJSON)
|
|
43
|
+
|
|
44
|
+
// Parse the JSON string back to an object
|
|
45
|
+
const exampleParsed = JSON.parse(exampleJSON) as DocumentDiff
|
|
46
|
+
console.log(exampleParsed)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
50
|
+
|
|
51
|
+
|
|
@@ -567,7 +567,7 @@ example().catch(console.error);
|
|
|
567
567
|
|
|
568
568
|
Get Document Version Diff Handler
|
|
569
569
|
|
|
570
|
-
Side-by-side diff of a version against a previous one of the same document. Diffs the two versions
|
|
570
|
+
Side-by-side diff of a version against a previous one of the same document. Diffs the two versions on the fly (no stored diff), so any pair of versions can be compared. ``from_version_id`` defaults to the immediate predecessor; the first version diffs against empty (all additions). Requires read permission on both versions. Viewing a diff is a sensitive read, so it emits a ``document.diff.viewed`` audit event (a durable write on this GET, by design — like a download).
|
|
571
571
|
|
|
572
572
|
### Example
|
|
573
573
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -51,8 +51,11 @@ Name | Type
|
|
|
51
51
|
`runThreadId` | string
|
|
52
52
|
`engine` | [DataSourceEngine](DataSourceEngine.md)
|
|
53
53
|
`dataSourceId` | string
|
|
54
|
-
`tableName` | string
|
|
55
54
|
`schemaName` | string
|
|
55
|
+
`isDefault` | boolean
|
|
56
|
+
`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
|
|
57
|
+
`dataSourceSchemaId` | string
|
|
58
|
+
`tableName` | string
|
|
56
59
|
`columnConfig` | Array<{ [key: string]: any; }>
|
|
57
60
|
`baseUrl` | string
|
|
58
61
|
`networkClass` | [NetworkClass](NetworkClass.md)
|
|
@@ -64,7 +67,7 @@ Name | Type
|
|
|
64
67
|
## Example
|
|
65
68
|
|
|
66
69
|
```typescript
|
|
67
|
-
import type {
|
|
70
|
+
import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
|
|
68
71
|
|
|
69
72
|
// TODO: Update the object below with actual values
|
|
70
73
|
const example = {
|
|
@@ -113,8 +116,11 @@ const example = {
|
|
|
113
116
|
"runThreadId": null,
|
|
114
117
|
"engine": null,
|
|
115
118
|
"dataSourceId": null,
|
|
116
|
-
"tableName": null,
|
|
117
119
|
"schemaName": null,
|
|
120
|
+
"isDefault": null,
|
|
121
|
+
"tables": null,
|
|
122
|
+
"dataSourceSchemaId": null,
|
|
123
|
+
"tableName": null,
|
|
118
124
|
"columnConfig": null,
|
|
119
125
|
"baseUrl": null,
|
|
120
126
|
"networkClass": null,
|
|
@@ -122,7 +128,7 @@ const example = {
|
|
|
122
128
|
"apiDocs": null,
|
|
123
129
|
"disclaimerAcceptedAt": null,
|
|
124
130
|
"disclaimerAcceptedBy": null,
|
|
125
|
-
} satisfies
|
|
131
|
+
} satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
126
132
|
|
|
127
133
|
console.log(example)
|
|
128
134
|
|
|
@@ -131,7 +137,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
131
137
|
console.log(exampleJSON)
|
|
132
138
|
|
|
133
139
|
// Parse the JSON string back to an object
|
|
134
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
140
|
+
const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
135
141
|
console.log(exampleParsed)
|
|
136
142
|
```
|
|
137
143
|
|
package/docs/FoldersApi.md
CHANGED
|
@@ -321,7 +321,7 @@ example().catch(console.error);
|
|
|
321
321
|
|
|
322
322
|
## listFolderContents
|
|
323
323
|
|
|
324
|
-
>
|
|
324
|
+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset)
|
|
325
325
|
|
|
326
326
|
List Folder Contents Handler
|
|
327
327
|
|
|
@@ -387,7 +387,7 @@ example().catch(console.error);
|
|
|
387
387
|
|
|
388
388
|
### Return type
|
|
389
389
|
|
|
390
|
-
[**
|
|
390
|
+
[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
|
|
391
391
|
|
|
392
392
|
### Authorization
|
|
393
393
|
|
|
@@ -516,7 +516,7 @@ example().catch(console.error);
|
|
|
516
516
|
|
|
517
517
|
## searchItems
|
|
518
518
|
|
|
519
|
-
>
|
|
519
|
+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
|
|
520
520
|
|
|
521
521
|
Search Items Handler
|
|
522
522
|
|
|
@@ -577,7 +577,7 @@ example().catch(console.error);
|
|
|
577
577
|
|------------- | ------------- | ------------- | -------------|
|
|
578
578
|
| **nameLike** | `string` | Case-insensitive partial name search | [Defaults to `undefined`] |
|
|
579
579
|
| **sortOrder** | `SearchSortOrder` | Sort order for results (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, UPDATED_AT, CREATED_AT] |
|
|
580
|
-
| **partType** | `SearchablePartType` | Filter by item type (default: all searchable types) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, API_CONNECTION] |
|
|
580
|
+
| **partType** | `SearchablePartType` | Filter by item type (default: all searchable types) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION] |
|
|
581
581
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
582
582
|
| **parentPathPartId** | `string` | Scope search to descendants of this folder\'s path part | [Optional] [Defaults to `undefined`] |
|
|
583
583
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
@@ -585,7 +585,7 @@ example().catch(console.error);
|
|
|
585
585
|
|
|
586
586
|
### Return type
|
|
587
587
|
|
|
588
|
-
[**
|
|
588
|
+
[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
|
|
589
589
|
|
|
590
590
|
### Authorization
|
|
591
591
|
|