@knowledge-stack/ksapi 1.118.0 → 1.120.0

package/src/models/DataSourceDetailResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
+import {
+    DataSourceSchemaResponseFromJSON,
+    DataSourceSchemaResponseFromJSONTyped,
+    DataSourceSchemaResponseToJSON,
+    DataSourceSchemaResponseToJSONTyped,
+} from './DataSourceSchemaResponse';
 import type { DataSourceResponse } from './DataSourceResponse';
 import {
     DataSourceResponseFromJSON,
@@ -20,16 +27,12 @@ import {
     DataSourceResponseToJSON,
     DataSourceResponseToJSONTyped,
 } from './DataSourceResponse';
-import type { DataSourceTableResponse } from './DataSourceTableResponse';
-import {
-    DataSourceTableResponseFromJSON,
-    DataSourceTableResponseFromJSONTyped,
-    DataSourceTableResponseToJSON,
-    DataSourceTableResponseToJSONTyped,
-} from './DataSourceTableResponse';
 
 /**
- * A connector plus the modeled tables the caller can read (describe).
+ * A connector plus the schemas (and their readable tables) the caller sees.
+ * 
+ * ``description_document_id`` points at the connector's generated, ingested
+ * "Database overview" Document (a hidden system file); null until generated.
  * @export
  * @interface DataSourceDetailResponse
  */
@@ -42,10 +45,16 @@ export interface DataSourceDetailResponse {
     dataSource: DataSourceResponse;
     /**
      * 
-     * @type {Array<DataSourceTableResponse>}
+     * @type {Array<DataSourceSchemaResponse>}
+     * @memberof DataSourceDetailResponse
+     */
+    schemas: Array<DataSourceSchemaResponse>;
+    /**
+     * 
+     * @type {string}
      * @memberof DataSourceDetailResponse
      */
-    tables: Array<DataSourceTableResponse>;
+    descriptionDocumentId?: string | null;
 }
 export const DataSourceDetailResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,7 +79,7 @@ export const DataSourceDetailResponsePropertyValidationAttributesMap: {
  */
 export function instanceOfDataSourceDetailResponse(value: object): value is DataSourceDetailResponse {
     if (!('dataSource' in value) || value['dataSource'] === undefined) return false;
-    if (!('tables' in value) || value['tables'] === undefined) return false;
+    if (!('schemas' in value) || value['schemas'] === undefined) return false;
     return true;
 }
 
@@ -85,7 +94,8 @@ export function DataSourceDetailResponseFromJSONTyped(json: any, ignoreDiscrimin
     return {
         
         'dataSource': DataSourceResponseFromJSON(json['data_source']),
-        'tables': ((json['tables'] as Array<any>).map(DataSourceTableResponseFromJSON)),
+        'schemas': ((json['schemas'] as Array<any>).map(DataSourceSchemaResponseFromJSON)),
+        'descriptionDocumentId': json['description_document_id'] == null ? undefined : json['description_document_id'],
     };
 }
 
@@ -101,7 +111,8 @@ export function DataSourceDetailResponseToJSONTyped(value?: DataSourceDetailResp
     return {
         
         'data_source': DataSourceResponseToJSON(value['dataSource']),
-        'tables': ((value['tables'] as Array<any>).map(DataSourceTableResponseToJSON)),
+        'schemas': ((value['schemas'] as Array<any>).map(DataSourceSchemaResponseToJSON)),
+        'description_document_id': value['descriptionDocumentId'],
     };
 }
 

package/src/models/DataSourceSchemaListItem.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A namespace discovered by live introspection (not a persisted PDO).
+ * @export
+ * @interface DataSourceSchemaListItem
+ */
+export interface DataSourceSchemaListItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceSchemaListItem
+     */
+    name: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataSourceSchemaListItem
+     */
+    isDefault: boolean;
+}
+export const DataSourceSchemaListItemPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the DataSourceSchemaListItem interface.
+ */
+export function instanceOfDataSourceSchemaListItem(value: object): value is DataSourceSchemaListItem {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceSchemaListItemFromJSON(json: any): DataSourceSchemaListItem {
+    return DataSourceSchemaListItemFromJSONTyped(json, false);
+}
+
+export function DataSourceSchemaListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'isDefault': json['is_default'],
+    };
+}
+
+export function DataSourceSchemaListItemToJSON(json: any): DataSourceSchemaListItem {
+    return DataSourceSchemaListItemToJSONTyped(json, false);
+}
+
+export function DataSourceSchemaListItemToJSONTyped(value?: DataSourceSchemaListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'is_default': value['isDefault'],
+    };
+}
+

package/src/models/DataSourceSchemaListResponse.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
+import type { DataSourceSchemaListItem } from './DataSourceSchemaListItem';
 import {
-    DataSourceSchemaResponseFromJSON,
-    DataSourceSchemaResponseFromJSONTyped,
-    DataSourceSchemaResponseToJSON,
-    DataSourceSchemaResponseToJSONTyped,
-} from './DataSourceSchemaResponse';
+    DataSourceSchemaListItemFromJSON,
+    DataSourceSchemaListItemFromJSONTyped,
+    DataSourceSchemaListItemToJSON,
+    DataSourceSchemaListItemToJSONTyped,
+} from './DataSourceSchemaListItem';
 
 /**
  * The source's user namespaces (PG schemas / MySQL databases).
@@ -29,10 +29,10 @@ import {
 export interface DataSourceSchemaListResponse {
     /**
      * 
-     * @type {Array<DataSourceSchemaResponse>}
+     * @type {Array<DataSourceSchemaListItem>}
      * @memberof DataSourceSchemaListResponse
      */
-    schemas: Array<DataSourceSchemaResponse>;
+    schemas: Array<DataSourceSchemaListItem>;
 }
 export const DataSourceSchemaListResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,7 +70,7 @@ export function DataSourceSchemaListResponseFromJSONTyped(json: any, ignoreDiscr
     }
     return {
         
-        'schemas': ((json['schemas'] as Array<any>).map(DataSourceSchemaResponseFromJSON)),
+        'schemas': ((json['schemas'] as Array<any>).map(DataSourceSchemaListItemFromJSON)),
     };
 }
 
@@ -85,7 +85,7 @@ export function DataSourceSchemaListResponseToJSONTyped(value?: DataSourceSchema
 
     return {
         
-        'schemas': ((value['schemas'] as Array<any>).map(DataSourceSchemaResponseToJSON)),
+        'schemas': ((value['schemas'] as Array<any>).map(DataSourceSchemaListItemToJSON)),
     };
 }
 

package/src/models/DataSourceSchemaResponse.ts

@@ -13,12 +13,70 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ItemPermissions } from './ItemPermissions';
+import {
+    ItemPermissionsFromJSON,
+    ItemPermissionsFromJSONTyped,
+    ItemPermissionsToJSON,
+    ItemPermissionsToJSONTyped,
+} from './ItemPermissions';
+import type { PathPartApprovalState } from './PathPartApprovalState';
+import {
+    PathPartApprovalStateFromJSON,
+    PathPartApprovalStateFromJSONTyped,
+    PathPartApprovalStateToJSON,
+    PathPartApprovalStateToJSONTyped,
+} from './PathPartApprovalState';
+import type { DataSourceTableResponse } from './DataSourceTableResponse';
+import {
+    DataSourceTableResponseFromJSON,
+    DataSourceTableResponseFromJSONTyped,
+    DataSourceTableResponseToJSON,
+    DataSourceTableResponseToJSONTyped,
+} from './DataSourceTableResponse';
+
 /**
- * 
+ * A schema PDO under a connector, with the readable tables it contains.
  * @export
  * @interface DataSourceSchemaResponse
  */
 export interface DataSourceSchemaResponse {
+    /**
+     * Path part type
+     * @type {DataSourceSchemaResponsePartTypeEnum}
+     * @memberof DataSourceSchemaResponse
+     */
+    partType?: DataSourceSchemaResponsePartTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    id: string;
+    /**
+     * DATA_SOURCE_SCHEMA path_part of this schema
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    pathPartId: string;
+    /**
+     * DATA_SOURCE path_part of the parent connector
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    tenantId: string;
     /**
      * 
      * @type {string}
@@ -27,11 +85,69 @@ export interface DataSourceSchemaResponse {
     name: string;
     /**
      * 
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    dataSourceId: string;
+    /**
+     * Real namespace in the external DB
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    schemaName: string;
+    /**
+     * True for the connection's default namespace
      * @type {boolean}
      * @memberof DataSourceSchemaResponse
      */
     isDefault: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    description: string | null;
+    /**
+     * 
+     * @type {PathPartApprovalState}
+     * @memberof DataSourceSchemaResponse
+     */
+    approvalState: PathPartApprovalState;
+    /**
+     * 
+     * @type {ItemPermissions}
+     * @memberof DataSourceSchemaResponse
+     */
+    permissions: ItemPermissions;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceSchemaResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceSchemaResponse
+     */
+    updatedAt: Date;
+    /**
+     * Readable modeled tables in this schema
+     * @type {Array<DataSourceTableResponse>}
+     * @memberof DataSourceSchemaResponse
+     */
+    tables?: Array<DataSourceTableResponse>;
 }
+
+
+/**
+ * @export
+ */
+export const DataSourceSchemaResponsePartTypeEnum = {
+    DataSourceSchema: 'DATA_SOURCE_SCHEMA'
+} as const;
+export type DataSourceSchemaResponsePartTypeEnum = typeof DataSourceSchemaResponsePartTypeEnum[keyof typeof DataSourceSchemaResponsePartTypeEnum];
+
 export const DataSourceSchemaResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
@@ -54,8 +170,20 @@ export const DataSourceSchemaResponsePropertyValidationAttributesMap: {
  * Check if a given object implements the DataSourceSchemaResponse interface.
  */
 export function instanceOfDataSourceSchemaResponse(value: object): value is DataSourceSchemaResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('dataSourceId' in value) || value['dataSourceId'] === undefined) return false;
+    if (!('schemaName' in value) || value['schemaName'] === undefined) return false;
     if (!('isDefault' in value) || value['isDefault'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('approvalState' in value) || value['approvalState'] === undefined) return false;
+    if (!('permissions' in value) || value['permissions'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
 }
 
@@ -69,8 +197,22 @@ export function DataSourceSchemaResponseFromJSONTyped(json: any, ignoreDiscrimin
     }
     return {
         
+        'partType': json['part_type'] == null ? undefined : json['part_type'],
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'tenantId': json['tenant_id'],
         'name': json['name'],
+        'dataSourceId': json['data_source_id'],
+        'schemaName': json['schema_name'],
         'isDefault': json['is_default'],
+        'description': json['description'],
+        'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+        'permissions': ItemPermissionsFromJSON(json['permissions']),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'tables': json['tables'] == null ? undefined : ((json['tables'] as Array<any>).map(DataSourceTableResponseFromJSON)),
     };
 }
 
@@ -85,8 +227,22 @@ export function DataSourceSchemaResponseToJSONTyped(value?: DataSourceSchemaResp
 
     return {
         
+        'part_type': value['partType'],
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'materialized_path': value['materializedPath'],
+        'tenant_id': value['tenantId'],
         'name': value['name'],
+        'data_source_id': value['dataSourceId'],
+        'schema_name': value['schemaName'],
         'is_default': value['isDefault'],
+        'description': value['description'],
+        'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+        'permissions': ItemPermissionsToJSON(value['permissions']),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+        'tables': value['tables'] == null ? undefined : ((value['tables'] as Array<any>).map(DataSourceTableResponseToJSON)),
     };
 }
 

package/src/models/DataSourceTableResponse.ts

@@ -30,6 +30,9 @@ import {
 
 /**
  * Modeled-table response; a discriminated-union variant for listings.
+ * 
+ * The table's schema is its parent ``DataSourceSchema`` PDO; the table no
+ * longer carries a ``schema_name`` of its own.
  * @export
  * @interface DataSourceTableResponse
  */
@@ -53,7 +56,7 @@ export interface DataSourceTableResponse {
      */
     pathPartId: string;
     /**
-     * DATA_SOURCE path_part of the parent connector
+     * DATA_SOURCE_SCHEMA path_part of the parent schema
      * @type {string}
      * @memberof DataSourceTableResponse
      */
@@ -83,17 +86,17 @@ export interface DataSourceTableResponse {
      */
     dataSourceId: string;
     /**
-     * 
+     * PDO id of the parent schema this table belongs to
      * @type {string}
      * @memberof DataSourceTableResponse
      */
-    tableName: string;
+    dataSourceSchemaId: string;
     /**
-     * Schema/namespace in the external DB; null = default schema
+     * 
      * @type {string}
      * @memberof DataSourceTableResponse
      */
-    schemaName?: string | null;
+    tableName: string;
     /**
      * 
      * @type {string}
@@ -170,6 +173,7 @@ export function instanceOfDataSourceTableResponse(value: object): value is DataS
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('dataSourceId' in value) || value['dataSourceId'] === undefined) return false;
+    if (!('dataSourceSchemaId' in value) || value['dataSourceSchemaId'] === undefined) return false;
     if (!('tableName' in value) || value['tableName'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('columnConfig' in value) || value['columnConfig'] === undefined) return false;
@@ -198,8 +202,8 @@ export function DataSourceTableResponseFromJSONTyped(json: any, ignoreDiscrimina
         'tenantId': json['tenant_id'],
         'name': json['name'],
         'dataSourceId': json['data_source_id'],
+        'dataSourceSchemaId': json['data_source_schema_id'],
         'tableName': json['table_name'],
-        'schemaName': json['schema_name'] == null ? undefined : json['schema_name'],
         'description': json['description'],
         'columnConfig': json['column_config'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
@@ -228,8 +232,8 @@ export function DataSourceTableResponseToJSONTyped(value?: DataSourceTableRespon
         'tenant_id': value['tenantId'],
         'name': value['name'],
         'data_source_id': value['dataSourceId'],
+        'data_source_schema_id': value['dataSourceSchemaId'],
         'table_name': value['tableName'],
-        'schema_name': value['schemaName'],
         'description': value['description'],
         'column_config': value['columnConfig'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),

package/src/models/DiffFormat.ts

@@ -19,7 +19,9 @@
  */
 export const DiffFormat = {
     Text: 'text',
-    Cells: 'cells'
+    Cells: 'cells',
+    Structured: 'structured',
+    Document: 'document'
 } as const;
 export type DiffFormat = typeof DiffFormat[keyof typeof DiffFormat];