@knowledge-stack/ksapi 1.131.0 → 1.131.2
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/README.md +2 -2
- package/dist/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/apis/WorkflowRunsApi.js +2 -2
- package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/esm/apis/WorkflowRunsApi.js +2 -2
- package/docs/WorkflowRunsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/WorkflowRunsApi.ts +4 -4
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.131.
|
|
1
|
+
# @knowledge-stack/ksapi@1.131.2
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -617,7 +617,7 @@ and is automatically generated by the
|
|
|
617
617
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
618
618
|
|
|
619
619
|
- API version: `0.1.0`
|
|
620
|
-
- Package version: `1.131.
|
|
620
|
+
- Package version: `1.131.2`
|
|
621
621
|
- Generator version: `7.21.0`
|
|
622
622
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
623
623
|
|
|
@@ -287,7 +287,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
287
287
|
*/
|
|
288
288
|
stopWorkflowRunRequestOpts(requestParameters: StopWorkflowRunRequest): Promise<runtime.RequestOpts>;
|
|
289
289
|
/**
|
|
290
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
290
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
291
291
|
* @summary Stop Workflow Run Handler
|
|
292
292
|
* @param {string} runId
|
|
293
293
|
* @param {*} [options] Override http request option.
|
|
@@ -296,7 +296,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
296
296
|
*/
|
|
297
297
|
stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
298
298
|
/**
|
|
299
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
299
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
300
300
|
* Stop Workflow Run Handler
|
|
301
301
|
*/
|
|
302
302
|
stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -464,12 +464,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
464
464
|
*/
|
|
465
465
|
stopWorkflowRunRequestOpts(requestParameters: StopWorkflowRunRequest): Promise<runtime.RequestOpts>;
|
|
466
466
|
/**
|
|
467
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
467
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
468
468
|
* Stop Workflow Run Handler
|
|
469
469
|
*/
|
|
470
470
|
stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
471
471
|
/**
|
|
472
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
472
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
473
473
|
* Stop Workflow Run Handler
|
|
474
474
|
*/
|
|
475
475
|
stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -530,7 +530,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
530
530
|
});
|
|
531
531
|
}
|
|
532
532
|
/**
|
|
533
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
533
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
534
534
|
* Stop Workflow Run Handler
|
|
535
535
|
*/
|
|
536
536
|
stopWorkflowRunRaw(requestParameters, initOverrides) {
|
|
@@ -541,7 +541,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
541
541
|
});
|
|
542
542
|
}
|
|
543
543
|
/**
|
|
544
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
544
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
545
545
|
* Stop Workflow Run Handler
|
|
546
546
|
*/
|
|
547
547
|
stopWorkflowRun(requestParameters, initOverrides) {
|
|
@@ -287,7 +287,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
287
287
|
*/
|
|
288
288
|
stopWorkflowRunRequestOpts(requestParameters: StopWorkflowRunRequest): Promise<runtime.RequestOpts>;
|
|
289
289
|
/**
|
|
290
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
290
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
291
291
|
* @summary Stop Workflow Run Handler
|
|
292
292
|
* @param {string} runId
|
|
293
293
|
* @param {*} [options] Override http request option.
|
|
@@ -296,7 +296,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
296
296
|
*/
|
|
297
297
|
stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
298
298
|
/**
|
|
299
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
299
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
300
300
|
* Stop Workflow Run Handler
|
|
301
301
|
*/
|
|
302
302
|
stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -464,12 +464,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
464
464
|
*/
|
|
465
465
|
stopWorkflowRunRequestOpts(requestParameters: StopWorkflowRunRequest): Promise<runtime.RequestOpts>;
|
|
466
466
|
/**
|
|
467
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
467
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
468
468
|
* Stop Workflow Run Handler
|
|
469
469
|
*/
|
|
470
470
|
stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
471
471
|
/**
|
|
472
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
472
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
473
473
|
* Stop Workflow Run Handler
|
|
474
474
|
*/
|
|
475
475
|
stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -494,7 +494,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
494
494
|
});
|
|
495
495
|
}
|
|
496
496
|
/**
|
|
497
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
497
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
498
498
|
* Stop Workflow Run Handler
|
|
499
499
|
*/
|
|
500
500
|
stopWorkflowRunRaw(requestParameters, initOverrides) {
|
|
@@ -505,7 +505,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
505
505
|
});
|
|
506
506
|
}
|
|
507
507
|
/**
|
|
508
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
508
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
509
509
|
* Stop Workflow Run Handler
|
|
510
510
|
*/
|
|
511
511
|
stopWorkflowRun(requestParameters, initOverrides) {
|
package/docs/WorkflowRunsApi.md
CHANGED
|
@@ -680,7 +680,7 @@ example().catch(console.error);
|
|
|
680
680
|
|
|
681
681
|
Stop Workflow Run Handler
|
|
682
682
|
|
|
683
|
-
Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
683
|
+
Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
684
684
|
|
|
685
685
|
### Example
|
|
686
686
|
|
package/package.json
CHANGED
|
@@ -376,7 +376,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
376
376
|
stopWorkflowRunRequestOpts(requestParameters: StopWorkflowRunRequest): Promise<runtime.RequestOpts>;
|
|
377
377
|
|
|
378
378
|
/**
|
|
379
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
379
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
380
380
|
* @summary Stop Workflow Run Handler
|
|
381
381
|
* @param {string} runId
|
|
382
382
|
* @param {*} [options] Override http request option.
|
|
@@ -386,7 +386,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
386
386
|
stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
387
387
|
|
|
388
388
|
/**
|
|
389
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
389
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
390
390
|
* Stop Workflow Run Handler
|
|
391
391
|
*/
|
|
392
392
|
stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -1004,7 +1004,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
1004
1004
|
}
|
|
1005
1005
|
|
|
1006
1006
|
/**
|
|
1007
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
1007
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
1008
1008
|
* Stop Workflow Run Handler
|
|
1009
1009
|
*/
|
|
1010
1010
|
async stopWorkflowRunRaw(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
|
|
@@ -1015,7 +1015,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
1015
1015
|
}
|
|
1016
1016
|
|
|
1017
1017
|
/**
|
|
1018
|
-
* Stop a running workflow run, terminalizing it so its thread un-bricks.
|
|
1018
|
+
* Stop a running workflow run, terminalizing it so its thread un-bricks. Marks the run ``FAILED`` (\"Stopped by user\") with a pure DB write (no Temporal dependency, so it also recovers a run stranded ``IN_PROGRESS`` by a lost cancel callback), then best-effort revokes the streaming reply\'s lease and cancels the Temporal workflow. Revoking the lease is what makes stop authoritative — the cancel only *requests* a cooperative stop; see docs/api/notification_system.md for the lease protocol. Idempotent: a terminal or not-yet-started run is returned unchanged (the ``mark_run_failed`` guard + the callback\'s ``already_terminal`` no-op keep a real completion landing concurrently safe).
|
|
1019
1019
|
* Stop Workflow Run Handler
|
|
1020
1020
|
*/
|
|
1021
1021
|
async stopWorkflowRun(requestParameters: StopWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
|