@knowledge-stack/ksapi 1.111.0 → 1.112.0

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -297,7 +297,7 @@ export interface DocumentVersionsApiInterface {
      */
     updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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``).
      * @summary Update Document Version Metadata Handler
      * @param {string} versionId DocumentVersion ID
      * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
@@ -307,7 +307,7 @@ export interface DocumentVersionsApiInterface {
      */
     updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
     /**
-     * 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.
+     * 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``).
      * Update Document Version Metadata Handler
      */
     updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
@@ -445,12 +445,12 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
      */
     updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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``).
      * Update Document Version Metadata Handler
      */
     updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
     /**
-     * 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.
+     * 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``).
      * Update Document Version Metadata Handler
      */
     updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;

package/dist/esm/apis/DocumentVersionsApi.js

@@ -544,7 +544,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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``).
      * Update Document Version Metadata Handler
      */
     updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
@@ -555,7 +555,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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``).
      * Update Document Version Metadata Handler
      */
     updateDocumentVersionMetadata(requestParameters, initOverrides) {

package/dist/esm/apis/WorkflowDefinitionsApi.d.ts

@@ -19,6 +19,8 @@ export interface CreateWorkflowRunRequest {
     files?: Array<Blob>;
     inputScope?: string | null;
     idempotencyKey?: string | null;
+    autoStart?: boolean;
+    userMessage?: string | null;
 }
 export interface DeleteWorkflowDefinitionRequest {
     definitionId: string;
@@ -90,6 +92,8 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {Array<Blob>} [files] 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.
      * @param {string} [inputScope] 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.
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
+     * @param {boolean} [autoStart] 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.
+     * @param {string} [userMessage] 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.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface
      */
@@ -101,6 +105,8 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {Array<Blob>} [files] 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.
      * @param {string} [inputScope] 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.
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
+     * @param {boolean} [autoStart] 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.
+     * @param {string} [userMessage] 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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface

package/dist/esm/apis/WorkflowDefinitionsApi.js

@@ -116,6 +116,12 @@ export class WorkflowDefinitionsApi extends runtime.BaseAPI {
             if (requestParameters['idempotencyKey'] != null) {
                 formParams.append('idempotency_key', requestParameters['idempotencyKey']);
             }
+            if (requestParameters['autoStart'] != null) {
+                formParams.append('auto_start', requestParameters['autoStart']);
+            }
+            if (requestParameters['userMessage'] != null) {
+                formParams.append('user_message', requestParameters['userMessage']);
+            }
             let urlPath = `/v1/workflow-definitions/{definition_id}/runs`;
             urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
             return {

package/dist/esm/apis/WorkflowRunsApi.d.ts

@@ -300,7 +300,7 @@ export interface WorkflowRunsApiInterface {
      */
     updateWorkflowRunRequestOpts(requestParameters: UpdateWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * @summary Update Workflow Run Handler
      * @param {string} runId
      * @param {UpdateWorkflowRunRequest} updateWorkflowRunRequest
@@ -310,7 +310,7 @@ export interface WorkflowRunsApiInterface {
      */
     updateWorkflowRunRaw(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * Update Workflow Run Handler
      */
     updateWorkflowRun(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
@@ -469,12 +469,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
      */
     updateWorkflowRunRequestOpts(requestParameters: UpdateWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * Update Workflow Run Handler
      */
     updateWorkflowRunRaw(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * Update Workflow Run Handler
      */
     updateWorkflowRun(requestParameters: UpdateWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;

package/dist/esm/apis/WorkflowRunsApi.js

@@ -538,7 +538,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * Update Workflow Run Handler
      */
     updateWorkflowRunRaw(requestParameters, initOverrides) {
@@ -549,7 +549,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Edit a NOT_STARTED run\'s KB scope, name, and / or auto_start.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` or ``PENDING`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.  Arming ``auto_start`` on a run that is already ``NOT_STARTED`` (its inputs have settled) dispatches it immediately — the run would otherwise never receive an ingestion-completion hook to start it. A ``PENDING`` run is left to auto-advance when its uploads finish.
      * Update Workflow Run Handler
      */
     updateWorkflowRun(requestParameters, initOverrides) {

package/dist/esm/models/CatalogColumnResponse.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ColumnReference } from './ColumnReference';
 /**
  *
  * @export
@@ -33,6 +34,12 @@ export interface CatalogColumnResponse {
      * @memberof CatalogColumnResponse
      */
     isPk: boolean;
+    /**
+     *
+     * @type {ColumnReference}
+     * @memberof CatalogColumnResponse
+     */
+    references?: ColumnReference | null;
 }
 export declare const CatalogColumnResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/CatalogColumnResponse.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ColumnReferenceFromJSON, ColumnReferenceToJSON, } from './ColumnReference';
 export const CatalogColumnResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the CatalogColumnResponse interface.
@@ -35,6 +36,7 @@ export function CatalogColumnResponseFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'dataType': json['data_type'],
         'isPk': json['is_pk'],
+        'references': json['references'] == null ? undefined : ColumnReferenceFromJSON(json['references']),
     };
 }
 export function CatalogColumnResponseToJSON(json) {
@@ -48,5 +50,6 @@ export function CatalogColumnResponseToJSONTyped(value, ignoreDiscriminator = fa
         'name': value['name'],
         'data_type': value['dataType'],
         'is_pk': value['isPk'],
+        'references': ColumnReferenceToJSON(value['references']),
     };
 }

package/dist/esm/models/CatalogTableResponse.d.ts

@@ -22,6 +22,12 @@ export interface CatalogTableResponse {
      * @memberof CatalogTableResponse
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogTableResponse
+     */
+    schemaName: string;
     /**
      *
      * @type {Array<CatalogColumnResponse>}

package/dist/esm/models/CatalogTableResponse.js

@@ -19,6 +19,8 @@ export const CatalogTableResponsePropertyValidationAttributesMap = {};
 export function instanceOfCatalogTableResponse(value) {
     if (!('name' in value) || value['name'] === undefined)
         return false;
+    if (!('schemaName' in value) || value['schemaName'] === undefined)
+        return false;
     if (!('columns' in value) || value['columns'] === undefined)
         return false;
     return true;
@@ -32,6 +34,7 @@ export function CatalogTableResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
+        'schemaName': json['schema_name'],
         'columns': (json['columns'].map(CatalogColumnResponseFromJSON)),
     };
 }
@@ -44,6 +47,7 @@ export function CatalogTableResponseToJSONTyped(value, ignoreDiscriminator = fal
     }
     return {
         'name': value['name'],
+        'schema_name': value['schemaName'],
         'columns': (value['columns'].map(CatalogColumnResponseToJSON)),
     };
 }

package/dist/esm/models/ColumnConfig.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ColumnReference } from './ColumnReference';
 /**
  * A modeled column. Only ``exposed`` columns are surfaced to the agent.
  * @export
@@ -45,6 +46,12 @@ export interface ColumnConfig {
      * @memberof ColumnConfig
      */
     exposed?: boolean;
+    /**
+     *
+     * @type {ColumnReference}
+     * @memberof ColumnConfig
+     */
+    references?: ColumnReference | null;
 }
 export declare const ColumnConfigPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/ColumnConfig.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ColumnReferenceFromJSON, ColumnReferenceToJSON, } from './ColumnReference';
 export const ColumnConfigPropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the ColumnConfig interface.
@@ -33,6 +34,7 @@ export function ColumnConfigFromJSONTyped(json, ignoreDiscriminator) {
         'comment': json['comment'] == null ? undefined : json['comment'],
         'isPk': json['is_pk'] == null ? undefined : json['is_pk'],
         'exposed': json['exposed'] == null ? undefined : json['exposed'],
+        'references': json['references'] == null ? undefined : ColumnReferenceFromJSON(json['references']),
     };
 }
 export function ColumnConfigToJSON(json) {
@@ -48,5 +50,6 @@ export function ColumnConfigToJSONTyped(value, ignoreDiscriminator = false) {
         'comment': value['comment'],
         'is_pk': value['isPk'],
         'exposed': value['exposed'],
+        'references': ColumnReferenceToJSON(value['references']),
     };
 }

package/dist/esm/models/ColumnReference.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * The table+column a foreign-key column points at.
+ * @export
+ * @interface ColumnReference
+ */
+export interface ColumnReference {
+    /**
+     *
+     * @type {string}
+     * @memberof ColumnReference
+     */
+    schemaName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ColumnReference
+     */
+    table: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ColumnReference
+     */
+    column: string;
+}
+export declare const ColumnReferencePropertyValidationAttributesMap: {
+    [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 ColumnReference interface.
+ */
+export declare function instanceOfColumnReference(value: object): value is ColumnReference;
+export declare function ColumnReferenceFromJSON(json: any): ColumnReference;
+export declare function ColumnReferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnReference;
+export declare function ColumnReferenceToJSON(json: any): ColumnReference;
+export declare function ColumnReferenceToJSONTyped(value?: ColumnReference | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ColumnReference.js

@@ -0,0 +1,50 @@
+/* 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.
+ */
+export const ColumnReferencePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ColumnReference interface.
+ */
+export function instanceOfColumnReference(value) {
+    if (!('table' in value) || value['table'] === undefined)
+        return false;
+    if (!('column' in value) || value['column'] === undefined)
+        return false;
+    return true;
+}
+export function ColumnReferenceFromJSON(json) {
+    return ColumnReferenceFromJSONTyped(json, false);
+}
+export function ColumnReferenceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'schemaName': json['schema_name'] == null ? undefined : json['schema_name'],
+        'table': json['table'],
+        'column': json['column'],
+    };
+}
+export function ColumnReferenceToJSON(json) {
+    return ColumnReferenceToJSONTyped(json, false);
+}
+export function ColumnReferenceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'schema_name': value['schemaName'],
+        'table': value['table'],
+        'column': value['column'],
+    };
+}

package/dist/esm/models/DataSourceSchemaListResponse.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
+/**
+ * The source's user namespaces (PG schemas / MySQL databases).
+ * @export
+ * @interface DataSourceSchemaListResponse
+ */
+export interface DataSourceSchemaListResponse {
+    /**
+     *
+     * @type {Array<DataSourceSchemaResponse>}
+     * @memberof DataSourceSchemaListResponse
+     */
+    schemas: Array<DataSourceSchemaResponse>;
+}
+export declare const DataSourceSchemaListResponsePropertyValidationAttributesMap: {
+    [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 DataSourceSchemaListResponse interface.
+ */
+export declare function instanceOfDataSourceSchemaListResponse(value: object): value is DataSourceSchemaListResponse;
+export declare function DataSourceSchemaListResponseFromJSON(json: any): DataSourceSchemaListResponse;
+export declare function DataSourceSchemaListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaListResponse;
+export declare function DataSourceSchemaListResponseToJSON(json: any): DataSourceSchemaListResponse;
+export declare function DataSourceSchemaListResponseToJSONTyped(value?: DataSourceSchemaListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DataSourceSchemaListResponse.js

@@ -0,0 +1,45 @@
+/* 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 { DataSourceSchemaResponseFromJSON, DataSourceSchemaResponseToJSON, } from './DataSourceSchemaResponse';
+export const DataSourceSchemaListResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DataSourceSchemaListResponse interface.
+ */
+export function instanceOfDataSourceSchemaListResponse(value) {
+    if (!('schemas' in value) || value['schemas'] === undefined)
+        return false;
+    return true;
+}
+export function DataSourceSchemaListResponseFromJSON(json) {
+    return DataSourceSchemaListResponseFromJSONTyped(json, false);
+}
+export function DataSourceSchemaListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'schemas': (json['schemas'].map(DataSourceSchemaResponseFromJSON)),
+    };
+}
+export function DataSourceSchemaListResponseToJSON(json) {
+    return DataSourceSchemaListResponseToJSONTyped(json, false);
+}
+export function DataSourceSchemaListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'schemas': (value['schemas'].map(DataSourceSchemaResponseToJSON)),
+    };
+}

package/dist/esm/models/DataSourceSchemaResponse.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DataSourceSchemaResponse
+ */
+export interface DataSourceSchemaResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DataSourceSchemaResponse
+     */
+    isDefault: boolean;
+}
+export declare const DataSourceSchemaResponsePropertyValidationAttributesMap: {
+    [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 DataSourceSchemaResponse interface.
+ */
+export declare function instanceOfDataSourceSchemaResponse(value: object): value is DataSourceSchemaResponse;
+export declare function DataSourceSchemaResponseFromJSON(json: any): DataSourceSchemaResponse;
+export declare function DataSourceSchemaResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaResponse;
+export declare function DataSourceSchemaResponseToJSON(json: any): DataSourceSchemaResponse;
+export declare function DataSourceSchemaResponseToJSONTyped(value?: DataSourceSchemaResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DataSourceSchemaResponse.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+export const DataSourceSchemaResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DataSourceSchemaResponse interface.
+ */
+export function instanceOfDataSourceSchemaResponse(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined)
+        return false;
+    return true;
+}
+export function DataSourceSchemaResponseFromJSON(json) {
+    return DataSourceSchemaResponseFromJSONTyped(json, false);
+}
+export function DataSourceSchemaResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'isDefault': json['is_default'],
+    };
+}
+export function DataSourceSchemaResponseToJSON(json) {
+    return DataSourceSchemaResponseToJSONTyped(json, false);
+}
+export function DataSourceSchemaResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'is_default': value['isDefault'],
+    };
+}

package/dist/esm/models/DataSourceTableResponse.d.ts

@@ -71,6 +71,12 @@ export interface DataSourceTableResponse {
      * @memberof DataSourceTableResponse
      */
     tableName: string;
+    /**
+     * Schema/namespace in the external DB; null = default schema
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    schemaName?: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/DataSourceTableResponse.js

@@ -71,6 +71,7 @@ export function DataSourceTableResponseFromJSONTyped(json, ignoreDiscriminator)
         'name': json['name'],
         'dataSourceId': json['data_source_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']),
@@ -96,6 +97,7 @@ export function DataSourceTableResponseToJSONTyped(value, ignoreDiscriminator =
         'name': value['name'],
         'data_source_id': value['dataSourceId'],
         'table_name': value['tableName'],
+        'schema_name': value['schemaName'],
         'description': value['description'],
         'column_config': value['columnConfig'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),

package/dist/esm/models/ModelTableRequest.d.ts

@@ -22,6 +22,12 @@ export interface ModelTableRequest {
      * @memberof ModelTableRequest
      */
     tableName: string;
+    /**
+     * Schema/namespace of the table; omit for the default schema
+     * @type {string}
+     * @memberof ModelTableRequest
+     */
+    schemaName?: string | null;
     /**
      * Display name; defaults to table_name
      * @type {string}