@knowledge-stack/ksapi 1.95.4 → 1.96.0

package/docs/DataSourceDetailResponse.md

@@ -0,0 +1,37 @@
+
+# DataSourceDetailResponse
+
+A connector plus the modeled tables the caller can read (describe).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dataSource` | [DataSourceResponse](DataSourceResponse.md)
+`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
+
+## Example
+
+```typescript
+import type { DataSourceDetailResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dataSource": null,
+  "tables": null,
+} satisfies DataSourceDetailResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceDetailResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceEngine.md

@@ -0,0 +1,33 @@
+
+# DataSourceEngine
+
+SQL engine backing a data-source connector.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DataSourceEngine } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DataSourceEngine
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceEngine
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceQueryRequest.md

@@ -0,0 +1,37 @@
+
+# DataSourceQueryRequest
+
+A read-only SQL query the caller (or agent) wrote.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sql` | string
+`maxRows` | number
+
+## Example
+
+```typescript
+import type { DataSourceQueryRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sql": null,
+  "maxRows": null,
+} satisfies DataSourceQueryRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceQueryRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceQueryResponse.md

@@ -0,0 +1,43 @@
+
+# DataSourceQueryResponse
+
+Read-only query result. ``generated_sql`` echoes the executed SQL.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`columns` | Array<string>
+`rows` | Array<Array<any>>
+`rowCount` | number
+`truncated` | boolean
+`generatedSql` | string
+
+## Example
+
+```typescript
+import type { DataSourceQueryResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "columns": null,
+  "rows": null,
+  "rowCount": null,
+  "truncated": null,
+  "generatedSql": null,
+} satisfies DataSourceQueryResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceQueryResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceResponse.md

@@ -0,0 +1,55 @@
+
+# DataSourceResponse
+
+Connector response; a discriminated-union variant for folder listings.  The ``connection_config`` (host/port/credentials) is intentionally omitted — the password is write-only and never serialized back.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`id` | string
+`pathPartId` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`tenantId` | string
+`name` | string
+`engine` | [DataSourceEngine](DataSourceEngine.md)
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { DataSourceResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "partType": null,
+  "id": null,
+  "pathPartId": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "tenantId": null,
+  "name": null,
+  "engine": null,
+  "approvalState": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies DataSourceResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DataSourceTableResponse.md

@@ -0,0 +1,61 @@
+
+# DataSourceTableResponse
+
+Modeled-table response; a discriminated-union variant for listings.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`id` | string
+`pathPartId` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`tenantId` | string
+`name` | string
+`dataSourceId` | string
+`tableName` | string
+`description` | string
+`columnConfig` | Array<{ [key: string]: any; }>
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { DataSourceTableResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "partType": null,
+  "id": null,
+  "pathPartId": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "tenantId": null,
+  "name": null,
+  "dataSourceId": null,
+  "tableName": null,
+  "description": null,
+  "columnConfig": null,
+  "approvalState": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies DataSourceTableResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DataSourceTableResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+