@knowledge-stack/ksapi 1.115.2 → 1.116.0

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.115.2
+# @knowledge-stack/ksapi@1.116.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -583,7 +583,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.115.2`
+- Package version: `1.116.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/WorkflowDefinitionsApi.d.ts

@@ -21,6 +21,7 @@ export interface CreateWorkflowRunRequest {
     idempotencyKey?: string | null;
     autoStart?: boolean;
     userMessage?: string | null;
+    name?: string | null;
 }
 export interface DeleteWorkflowDefinitionRequest {
     definitionId: string;
@@ -94,6 +95,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface
      */
@@ -107,6 +109,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface

package/dist/apis/WorkflowDefinitionsApi.js

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

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

@@ -21,6 +21,7 @@ export interface CreateWorkflowRunRequest {
     idempotencyKey?: string | null;
     autoStart?: boolean;
     userMessage?: string | null;
+    name?: string | null;
 }
 export interface DeleteWorkflowDefinitionRequest {
     definitionId: string;
@@ -94,6 +95,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface
      */
@@ -107,6 +109,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface

package/dist/esm/apis/WorkflowDefinitionsApi.js

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

package/docs/WorkflowDefinitionsApi.md

@@ -90,7 +90,7 @@ example().catch(console.error);
 
 ## createWorkflowRun
 
-> WorkflowRunResponse createWorkflowRun(definitionId, files, inputScope, idempotencyKey, autoStart, userMessage)
+> WorkflowRunResponse createWorkflowRun(definitionId, files, inputScope, idempotencyKey, autoStart, userMessage, name)
 
 Create Workflow Run Handler
 
@@ -128,6 +128,8 @@ async function example() {
     autoStart: true,
     // string | Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires. (optional)
     userMessage: userMessage_example,
+    // string | Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409. (optional)
+    name: name_example,
   } satisfies CreateWorkflowRunRequest;
 
   try {
@@ -153,6 +155,7 @@ example().catch(console.error);
 | **idempotencyKey** | `string` | Optional key to prevent duplicate runs from retries. | [Optional] [Defaults to `undefined`] |
 | **autoStart** | `boolean` | When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added. | [Optional] [Defaults to `false`] |
 | **userMessage** | `string` | Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires. | [Optional] [Defaults to `undefined`] |
+| **name** | `string` | Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.115.2",
+  "version": "1.116.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/WorkflowDefinitionsApi.ts

@@ -66,6 +66,7 @@ export interface CreateWorkflowRunRequest {
     idempotencyKey?: string | null;
     autoStart?: boolean;
     userMessage?: string | null;
+    name?: string | null;
 }
 
 export interface DeleteWorkflowDefinitionRequest {
@@ -149,6 +150,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface
      */
@@ -163,6 +165,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {string} [idempotencyKey] Optional key to prevent duplicate runs from retries.
      * @param {boolean} [autoStart] When true, the run starts itself once its ``inputs/`` uploads finish ingesting — eliminating the separate Start call. If an upload\\\'s ingestion fails, the run is marked FAILED. Default false (two-step flow). Arm only after all uploads are queued; a synchronously-completing first upload would otherwise start the run before later uploads are added.
      * @param {string} [userMessage] Optional note carried to the auto-start dispatch (the equivalent of the Start endpoint\\\'s ``user_message`` for a self-starting run). Applied only when ``auto_start`` fires.
+     * @param {string} [name] Optional display name for the run. Omit to default to the run\\\'s UUID; rename later via PATCH. Must be unique among sibling runs under this definition\\\'s ``runs/`` folder — a collision returns 409.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowDefinitionsApiInterface
@@ -475,6 +478,10 @@ export class WorkflowDefinitionsApi extends runtime.BaseAPI implements WorkflowD
             formParams.append('user_message', requestParameters['userMessage'] as any);
         }
 
+        if (requestParameters['name'] != null) {
+            formParams.append('name', requestParameters['name'] as any);
+        }
+
 
         let urlPath = `/v1/workflow-definitions/{definition_id}/runs`;
         urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));