@knowledge-stack/ksapi 1.81.0 → 1.83.0
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/.openapi-generator/FILES +10 -0
- package/README.md +12 -2
- package/dist/apis/WorkflowDefinitionsApi.d.ts +4 -1
- package/dist/apis/WorkflowDefinitionsApi.js +2 -0
- package/dist/apis/WorkflowRunsApi.d.ts +233 -1
- package/dist/apis/WorkflowRunsApi.js +236 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +4 -1
- package/dist/esm/apis/WorkflowDefinitionsApi.js +2 -0
- package/dist/esm/apis/WorkflowRunsApi.d.ts +233 -1
- package/dist/esm/apis/WorkflowRunsApi.js +237 -1
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +14 -1
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +3 -4
- package/dist/esm/models/InstructionSnapshot.d.ts +71 -0
- package/dist/esm/models/InstructionSnapshot.js +57 -0
- package/dist/esm/models/InvokeWorkflowRequest.d.ts +6 -0
- package/dist/esm/models/InvokeWorkflowRequest.js +6 -0
- package/dist/esm/models/PathPartApprovalDecision.d.ts +30 -0
- package/dist/esm/models/PathPartApprovalDecision.js +48 -0
- package/dist/esm/models/PathPartApprovalResponse.d.ts +111 -0
- package/dist/esm/models/PathPartApprovalResponse.js +85 -0
- package/dist/esm/models/RejectFileRequest.d.ts +47 -0
- package/dist/esm/models/RejectFileRequest.js +49 -0
- package/dist/esm/models/RunLockResponse.d.ts +59 -0
- package/dist/esm/models/RunLockResponse.js +52 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +12 -1
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +2 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +4 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +17 -0
- package/dist/esm/models/WorkflowRunResponse.js +8 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +3 -2
- package/dist/esm/models/WorkflowRunSnapshot.js +3 -2
- package/dist/esm/models/WorkflowRunStatus.d.ts +20 -2
- package/dist/esm/models/WorkflowRunStatus.js +20 -2
- package/dist/esm/models/WorkflowRunnerType.d.ts +1 -0
- package/dist/esm/models/WorkflowRunnerType.js +2 -1
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.js +5 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +14 -1
- package/dist/models/CreateWorkflowDefinitionRequest.js +3 -4
- package/dist/models/InstructionSnapshot.d.ts +71 -0
- package/dist/models/InstructionSnapshot.js +65 -0
- package/dist/models/InvokeWorkflowRequest.d.ts +6 -0
- package/dist/models/InvokeWorkflowRequest.js +6 -0
- package/dist/models/PathPartApprovalDecision.d.ts +30 -0
- package/dist/models/PathPartApprovalDecision.js +56 -0
- package/dist/models/PathPartApprovalResponse.d.ts +111 -0
- package/dist/models/PathPartApprovalResponse.js +93 -0
- package/dist/models/RejectFileRequest.d.ts +47 -0
- package/dist/models/RejectFileRequest.js +57 -0
- package/dist/models/RunLockResponse.d.ts +59 -0
- package/dist/models/RunLockResponse.js +60 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +12 -1
- package/dist/models/UpdateWorkflowDefinitionRequest.js +2 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/models/WorkflowDefinitionResponse.js +4 -0
- package/dist/models/WorkflowRunResponse.d.ts +17 -0
- package/dist/models/WorkflowRunResponse.js +8 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +3 -2
- package/dist/models/WorkflowRunSnapshot.js +3 -2
- package/dist/models/WorkflowRunStatus.d.ts +20 -2
- package/dist/models/WorkflowRunStatus.js +20 -2
- package/dist/models/WorkflowRunnerType.d.ts +1 -0
- package/dist/models/WorkflowRunnerType.js +2 -1
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/docs/CreateWorkflowDefinitionRequest.md +3 -1
- package/docs/InstructionSnapshot.md +41 -0
- package/docs/InvokeWorkflowRequest.md +2 -0
- package/docs/PathPartApprovalDecision.md +33 -0
- package/docs/PathPartApprovalResponse.md +55 -0
- package/docs/RejectFileRequest.md +35 -0
- package/docs/RunLockResponse.md +39 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +3 -1
- package/docs/WorkflowDefinitionResponse.md +2 -0
- package/docs/WorkflowDefinitionsApi.md +2 -0
- package/docs/WorkflowRunResponse.md +5 -1
- package/docs/WorkflowRunSnapshot.md +1 -1
- package/docs/WorkflowRunStatus.md +1 -1
- package/docs/WorkflowRunsApi.md +387 -0
- package/package.json +1 -1
- package/src/apis/WorkflowDefinitionsApi.ts +4 -1
- package/src/apis/WorkflowRunsApi.ts +479 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +17 -4
- package/src/models/InstructionSnapshot.ts +125 -0
- package/src/models/InvokeWorkflowRequest.ts +12 -0
- package/src/models/PathPartApprovalDecision.ts +58 -0
- package/src/models/PathPartApprovalResponse.ts +186 -0
- package/src/models/RejectFileRequest.ts +87 -0
- package/src/models/RunLockResponse.ts +101 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +14 -1
- package/src/models/WorkflowDefinitionResponse.ts +9 -0
- package/src/models/WorkflowRunResponse.ts +23 -0
- package/src/models/WorkflowRunSnapshot.ts +11 -4
- package/src/models/WorkflowRunStatus.ts +20 -2
- package/src/models/WorkflowRunnerType.ts +2 -1
- package/src/models/index.ts +5 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -89,6 +89,7 @@ docs/ImageTaxonomy.md
|
|
|
89
89
|
docs/InformationStatistics.md
|
|
90
90
|
docs/IngestDocumentResponse.md
|
|
91
91
|
docs/IngestionMode.md
|
|
92
|
+
docs/InstructionSnapshot.md
|
|
92
93
|
docs/InviteLinkSettingsRequest.md
|
|
93
94
|
docs/InviteLinkSettingsResponse.md
|
|
94
95
|
docs/InviteResponse.md
|
|
@@ -131,6 +132,8 @@ docs/PasswordResetRequest.md
|
|
|
131
132
|
docs/PasswordResetWithTokenRequest.md
|
|
132
133
|
docs/PathOrder.md
|
|
133
134
|
docs/PathPartAncestorItem.md
|
|
135
|
+
docs/PathPartApprovalDecision.md
|
|
136
|
+
docs/PathPartApprovalResponse.md
|
|
134
137
|
docs/PathPartResponse.md
|
|
135
138
|
docs/PathPartTagsResponse.md
|
|
136
139
|
docs/PathPartsApi.md
|
|
@@ -142,9 +145,11 @@ docs/Polygon.md
|
|
|
142
145
|
docs/PolygonReference.md
|
|
143
146
|
docs/PublicApi.md
|
|
144
147
|
docs/ReferenceType.md
|
|
148
|
+
docs/RejectFileRequest.md
|
|
145
149
|
docs/ResolvedReferenceInput.md
|
|
146
150
|
docs/ResolvedReferenceOutput.md
|
|
147
151
|
docs/RootResponse.md
|
|
152
|
+
docs/RunLockResponse.md
|
|
148
153
|
docs/SSOInitiateResponse.md
|
|
149
154
|
docs/ScoredChunkResponse.md
|
|
150
155
|
docs/SearchSortOrder.md
|
|
@@ -331,6 +336,7 @@ src/models/ImageTaxonomy.ts
|
|
|
331
336
|
src/models/InformationStatistics.ts
|
|
332
337
|
src/models/IngestDocumentResponse.ts
|
|
333
338
|
src/models/IngestionMode.ts
|
|
339
|
+
src/models/InstructionSnapshot.ts
|
|
334
340
|
src/models/InviteLinkSettingsRequest.ts
|
|
335
341
|
src/models/InviteLinkSettingsResponse.ts
|
|
336
342
|
src/models/InviteResponse.ts
|
|
@@ -372,6 +378,8 @@ src/models/PasswordResetRequest.ts
|
|
|
372
378
|
src/models/PasswordResetWithTokenRequest.ts
|
|
373
379
|
src/models/PathOrder.ts
|
|
374
380
|
src/models/PathPartAncestorItem.ts
|
|
381
|
+
src/models/PathPartApprovalDecision.ts
|
|
382
|
+
src/models/PathPartApprovalResponse.ts
|
|
375
383
|
src/models/PathPartResponse.ts
|
|
376
384
|
src/models/PathPartTagsResponse.ts
|
|
377
385
|
src/models/PermissionCapability.ts
|
|
@@ -381,9 +389,11 @@ src/models/PipelineStatus.ts
|
|
|
381
389
|
src/models/Polygon.ts
|
|
382
390
|
src/models/PolygonReference.ts
|
|
383
391
|
src/models/ReferenceType.ts
|
|
392
|
+
src/models/RejectFileRequest.ts
|
|
384
393
|
src/models/ResolvedReferenceInput.ts
|
|
385
394
|
src/models/ResolvedReferenceOutput.ts
|
|
386
395
|
src/models/RootResponse.ts
|
|
396
|
+
src/models/RunLockResponse.ts
|
|
387
397
|
src/models/SSOInitiateResponse.ts
|
|
388
398
|
src/models/ScoredChunkResponse.ts
|
|
389
399
|
src/models/SearchSortOrder.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.83.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -191,8 +191,13 @@ All URIs are relative to *http://localhost:8000*
|
|
|
191
191
|
*WorkflowDefinitionsApi* | [**listWorkflowDefinitions**](docs/WorkflowDefinitionsApi.md#listworkflowdefinitions) | **GET** /v1/workflow-definitions | List Workflow Definitions Handler
|
|
192
192
|
*WorkflowDefinitionsApi* | [**listWorkflowRuns**](docs/WorkflowDefinitionsApi.md#listworkflowruns) | **GET** /v1/workflow-definitions/{definition_id}/runs | List Workflow Runs Handler
|
|
193
193
|
*WorkflowDefinitionsApi* | [**updateWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#updateworkflowdefinitionoperation) | **PUT** /v1/workflow-definitions/{definition_id} | Update Workflow Definition Handler
|
|
194
|
+
*WorkflowRunsApi* | [**acquireWorkflowRunLock**](docs/WorkflowRunsApi.md#acquireworkflowrunlock) | **POST** /v1/workflow-runs/{run_id}/lock | Acquire Workflow Run Lock Handler
|
|
195
|
+
*WorkflowRunsApi* | [**approveWorkflowRunFile**](docs/WorkflowRunsApi.md#approveworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/approve | Approve Workflow Run File Handler
|
|
194
196
|
*WorkflowRunsApi* | [**deleteWorkflowRun**](docs/WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler
|
|
195
197
|
*WorkflowRunsApi* | [**getWorkflowRun**](docs/WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler
|
|
198
|
+
*WorkflowRunsApi* | [**rejectWorkflowRunFile**](docs/WorkflowRunsApi.md#rejectworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/reject | Reject Workflow Run File Handler
|
|
199
|
+
*WorkflowRunsApi* | [**releaseWorkflowRunLock**](docs/WorkflowRunsApi.md#releaseworkflowrunlock) | **DELETE** /v1/workflow-runs/{run_id}/lock | Release Workflow Run Lock Handler
|
|
200
|
+
*WorkflowRunsApi* | [**unapproveWorkflowRunFile**](docs/WorkflowRunsApi.md#unapproveworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/unapprove | Unapprove Workflow Run File Handler
|
|
196
201
|
*WorkflowRunsApi* | [**workflowRunCallback**](docs/WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler
|
|
197
202
|
*WorkflowsApi* | [**cancelTemporalWorkflow**](docs/WorkflowsApi.md#canceltemporalworkflow) | **DELETE** /v1/workflows/{workflow_id} | Cancel Temporal Workflow Handler
|
|
198
203
|
*WorkflowsApi* | [**dvWorkflowRerun**](docs/WorkflowsApi.md#dvworkflowrerun) | **POST** /v1/workflows/document_versions/{workflow_id} | Dv Workflow Rerun Handler
|
|
@@ -279,6 +284,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
279
284
|
- [InformationStatistics](docs/InformationStatistics.md)
|
|
280
285
|
- [IngestDocumentResponse](docs/IngestDocumentResponse.md)
|
|
281
286
|
- [IngestionMode](docs/IngestionMode.md)
|
|
287
|
+
- [InstructionSnapshot](docs/InstructionSnapshot.md)
|
|
282
288
|
- [InviteLinkSettingsRequest](docs/InviteLinkSettingsRequest.md)
|
|
283
289
|
- [InviteLinkSettingsResponse](docs/InviteLinkSettingsResponse.md)
|
|
284
290
|
- [InviteResponse](docs/InviteResponse.md)
|
|
@@ -320,6 +326,8 @@ All URIs are relative to *http://localhost:8000*
|
|
|
320
326
|
- [PasswordResetWithTokenRequest](docs/PasswordResetWithTokenRequest.md)
|
|
321
327
|
- [PathOrder](docs/PathOrder.md)
|
|
322
328
|
- [PathPartAncestorItem](docs/PathPartAncestorItem.md)
|
|
329
|
+
- [PathPartApprovalDecision](docs/PathPartApprovalDecision.md)
|
|
330
|
+
- [PathPartApprovalResponse](docs/PathPartApprovalResponse.md)
|
|
323
331
|
- [PathPartResponse](docs/PathPartResponse.md)
|
|
324
332
|
- [PathPartTagsResponse](docs/PathPartTagsResponse.md)
|
|
325
333
|
- [PermissionCapability](docs/PermissionCapability.md)
|
|
@@ -329,9 +337,11 @@ All URIs are relative to *http://localhost:8000*
|
|
|
329
337
|
- [Polygon](docs/Polygon.md)
|
|
330
338
|
- [PolygonReference](docs/PolygonReference.md)
|
|
331
339
|
- [ReferenceType](docs/ReferenceType.md)
|
|
340
|
+
- [RejectFileRequest](docs/RejectFileRequest.md)
|
|
332
341
|
- [ResolvedReferenceInput](docs/ResolvedReferenceInput.md)
|
|
333
342
|
- [ResolvedReferenceOutput](docs/ResolvedReferenceOutput.md)
|
|
334
343
|
- [RootResponse](docs/RootResponse.md)
|
|
344
|
+
- [RunLockResponse](docs/RunLockResponse.md)
|
|
335
345
|
- [SSOInitiateResponse](docs/SSOInitiateResponse.md)
|
|
336
346
|
- [ScoredChunkResponse](docs/ScoredChunkResponse.md)
|
|
337
347
|
- [SearchSortOrder](docs/SearchSortOrder.md)
|
|
@@ -414,7 +424,7 @@ and is automatically generated by the
|
|
|
414
424
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
415
425
|
|
|
416
426
|
- API version: `0.1.0`
|
|
417
|
-
- Package version: `1.
|
|
427
|
+
- Package version: `1.83.0`
|
|
418
428
|
- Generator version: `7.21.0`
|
|
419
429
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
420
430
|
|
|
@@ -141,7 +141,7 @@ export interface WorkflowDefinitionsApiInterface {
|
|
|
141
141
|
*/
|
|
142
142
|
invokeWorkflowRequestOpts(requestParameters: InvokeWorkflowOperationRequest): Promise<runtime.RequestOpts>;
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
145
145
|
* @summary Invoke Workflow Handler
|
|
146
146
|
* @param {string} definitionId
|
|
147
147
|
* @param {InvokeWorkflowRequest} invokeWorkflowRequest
|
|
@@ -153,6 +153,7 @@ export interface WorkflowDefinitionsApiInterface {
|
|
|
153
153
|
*/
|
|
154
154
|
invokeWorkflowRaw(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
155
155
|
/**
|
|
156
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
156
157
|
* Invoke Workflow Handler
|
|
157
158
|
*/
|
|
158
159
|
invokeWorkflow(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -282,10 +283,12 @@ export declare class WorkflowDefinitionsApi extends runtime.BaseAPI implements W
|
|
|
282
283
|
*/
|
|
283
284
|
invokeWorkflowRequestOpts(requestParameters: InvokeWorkflowOperationRequest): Promise<runtime.RequestOpts>;
|
|
284
285
|
/**
|
|
286
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
285
287
|
* Invoke Workflow Handler
|
|
286
288
|
*/
|
|
287
289
|
invokeWorkflowRaw(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
|
|
288
290
|
/**
|
|
291
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
289
292
|
* Invoke Workflow Handler
|
|
290
293
|
*/
|
|
291
294
|
invokeWorkflow(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
@@ -217,6 +217,7 @@ class WorkflowDefinitionsApi extends runtime.BaseAPI {
|
|
|
217
217
|
});
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
220
221
|
* Invoke Workflow Handler
|
|
221
222
|
*/
|
|
222
223
|
invokeWorkflowRaw(requestParameters, initOverrides) {
|
|
@@ -227,6 +228,7 @@ class WorkflowDefinitionsApi extends runtime.BaseAPI {
|
|
|
227
228
|
});
|
|
228
229
|
}
|
|
229
230
|
/**
|
|
231
|
+
* Trigger a workflow run. All business logic lives in ``WorkflowInvocationService``. This handler only orchestrates the two phases: 1. **Phase 1 (in-session):** validate, build snapshot, persist run row, mint JWT. Wrapped in a single DB session so the run insert and the idempotency-race resolution share a transaction. 2. **Phase 2 (out-of-session):** dispatch HTTP call to the SELF_HOSTED runner. Best-effort — the run is already persisted, so failures here transition the run to ``FAILED`` rather than rejecting the request.
|
|
230
232
|
* Invoke Workflow Handler
|
|
231
233
|
*/
|
|
232
234
|
invokeWorkflow(requestParameters, initOverrides) {
|
|
@@ -10,7 +10,18 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { WorkflowCallbackResponse, WorkflowRunCallbackRequest, WorkflowRunResponse } from '../models/index';
|
|
13
|
+
import type { PathPartApprovalResponse, RejectFileRequest, RunLockResponse, WorkflowCallbackResponse, WorkflowRunCallbackRequest, WorkflowRunResponse } from '../models/index';
|
|
14
|
+
export interface AcquireWorkflowRunLockRequest {
|
|
15
|
+
runId: string;
|
|
16
|
+
authorization?: string | null;
|
|
17
|
+
ksUat?: string | null;
|
|
18
|
+
}
|
|
19
|
+
export interface ApproveWorkflowRunFileRequest {
|
|
20
|
+
runId: string;
|
|
21
|
+
pathPartId: string;
|
|
22
|
+
authorization?: string | null;
|
|
23
|
+
ksUat?: string | null;
|
|
24
|
+
}
|
|
14
25
|
export interface DeleteWorkflowRunRequest {
|
|
15
26
|
runId: string;
|
|
16
27
|
authorization?: string | null;
|
|
@@ -21,6 +32,24 @@ export interface GetWorkflowRunRequest {
|
|
|
21
32
|
authorization?: string | null;
|
|
22
33
|
ksUat?: string | null;
|
|
23
34
|
}
|
|
35
|
+
export interface RejectWorkflowRunFileRequest {
|
|
36
|
+
runId: string;
|
|
37
|
+
pathPartId: string;
|
|
38
|
+
rejectFileRequest: RejectFileRequest;
|
|
39
|
+
authorization?: string | null;
|
|
40
|
+
ksUat?: string | null;
|
|
41
|
+
}
|
|
42
|
+
export interface ReleaseWorkflowRunLockRequest {
|
|
43
|
+
runId: string;
|
|
44
|
+
authorization?: string | null;
|
|
45
|
+
ksUat?: string | null;
|
|
46
|
+
}
|
|
47
|
+
export interface UnapproveWorkflowRunFileRequest {
|
|
48
|
+
runId: string;
|
|
49
|
+
pathPartId: string;
|
|
50
|
+
authorization?: string | null;
|
|
51
|
+
ksUat?: string | null;
|
|
52
|
+
}
|
|
24
53
|
export interface WorkflowRunCallbackOperationRequest {
|
|
25
54
|
runId: string;
|
|
26
55
|
workflowRunCallbackRequest: WorkflowRunCallbackRequest;
|
|
@@ -32,6 +61,58 @@ export interface WorkflowRunCallbackOperationRequest {
|
|
|
32
61
|
* @interface WorkflowRunsApiInterface
|
|
33
62
|
*/
|
|
34
63
|
export interface WorkflowRunsApiInterface {
|
|
64
|
+
/**
|
|
65
|
+
* Creates request options for acquireWorkflowRunLock without sending the request
|
|
66
|
+
* @param {string} runId
|
|
67
|
+
* @param {string} [authorization]
|
|
68
|
+
* @param {string} [ksUat]
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
* @memberof WorkflowRunsApiInterface
|
|
71
|
+
*/
|
|
72
|
+
acquireWorkflowRunLockRequestOpts(requestParameters: AcquireWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
|
|
73
|
+
/**
|
|
74
|
+
* Acquire (or renew) the reviewer lock on ``run_id``. The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
|
|
75
|
+
* @summary Acquire Workflow Run Lock Handler
|
|
76
|
+
* @param {string} runId
|
|
77
|
+
* @param {string} [authorization]
|
|
78
|
+
* @param {string} [ksUat]
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
* @memberof WorkflowRunsApiInterface
|
|
82
|
+
*/
|
|
83
|
+
acquireWorkflowRunLockRaw(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunLockResponse>>;
|
|
84
|
+
/**
|
|
85
|
+
* Acquire (or renew) the reviewer lock on ``run_id``. The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
|
|
86
|
+
* Acquire Workflow Run Lock Handler
|
|
87
|
+
*/
|
|
88
|
+
acquireWorkflowRunLock(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunLockResponse>;
|
|
89
|
+
/**
|
|
90
|
+
* Creates request options for approveWorkflowRunFile without sending the request
|
|
91
|
+
* @param {string} runId
|
|
92
|
+
* @param {string} pathPartId
|
|
93
|
+
* @param {string} [authorization]
|
|
94
|
+
* @param {string} [ksUat]
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
* @memberof WorkflowRunsApiInterface
|
|
97
|
+
*/
|
|
98
|
+
approveWorkflowRunFileRequestOpts(requestParameters: ApproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
99
|
+
/**
|
|
100
|
+
* Approve a single generated file. Caller must hold the run lock.
|
|
101
|
+
* @summary Approve Workflow Run File Handler
|
|
102
|
+
* @param {string} runId
|
|
103
|
+
* @param {string} pathPartId
|
|
104
|
+
* @param {string} [authorization]
|
|
105
|
+
* @param {string} [ksUat]
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
* @memberof WorkflowRunsApiInterface
|
|
109
|
+
*/
|
|
110
|
+
approveWorkflowRunFileRaw(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
111
|
+
/**
|
|
112
|
+
* Approve a single generated file. Caller must hold the run lock.
|
|
113
|
+
* Approve Workflow Run File Handler
|
|
114
|
+
*/
|
|
115
|
+
approveWorkflowRunFile(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
35
116
|
/**
|
|
36
117
|
* Creates request options for deleteWorkflowRun without sending the request
|
|
37
118
|
* @param {string} runId
|
|
@@ -80,6 +161,87 @@ export interface WorkflowRunsApiInterface {
|
|
|
80
161
|
* Get Workflow Run Handler
|
|
81
162
|
*/
|
|
82
163
|
getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* Creates request options for rejectWorkflowRunFile without sending the request
|
|
166
|
+
* @param {string} runId
|
|
167
|
+
* @param {string} pathPartId
|
|
168
|
+
* @param {RejectFileRequest} rejectFileRequest
|
|
169
|
+
* @param {string} [authorization]
|
|
170
|
+
* @param {string} [ksUat]
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
* @memberof WorkflowRunsApiInterface
|
|
173
|
+
*/
|
|
174
|
+
rejectWorkflowRunFileRequestOpts(requestParameters: RejectWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
175
|
+
/**
|
|
176
|
+
* Reject a single generated file with a reason. Caller must hold the run lock.
|
|
177
|
+
* @summary Reject Workflow Run File Handler
|
|
178
|
+
* @param {string} runId
|
|
179
|
+
* @param {string} pathPartId
|
|
180
|
+
* @param {RejectFileRequest} rejectFileRequest
|
|
181
|
+
* @param {string} [authorization]
|
|
182
|
+
* @param {string} [ksUat]
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
* @memberof WorkflowRunsApiInterface
|
|
186
|
+
*/
|
|
187
|
+
rejectWorkflowRunFileRaw(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
188
|
+
/**
|
|
189
|
+
* Reject a single generated file with a reason. Caller must hold the run lock.
|
|
190
|
+
* Reject Workflow Run File Handler
|
|
191
|
+
*/
|
|
192
|
+
rejectWorkflowRunFile(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
193
|
+
/**
|
|
194
|
+
* Creates request options for releaseWorkflowRunLock without sending the request
|
|
195
|
+
* @param {string} runId
|
|
196
|
+
* @param {string} [authorization]
|
|
197
|
+
* @param {string} [ksUat]
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
* @memberof WorkflowRunsApiInterface
|
|
200
|
+
*/
|
|
201
|
+
releaseWorkflowRunLockRequestOpts(requestParameters: ReleaseWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
|
|
202
|
+
/**
|
|
203
|
+
* Release the reviewer lock; only the holder may call this. DELETE /lock is idempotent: returns 204 even if no lock is held.
|
|
204
|
+
* @summary Release Workflow Run Lock Handler
|
|
205
|
+
* @param {string} runId
|
|
206
|
+
* @param {string} [authorization]
|
|
207
|
+
* @param {string} [ksUat]
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
* @memberof WorkflowRunsApiInterface
|
|
211
|
+
*/
|
|
212
|
+
releaseWorkflowRunLockRaw(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
213
|
+
/**
|
|
214
|
+
* Release the reviewer lock; only the holder may call this. DELETE /lock is idempotent: returns 204 even if no lock is held.
|
|
215
|
+
* Release Workflow Run Lock Handler
|
|
216
|
+
*/
|
|
217
|
+
releaseWorkflowRunLock(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
218
|
+
/**
|
|
219
|
+
* Creates request options for unapproveWorkflowRunFile without sending the request
|
|
220
|
+
* @param {string} runId
|
|
221
|
+
* @param {string} pathPartId
|
|
222
|
+
* @param {string} [authorization]
|
|
223
|
+
* @param {string} [ksUat]
|
|
224
|
+
* @throws {RequiredError}
|
|
225
|
+
* @memberof WorkflowRunsApiInterface
|
|
226
|
+
*/
|
|
227
|
+
unapproveWorkflowRunFileRequestOpts(requestParameters: UnapproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
228
|
+
/**
|
|
229
|
+
* Revert an approved file to ``pending``. Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
|
|
230
|
+
* @summary Unapprove Workflow Run File Handler
|
|
231
|
+
* @param {string} runId
|
|
232
|
+
* @param {string} pathPartId
|
|
233
|
+
* @param {string} [authorization]
|
|
234
|
+
* @param {string} [ksUat]
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
* @memberof WorkflowRunsApiInterface
|
|
238
|
+
*/
|
|
239
|
+
unapproveWorkflowRunFileRaw(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
240
|
+
/**
|
|
241
|
+
* Revert an approved file to ``pending``. Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
|
|
242
|
+
* Unapprove Workflow Run File Handler
|
|
243
|
+
*/
|
|
244
|
+
unapproveWorkflowRunFile(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
83
245
|
/**
|
|
84
246
|
* Creates request options for workflowRunCallback without sending the request
|
|
85
247
|
* @param {string} runId
|
|
@@ -107,6 +269,34 @@ export interface WorkflowRunsApiInterface {
|
|
|
107
269
|
*
|
|
108
270
|
*/
|
|
109
271
|
export declare class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiInterface {
|
|
272
|
+
/**
|
|
273
|
+
* Creates request options for acquireWorkflowRunLock without sending the request
|
|
274
|
+
*/
|
|
275
|
+
acquireWorkflowRunLockRequestOpts(requestParameters: AcquireWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
|
|
276
|
+
/**
|
|
277
|
+
* Acquire (or renew) the reviewer lock on ``run_id``. The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
|
|
278
|
+
* Acquire Workflow Run Lock Handler
|
|
279
|
+
*/
|
|
280
|
+
acquireWorkflowRunLockRaw(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunLockResponse>>;
|
|
281
|
+
/**
|
|
282
|
+
* Acquire (or renew) the reviewer lock on ``run_id``. The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
|
|
283
|
+
* Acquire Workflow Run Lock Handler
|
|
284
|
+
*/
|
|
285
|
+
acquireWorkflowRunLock(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunLockResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* Creates request options for approveWorkflowRunFile without sending the request
|
|
288
|
+
*/
|
|
289
|
+
approveWorkflowRunFileRequestOpts(requestParameters: ApproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
290
|
+
/**
|
|
291
|
+
* Approve a single generated file. Caller must hold the run lock.
|
|
292
|
+
* Approve Workflow Run File Handler
|
|
293
|
+
*/
|
|
294
|
+
approveWorkflowRunFileRaw(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
295
|
+
/**
|
|
296
|
+
* Approve a single generated file. Caller must hold the run lock.
|
|
297
|
+
* Approve Workflow Run File Handler
|
|
298
|
+
*/
|
|
299
|
+
approveWorkflowRunFile(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
110
300
|
/**
|
|
111
301
|
* Creates request options for deleteWorkflowRun without sending the request
|
|
112
302
|
*/
|
|
@@ -131,6 +321,48 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
131
321
|
* Get Workflow Run Handler
|
|
132
322
|
*/
|
|
133
323
|
getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
|
|
324
|
+
/**
|
|
325
|
+
* Creates request options for rejectWorkflowRunFile without sending the request
|
|
326
|
+
*/
|
|
327
|
+
rejectWorkflowRunFileRequestOpts(requestParameters: RejectWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
328
|
+
/**
|
|
329
|
+
* Reject a single generated file with a reason. Caller must hold the run lock.
|
|
330
|
+
* Reject Workflow Run File Handler
|
|
331
|
+
*/
|
|
332
|
+
rejectWorkflowRunFileRaw(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
333
|
+
/**
|
|
334
|
+
* Reject a single generated file with a reason. Caller must hold the run lock.
|
|
335
|
+
* Reject Workflow Run File Handler
|
|
336
|
+
*/
|
|
337
|
+
rejectWorkflowRunFile(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
338
|
+
/**
|
|
339
|
+
* Creates request options for releaseWorkflowRunLock without sending the request
|
|
340
|
+
*/
|
|
341
|
+
releaseWorkflowRunLockRequestOpts(requestParameters: ReleaseWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
|
|
342
|
+
/**
|
|
343
|
+
* Release the reviewer lock; only the holder may call this. DELETE /lock is idempotent: returns 204 even if no lock is held.
|
|
344
|
+
* Release Workflow Run Lock Handler
|
|
345
|
+
*/
|
|
346
|
+
releaseWorkflowRunLockRaw(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
347
|
+
/**
|
|
348
|
+
* Release the reviewer lock; only the holder may call this. DELETE /lock is idempotent: returns 204 even if no lock is held.
|
|
349
|
+
* Release Workflow Run Lock Handler
|
|
350
|
+
*/
|
|
351
|
+
releaseWorkflowRunLock(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
352
|
+
/**
|
|
353
|
+
* Creates request options for unapproveWorkflowRunFile without sending the request
|
|
354
|
+
*/
|
|
355
|
+
unapproveWorkflowRunFileRequestOpts(requestParameters: UnapproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
|
|
356
|
+
/**
|
|
357
|
+
* Revert an approved file to ``pending``. Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
|
|
358
|
+
* Unapprove Workflow Run File Handler
|
|
359
|
+
*/
|
|
360
|
+
unapproveWorkflowRunFileRaw(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
|
|
361
|
+
/**
|
|
362
|
+
* Revert an approved file to ``pending``. Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
|
|
363
|
+
* Unapprove Workflow Run File Handler
|
|
364
|
+
*/
|
|
365
|
+
unapproveWorkflowRunFile(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
|
|
134
366
|
/**
|
|
135
367
|
* Creates request options for workflowRunCallback without sending the request
|
|
136
368
|
*/
|