@knowledge-stack/ksapi 3.16.2 → 3.17.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 +26 -4
- package/README.md +23 -4
- package/dist/apis/MemoryApi.d.ts +5 -5
- package/dist/apis/MemoryApi.js +1 -1
- package/dist/apis/WorkflowMemoryApi.d.ts +17 -17
- package/dist/apis/WorkflowMemoryApi.js +4 -4
- package/dist/apis/WorkflowRepositoryApi.d.ts +419 -0
- package/dist/apis/WorkflowRepositoryApi.js +595 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/MemoryApi.d.ts +5 -5
- package/dist/esm/apis/MemoryApi.js +2 -2
- package/dist/esm/apis/WorkflowMemoryApi.d.ts +17 -17
- package/dist/esm/apis/WorkflowMemoryApi.js +5 -5
- package/dist/esm/apis/WorkflowRepositoryApi.d.ts +419 -0
- package/dist/esm/apis/WorkflowRepositoryApi.js +558 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ErrorResponse.d.ts +7 -0
- package/dist/esm/models/ErrorResponse.js +7 -0
- package/dist/esm/models/{MemoryChunkResponse.d.ts → MemoryEntryResponse.d.ts} +12 -12
- package/dist/esm/models/{MemoryChunkResponse.js → MemoryEntryResponse.js} +9 -9
- package/dist/esm/models/{PaginatedResponseMemoryChunkResponse.d.ts → PaginatedResponseMemoryEntryResponse.d.ts} +16 -16
- package/dist/esm/models/{PaginatedResponseMemoryChunkResponse.js → PaginatedResponseMemoryEntryResponse.js} +12 -12
- package/dist/esm/models/PaginatedResponseRepoVersionResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseRepoVersionResponse.js +70 -0
- package/dist/esm/models/RecordRepoSaveSkipRequest.d.ts +60 -0
- package/dist/esm/models/RecordRepoSaveSkipRequest.js +55 -0
- package/dist/esm/models/RepoBranchResponse.d.ts +126 -0
- package/dist/esm/models/RepoBranchResponse.js +95 -0
- package/dist/esm/models/RepoCommitSummary.d.ts +71 -0
- package/dist/esm/models/RepoCommitSummary.js +60 -0
- package/dist/esm/models/RepoSaveSkipReason.d.ts +36 -0
- package/dist/esm/models/RepoSaveSkipReason.js +54 -0
- package/dist/esm/models/RepoSnapshot.d.ts +59 -0
- package/dist/esm/models/RepoSnapshot.js +50 -0
- package/dist/esm/models/RepoTreeEntry.d.ts +59 -0
- package/dist/esm/models/RepoTreeEntry.js +52 -0
- package/dist/esm/models/RepoTreeResponse.d.ts +54 -0
- package/dist/esm/models/RepoTreeResponse.js +49 -0
- package/dist/esm/models/RepoVersionResponse.d.ts +95 -0
- package/dist/esm/models/RepoVersionResponse.js +74 -0
- package/dist/esm/models/WorkflowRepoResponse.d.ts +102 -0
- package/dist/esm/models/WorkflowRepoResponse.js +81 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/esm/models/WorkflowRunSnapshot.js +3 -0
- package/dist/esm/models/index.d.ts +12 -2
- package/dist/esm/models/index.js +12 -2
- package/dist/models/ErrorResponse.d.ts +7 -0
- package/dist/models/ErrorResponse.js +7 -0
- package/dist/models/{MemoryChunkResponse.d.ts → MemoryEntryResponse.d.ts} +12 -12
- package/dist/models/{MemoryChunkResponse.js → MemoryEntryResponse.js} +15 -15
- package/dist/models/{PaginatedResponseMemoryChunkResponse.d.ts → PaginatedResponseMemoryEntryResponse.d.ts} +16 -16
- package/dist/models/{PaginatedResponseMemoryChunkResponse.js → PaginatedResponseMemoryEntryResponse.js} +18 -18
- package/dist/models/PaginatedResponseRepoVersionResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseRepoVersionResponse.js +78 -0
- package/dist/models/RecordRepoSaveSkipRequest.d.ts +60 -0
- package/dist/models/RecordRepoSaveSkipRequest.js +63 -0
- package/dist/models/RepoBranchResponse.d.ts +126 -0
- package/dist/models/RepoBranchResponse.js +103 -0
- package/dist/models/RepoCommitSummary.d.ts +71 -0
- package/dist/models/RepoCommitSummary.js +68 -0
- package/dist/models/RepoSaveSkipReason.d.ts +36 -0
- package/dist/models/RepoSaveSkipReason.js +62 -0
- package/dist/models/RepoSnapshot.d.ts +59 -0
- package/dist/models/RepoSnapshot.js +58 -0
- package/dist/models/RepoTreeEntry.d.ts +59 -0
- package/dist/models/RepoTreeEntry.js +60 -0
- package/dist/models/RepoTreeResponse.d.ts +54 -0
- package/dist/models/RepoTreeResponse.js +57 -0
- package/dist/models/RepoVersionResponse.d.ts +95 -0
- package/dist/models/RepoVersionResponse.js +82 -0
- package/dist/models/WorkflowRepoResponse.d.ts +102 -0
- package/dist/models/WorkflowRepoResponse.js +89 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/models/WorkflowRunSnapshot.js +3 -0
- package/dist/models/index.d.ts +12 -2
- package/dist/models/index.js +12 -2
- package/docs/MemoryApi.md +2 -2
- package/docs/{MemoryChunkResponse.md → MemoryEntryResponse.md} +4 -4
- package/docs/{PaginatedResponseMemoryChunkResponse.md → PaginatedResponseMemoryEntryResponse.md} +5 -5
- package/docs/PaginatedResponseRepoVersionResponse.md +40 -0
- package/docs/RecordRepoSaveSkipRequest.md +38 -0
- package/docs/RepoBranchResponse.md +61 -0
- package/docs/RepoCommitSummary.md +42 -0
- package/docs/RepoSaveSkipReason.md +33 -0
- package/docs/RepoSnapshot.md +39 -0
- package/docs/RepoTreeEntry.md +38 -0
- package/docs/RepoTreeResponse.md +36 -0
- package/docs/RepoVersionResponse.md +51 -0
- package/docs/WorkflowMemoryApi.md +8 -8
- package/docs/WorkflowRepoResponse.md +53 -0
- package/docs/WorkflowRepositoryApi.md +745 -0
- package/docs/WorkflowRunSnapshot.md +2 -0
- package/package.json +1 -1
- package/src/apis/MemoryApi.ts +8 -8
- package/src/apis/WorkflowMemoryApi.ts +26 -26
- package/src/apis/WorkflowRepositoryApi.ts +1002 -0
- package/src/apis/index.ts +1 -0
- package/src/models/ErrorResponse.ts +7 -0
- package/src/models/{MemoryChunkResponse.ts → MemoryEntryResponse.ts} +14 -14
- package/src/models/{PaginatedResponseMemoryChunkResponse.ts → PaginatedResponseMemoryEntryResponse.ts} +25 -25
- package/src/models/PaginatedResponseRepoVersionResponse.ts +130 -0
- package/src/models/RecordRepoSaveSkipRequest.ts +113 -0
- package/src/models/RepoBranchResponse.ts +207 -0
- package/src/models/RepoCommitSummary.ts +119 -0
- package/src/models/RepoSaveSkipReason.ts +64 -0
- package/src/models/RepoSnapshot.ts +100 -0
- package/src/models/RepoTreeEntry.ts +101 -0
- package/src/models/RepoTreeResponse.ts +100 -0
- package/src/models/RepoVersionResponse.ts +154 -0
- package/src/models/WorkflowRepoResponse.ts +172 -0
- package/src/models/WorkflowRunSnapshot.ts +15 -0
- package/src/models/index.ts +12 -2
|
@@ -0,0 +1,419 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { EventResponse, PaginatedResponseRepoVersionResponse, RecordRepoSaveSkipRequest, RepoBranchResponse, RepoTreeResponse, RepoVersionResponse, WorkflowRepoResponse } from '../models/index';
|
|
14
|
+
export interface DownloadWorkflowRepoBranchBundleRequest {
|
|
15
|
+
definitionId: string;
|
|
16
|
+
runId: string;
|
|
17
|
+
versionId?: string | null;
|
|
18
|
+
}
|
|
19
|
+
export interface DownloadWorkflowRepoBundleRequest {
|
|
20
|
+
definitionId: string;
|
|
21
|
+
versionId?: string | null;
|
|
22
|
+
}
|
|
23
|
+
export interface GetWorkflowRepoRequest {
|
|
24
|
+
definitionId: string;
|
|
25
|
+
}
|
|
26
|
+
export interface GetWorkflowRepoBranchRequest {
|
|
27
|
+
definitionId: string;
|
|
28
|
+
runId: string;
|
|
29
|
+
}
|
|
30
|
+
export interface GetWorkflowRepoTreeRequest {
|
|
31
|
+
definitionId: string;
|
|
32
|
+
commit?: string | null;
|
|
33
|
+
}
|
|
34
|
+
export interface ListWorkflowRepoVersionsRequest {
|
|
35
|
+
definitionId: string;
|
|
36
|
+
runId?: string | null;
|
|
37
|
+
limit?: number;
|
|
38
|
+
offset?: number;
|
|
39
|
+
}
|
|
40
|
+
export interface RecordWorkflowRepoSkippedSaveRequest {
|
|
41
|
+
definitionId: string;
|
|
42
|
+
recordRepoSaveSkipRequest: RecordRepoSaveSkipRequest;
|
|
43
|
+
}
|
|
44
|
+
export interface SaveWorkflowRepoBranchRequest {
|
|
45
|
+
definitionId: string;
|
|
46
|
+
runId: string;
|
|
47
|
+
bundle: Blob;
|
|
48
|
+
expectedVersionId?: string | null;
|
|
49
|
+
baseVersionId?: string | null;
|
|
50
|
+
}
|
|
51
|
+
export interface SaveWorkflowRepoVersionRequest {
|
|
52
|
+
definitionId: string;
|
|
53
|
+
bundle: Blob;
|
|
54
|
+
runId: string;
|
|
55
|
+
expectedVersionId?: string | null;
|
|
56
|
+
candidateVersionId?: string | null;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* WorkflowRepositoryApi - interface
|
|
60
|
+
*
|
|
61
|
+
* @export
|
|
62
|
+
* @interface WorkflowRepositoryApiInterface
|
|
63
|
+
*/
|
|
64
|
+
export interface WorkflowRepositoryApiInterface {
|
|
65
|
+
/**
|
|
66
|
+
* Creates request options for downloadWorkflowRepoBranchBundle without sending the request
|
|
67
|
+
* @param {string} definitionId
|
|
68
|
+
* @param {string} runId
|
|
69
|
+
* @param {string} [versionId] Retained branch version
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
72
|
+
*/
|
|
73
|
+
downloadWorkflowRepoBranchBundleRequestOpts(requestParameters: DownloadWorkflowRepoBranchBundleRequest): Promise<runtime.RequestOpts>;
|
|
74
|
+
/**
|
|
75
|
+
* Download a run branch; a named version must belong to that run.
|
|
76
|
+
* @summary Download Workflow Repo Branch Bundle Handler
|
|
77
|
+
* @param {string} definitionId
|
|
78
|
+
* @param {string} runId
|
|
79
|
+
* @param {string} [versionId] Retained branch version
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
83
|
+
*/
|
|
84
|
+
downloadWorkflowRepoBranchBundleRaw(requestParameters: DownloadWorkflowRepoBranchBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
85
|
+
/**
|
|
86
|
+
* Download a run branch; a named version must belong to that run.
|
|
87
|
+
* Download Workflow Repo Branch Bundle Handler
|
|
88
|
+
*/
|
|
89
|
+
downloadWorkflowRepoBranchBundle(requestParameters: DownloadWorkflowRepoBranchBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
90
|
+
/**
|
|
91
|
+
* Creates request options for downloadWorkflowRepoBundle without sending the request
|
|
92
|
+
* @param {string} definitionId
|
|
93
|
+
* @param {string} [versionId] Saved version; default: main
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
96
|
+
*/
|
|
97
|
+
downloadWorkflowRepoBundleRequestOpts(requestParameters: DownloadWorkflowRepoBundleRequest): Promise<runtime.RequestOpts>;
|
|
98
|
+
/**
|
|
99
|
+
* Download a saved version as a git bundle (what a run clones).
|
|
100
|
+
* @summary Download Workflow Repo Bundle Handler
|
|
101
|
+
* @param {string} definitionId
|
|
102
|
+
* @param {string} [versionId] Saved version; default: main
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
106
|
+
*/
|
|
107
|
+
downloadWorkflowRepoBundleRaw(requestParameters: DownloadWorkflowRepoBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
108
|
+
/**
|
|
109
|
+
* Download a saved version as a git bundle (what a run clones).
|
|
110
|
+
* Download Workflow Repo Bundle Handler
|
|
111
|
+
*/
|
|
112
|
+
downloadWorkflowRepoBundle(requestParameters: DownloadWorkflowRepoBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
113
|
+
/**
|
|
114
|
+
* Creates request options for getWorkflowRepo without sending the request
|
|
115
|
+
* @param {string} definitionId
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
118
|
+
*/
|
|
119
|
+
getWorkflowRepoRequestOpts(requestParameters: GetWorkflowRepoRequest): Promise<runtime.RequestOpts>;
|
|
120
|
+
/**
|
|
121
|
+
* The repository\'s current main: name, head commit and size.
|
|
122
|
+
* @summary Get Workflow Repo Handler
|
|
123
|
+
* @param {string} definitionId
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
127
|
+
*/
|
|
128
|
+
getWorkflowRepoRaw(requestParameters: GetWorkflowRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRepoResponse>>;
|
|
129
|
+
/**
|
|
130
|
+
* The repository\'s current main: name, head commit and size.
|
|
131
|
+
* Get Workflow Repo Handler
|
|
132
|
+
*/
|
|
133
|
+
getWorkflowRepo(requestParameters: GetWorkflowRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRepoResponse>;
|
|
134
|
+
/**
|
|
135
|
+
* Creates request options for getWorkflowRepoBranch without sending the request
|
|
136
|
+
* @param {string} definitionId
|
|
137
|
+
* @param {string} runId
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
140
|
+
*/
|
|
141
|
+
getWorkflowRepoBranchRequestOpts(requestParameters: GetWorkflowRepoBranchRequest): Promise<runtime.RequestOpts>;
|
|
142
|
+
/**
|
|
143
|
+
* The run\'s retained branch and whether its latest version reached main.
|
|
144
|
+
* @summary Get Workflow Repo Branch Handler
|
|
145
|
+
* @param {string} definitionId
|
|
146
|
+
* @param {string} runId
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
150
|
+
*/
|
|
151
|
+
getWorkflowRepoBranchRaw(requestParameters: GetWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoBranchResponse>>;
|
|
152
|
+
/**
|
|
153
|
+
* The run\'s retained branch and whether its latest version reached main.
|
|
154
|
+
* Get Workflow Repo Branch Handler
|
|
155
|
+
*/
|
|
156
|
+
getWorkflowRepoBranch(requestParameters: GetWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoBranchResponse>;
|
|
157
|
+
/**
|
|
158
|
+
* Creates request options for getWorkflowRepoTree without sending the request
|
|
159
|
+
* @param {string} definitionId
|
|
160
|
+
* @param {string} [commit]
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
163
|
+
*/
|
|
164
|
+
getWorkflowRepoTreeRequestOpts(requestParameters: GetWorkflowRepoTreeRequest): Promise<runtime.RequestOpts>;
|
|
165
|
+
/**
|
|
166
|
+
* File metadata at a saved snapshot head (default: main), path-sorted. Intermediate commits without a saved manifest return repo_commit_not_found. This endpoint never reads object storage or interprets Git objects.
|
|
167
|
+
* @summary Get Workflow Repo Tree Handler
|
|
168
|
+
* @param {string} definitionId
|
|
169
|
+
* @param {string} [commit]
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
173
|
+
*/
|
|
174
|
+
getWorkflowRepoTreeRaw(requestParameters: GetWorkflowRepoTreeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoTreeResponse>>;
|
|
175
|
+
/**
|
|
176
|
+
* File metadata at a saved snapshot head (default: main), path-sorted. Intermediate commits without a saved manifest return repo_commit_not_found. This endpoint never reads object storage or interprets Git objects.
|
|
177
|
+
* Get Workflow Repo Tree Handler
|
|
178
|
+
*/
|
|
179
|
+
getWorkflowRepoTree(requestParameters: GetWorkflowRepoTreeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoTreeResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* Creates request options for listWorkflowRepoVersions without sending the request
|
|
182
|
+
* @param {string} definitionId
|
|
183
|
+
* @param {string} [runId] Only versions saved by this run
|
|
184
|
+
* @param {number} [limit] Number of items per page
|
|
185
|
+
* @param {number} [offset] Number of items to skip
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
188
|
+
*/
|
|
189
|
+
listWorkflowRepoVersionsRequestOpts(requestParameters: ListWorkflowRepoVersionsRequest): Promise<runtime.RequestOpts>;
|
|
190
|
+
/**
|
|
191
|
+
* Saved versions, newest first: the save log.
|
|
192
|
+
* @summary List Workflow Repo Versions Handler
|
|
193
|
+
* @param {string} definitionId
|
|
194
|
+
* @param {string} [runId] Only versions saved by this run
|
|
195
|
+
* @param {number} [limit] Number of items per page
|
|
196
|
+
* @param {number} [offset] Number of items to skip
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
200
|
+
*/
|
|
201
|
+
listWorkflowRepoVersionsRaw(requestParameters: ListWorkflowRepoVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseRepoVersionResponse>>;
|
|
202
|
+
/**
|
|
203
|
+
* Saved versions, newest first: the save log.
|
|
204
|
+
* List Workflow Repo Versions Handler
|
|
205
|
+
*/
|
|
206
|
+
listWorkflowRepoVersions(requestParameters: ListWorkflowRepoVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseRepoVersionResponse>;
|
|
207
|
+
/**
|
|
208
|
+
* Creates request options for recordWorkflowRepoSkippedSave without sending the request
|
|
209
|
+
* @param {string} definitionId
|
|
210
|
+
* @param {RecordRepoSaveSkipRequest} recordRepoSaveSkipRequest
|
|
211
|
+
* @throws {RequiredError}
|
|
212
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
213
|
+
*/
|
|
214
|
+
recordWorkflowRepoSkippedSaveRequestOpts(requestParameters: RecordWorkflowRepoSkippedSaveRequest): Promise<runtime.RequestOpts>;
|
|
215
|
+
/**
|
|
216
|
+
* Record on a run that its turn\'s repository changes were not kept. Needs only read on the workflow: the same authority as posting the follow-up message whose turn produced the changes.
|
|
217
|
+
* @summary Record Workflow Repo Skipped Save Handler
|
|
218
|
+
* @param {string} definitionId
|
|
219
|
+
* @param {RecordRepoSaveSkipRequest} recordRepoSaveSkipRequest
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
223
|
+
*/
|
|
224
|
+
recordWorkflowRepoSkippedSaveRaw(requestParameters: RecordWorkflowRepoSkippedSaveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventResponse>>;
|
|
225
|
+
/**
|
|
226
|
+
* Record on a run that its turn\'s repository changes were not kept. Needs only read on the workflow: the same authority as posting the follow-up message whose turn produced the changes.
|
|
227
|
+
* Record Workflow Repo Skipped Save Handler
|
|
228
|
+
*/
|
|
229
|
+
recordWorkflowRepoSkippedSave(requestParameters: RecordWorkflowRepoSkippedSaveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventResponse>;
|
|
230
|
+
/**
|
|
231
|
+
* Creates request options for saveWorkflowRepoBranch without sending the request
|
|
232
|
+
* @param {string} definitionId
|
|
233
|
+
* @param {string} runId
|
|
234
|
+
* @param {Blob} bundle Full git bundle of runs/<run-id>
|
|
235
|
+
* @param {string} [expectedVersionId] Previous retained version of this run branch
|
|
236
|
+
* @param {string} [baseVersionId] Accepted main version this branch started from
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
239
|
+
*/
|
|
240
|
+
saveWorkflowRepoBranchRequestOpts(requestParameters: SaveWorkflowRepoBranchRequest): Promise<runtime.RequestOpts>;
|
|
241
|
+
/**
|
|
242
|
+
* Retain a branch without publishing it to other runs.
|
|
243
|
+
* @summary Save Workflow Repo Branch Handler
|
|
244
|
+
* @param {string} definitionId
|
|
245
|
+
* @param {string} runId
|
|
246
|
+
* @param {Blob} bundle Full git bundle of runs/<run-id>
|
|
247
|
+
* @param {string} [expectedVersionId] Previous retained version of this run branch
|
|
248
|
+
* @param {string} [baseVersionId] Accepted main version this branch started from
|
|
249
|
+
* @param {*} [options] Override http request option.
|
|
250
|
+
* @throws {RequiredError}
|
|
251
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
252
|
+
*/
|
|
253
|
+
saveWorkflowRepoBranchRaw(requestParameters: SaveWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoBranchResponse>>;
|
|
254
|
+
/**
|
|
255
|
+
* Retain a branch without publishing it to other runs.
|
|
256
|
+
* Save Workflow Repo Branch Handler
|
|
257
|
+
*/
|
|
258
|
+
saveWorkflowRepoBranch(requestParameters: SaveWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoBranchResponse>;
|
|
259
|
+
/**
|
|
260
|
+
* Creates request options for saveWorkflowRepoVersion without sending the request
|
|
261
|
+
* @param {string} definitionId
|
|
262
|
+
* @param {Blob} bundle Full git bundle of main
|
|
263
|
+
* @param {string} runId The run saving this version
|
|
264
|
+
* @param {string} [expectedVersionId] The version this save is based on; omit for the first save
|
|
265
|
+
* @param {string} [candidateVersionId] Retained run branch being integrated
|
|
266
|
+
* @throws {RequiredError}
|
|
267
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
268
|
+
*/
|
|
269
|
+
saveWorkflowRepoVersionRequestOpts(requestParameters: SaveWorkflowRepoVersionRequest): Promise<runtime.RequestOpts>;
|
|
270
|
+
/**
|
|
271
|
+
* Make a bundle the workflow\'s new main (compare-and-set on the base version). 409 ``repo_head_moved``: main moved since the base; integrate and retry. 409 ``repo_not_fast_forward``: the bundle does not contain main. 422 ``repo_invalid_bundle`` / ``repo_too_large`` / ``repo_unsafe_path``.
|
|
272
|
+
* @summary Save Workflow Repo Version Handler
|
|
273
|
+
* @param {string} definitionId
|
|
274
|
+
* @param {Blob} bundle Full git bundle of main
|
|
275
|
+
* @param {string} runId The run saving this version
|
|
276
|
+
* @param {string} [expectedVersionId] The version this save is based on; omit for the first save
|
|
277
|
+
* @param {string} [candidateVersionId] Retained run branch being integrated
|
|
278
|
+
* @param {*} [options] Override http request option.
|
|
279
|
+
* @throws {RequiredError}
|
|
280
|
+
* @memberof WorkflowRepositoryApiInterface
|
|
281
|
+
*/
|
|
282
|
+
saveWorkflowRepoVersionRaw(requestParameters: SaveWorkflowRepoVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoVersionResponse>>;
|
|
283
|
+
/**
|
|
284
|
+
* Make a bundle the workflow\'s new main (compare-and-set on the base version). 409 ``repo_head_moved``: main moved since the base; integrate and retry. 409 ``repo_not_fast_forward``: the bundle does not contain main. 422 ``repo_invalid_bundle`` / ``repo_too_large`` / ``repo_unsafe_path``.
|
|
285
|
+
* Save Workflow Repo Version Handler
|
|
286
|
+
*/
|
|
287
|
+
saveWorkflowRepoVersion(requestParameters: SaveWorkflowRepoVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoVersionResponse>;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
*/
|
|
292
|
+
export declare class WorkflowRepositoryApi extends runtime.BaseAPI implements WorkflowRepositoryApiInterface {
|
|
293
|
+
/**
|
|
294
|
+
* Creates request options for downloadWorkflowRepoBranchBundle without sending the request
|
|
295
|
+
*/
|
|
296
|
+
downloadWorkflowRepoBranchBundleRequestOpts(requestParameters: DownloadWorkflowRepoBranchBundleRequest): Promise<runtime.RequestOpts>;
|
|
297
|
+
/**
|
|
298
|
+
* Download a run branch; a named version must belong to that run.
|
|
299
|
+
* Download Workflow Repo Branch Bundle Handler
|
|
300
|
+
*/
|
|
301
|
+
downloadWorkflowRepoBranchBundleRaw(requestParameters: DownloadWorkflowRepoBranchBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
302
|
+
/**
|
|
303
|
+
* Download a run branch; a named version must belong to that run.
|
|
304
|
+
* Download Workflow Repo Branch Bundle Handler
|
|
305
|
+
*/
|
|
306
|
+
downloadWorkflowRepoBranchBundle(requestParameters: DownloadWorkflowRepoBranchBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
307
|
+
/**
|
|
308
|
+
* Creates request options for downloadWorkflowRepoBundle without sending the request
|
|
309
|
+
*/
|
|
310
|
+
downloadWorkflowRepoBundleRequestOpts(requestParameters: DownloadWorkflowRepoBundleRequest): Promise<runtime.RequestOpts>;
|
|
311
|
+
/**
|
|
312
|
+
* Download a saved version as a git bundle (what a run clones).
|
|
313
|
+
* Download Workflow Repo Bundle Handler
|
|
314
|
+
*/
|
|
315
|
+
downloadWorkflowRepoBundleRaw(requestParameters: DownloadWorkflowRepoBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
316
|
+
/**
|
|
317
|
+
* Download a saved version as a git bundle (what a run clones).
|
|
318
|
+
* Download Workflow Repo Bundle Handler
|
|
319
|
+
*/
|
|
320
|
+
downloadWorkflowRepoBundle(requestParameters: DownloadWorkflowRepoBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
321
|
+
/**
|
|
322
|
+
* Creates request options for getWorkflowRepo without sending the request
|
|
323
|
+
*/
|
|
324
|
+
getWorkflowRepoRequestOpts(requestParameters: GetWorkflowRepoRequest): Promise<runtime.RequestOpts>;
|
|
325
|
+
/**
|
|
326
|
+
* The repository\'s current main: name, head commit and size.
|
|
327
|
+
* Get Workflow Repo Handler
|
|
328
|
+
*/
|
|
329
|
+
getWorkflowRepoRaw(requestParameters: GetWorkflowRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRepoResponse>>;
|
|
330
|
+
/**
|
|
331
|
+
* The repository\'s current main: name, head commit and size.
|
|
332
|
+
* Get Workflow Repo Handler
|
|
333
|
+
*/
|
|
334
|
+
getWorkflowRepo(requestParameters: GetWorkflowRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRepoResponse>;
|
|
335
|
+
/**
|
|
336
|
+
* Creates request options for getWorkflowRepoBranch without sending the request
|
|
337
|
+
*/
|
|
338
|
+
getWorkflowRepoBranchRequestOpts(requestParameters: GetWorkflowRepoBranchRequest): Promise<runtime.RequestOpts>;
|
|
339
|
+
/**
|
|
340
|
+
* The run\'s retained branch and whether its latest version reached main.
|
|
341
|
+
* Get Workflow Repo Branch Handler
|
|
342
|
+
*/
|
|
343
|
+
getWorkflowRepoBranchRaw(requestParameters: GetWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoBranchResponse>>;
|
|
344
|
+
/**
|
|
345
|
+
* The run\'s retained branch and whether its latest version reached main.
|
|
346
|
+
* Get Workflow Repo Branch Handler
|
|
347
|
+
*/
|
|
348
|
+
getWorkflowRepoBranch(requestParameters: GetWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoBranchResponse>;
|
|
349
|
+
/**
|
|
350
|
+
* Creates request options for getWorkflowRepoTree without sending the request
|
|
351
|
+
*/
|
|
352
|
+
getWorkflowRepoTreeRequestOpts(requestParameters: GetWorkflowRepoTreeRequest): Promise<runtime.RequestOpts>;
|
|
353
|
+
/**
|
|
354
|
+
* File metadata at a saved snapshot head (default: main), path-sorted. Intermediate commits without a saved manifest return repo_commit_not_found. This endpoint never reads object storage or interprets Git objects.
|
|
355
|
+
* Get Workflow Repo Tree Handler
|
|
356
|
+
*/
|
|
357
|
+
getWorkflowRepoTreeRaw(requestParameters: GetWorkflowRepoTreeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoTreeResponse>>;
|
|
358
|
+
/**
|
|
359
|
+
* File metadata at a saved snapshot head (default: main), path-sorted. Intermediate commits without a saved manifest return repo_commit_not_found. This endpoint never reads object storage or interprets Git objects.
|
|
360
|
+
* Get Workflow Repo Tree Handler
|
|
361
|
+
*/
|
|
362
|
+
getWorkflowRepoTree(requestParameters: GetWorkflowRepoTreeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoTreeResponse>;
|
|
363
|
+
/**
|
|
364
|
+
* Creates request options for listWorkflowRepoVersions without sending the request
|
|
365
|
+
*/
|
|
366
|
+
listWorkflowRepoVersionsRequestOpts(requestParameters: ListWorkflowRepoVersionsRequest): Promise<runtime.RequestOpts>;
|
|
367
|
+
/**
|
|
368
|
+
* Saved versions, newest first: the save log.
|
|
369
|
+
* List Workflow Repo Versions Handler
|
|
370
|
+
*/
|
|
371
|
+
listWorkflowRepoVersionsRaw(requestParameters: ListWorkflowRepoVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseRepoVersionResponse>>;
|
|
372
|
+
/**
|
|
373
|
+
* Saved versions, newest first: the save log.
|
|
374
|
+
* List Workflow Repo Versions Handler
|
|
375
|
+
*/
|
|
376
|
+
listWorkflowRepoVersions(requestParameters: ListWorkflowRepoVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseRepoVersionResponse>;
|
|
377
|
+
/**
|
|
378
|
+
* Creates request options for recordWorkflowRepoSkippedSave without sending the request
|
|
379
|
+
*/
|
|
380
|
+
recordWorkflowRepoSkippedSaveRequestOpts(requestParameters: RecordWorkflowRepoSkippedSaveRequest): Promise<runtime.RequestOpts>;
|
|
381
|
+
/**
|
|
382
|
+
* Record on a run that its turn\'s repository changes were not kept. Needs only read on the workflow: the same authority as posting the follow-up message whose turn produced the changes.
|
|
383
|
+
* Record Workflow Repo Skipped Save Handler
|
|
384
|
+
*/
|
|
385
|
+
recordWorkflowRepoSkippedSaveRaw(requestParameters: RecordWorkflowRepoSkippedSaveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventResponse>>;
|
|
386
|
+
/**
|
|
387
|
+
* Record on a run that its turn\'s repository changes were not kept. Needs only read on the workflow: the same authority as posting the follow-up message whose turn produced the changes.
|
|
388
|
+
* Record Workflow Repo Skipped Save Handler
|
|
389
|
+
*/
|
|
390
|
+
recordWorkflowRepoSkippedSave(requestParameters: RecordWorkflowRepoSkippedSaveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventResponse>;
|
|
391
|
+
/**
|
|
392
|
+
* Creates request options for saveWorkflowRepoBranch without sending the request
|
|
393
|
+
*/
|
|
394
|
+
saveWorkflowRepoBranchRequestOpts(requestParameters: SaveWorkflowRepoBranchRequest): Promise<runtime.RequestOpts>;
|
|
395
|
+
/**
|
|
396
|
+
* Retain a branch without publishing it to other runs.
|
|
397
|
+
* Save Workflow Repo Branch Handler
|
|
398
|
+
*/
|
|
399
|
+
saveWorkflowRepoBranchRaw(requestParameters: SaveWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoBranchResponse>>;
|
|
400
|
+
/**
|
|
401
|
+
* Retain a branch without publishing it to other runs.
|
|
402
|
+
* Save Workflow Repo Branch Handler
|
|
403
|
+
*/
|
|
404
|
+
saveWorkflowRepoBranch(requestParameters: SaveWorkflowRepoBranchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoBranchResponse>;
|
|
405
|
+
/**
|
|
406
|
+
* Creates request options for saveWorkflowRepoVersion without sending the request
|
|
407
|
+
*/
|
|
408
|
+
saveWorkflowRepoVersionRequestOpts(requestParameters: SaveWorkflowRepoVersionRequest): Promise<runtime.RequestOpts>;
|
|
409
|
+
/**
|
|
410
|
+
* Make a bundle the workflow\'s new main (compare-and-set on the base version). 409 ``repo_head_moved``: main moved since the base; integrate and retry. 409 ``repo_not_fast_forward``: the bundle does not contain main. 422 ``repo_invalid_bundle`` / ``repo_too_large`` / ``repo_unsafe_path``.
|
|
411
|
+
* Save Workflow Repo Version Handler
|
|
412
|
+
*/
|
|
413
|
+
saveWorkflowRepoVersionRaw(requestParameters: SaveWorkflowRepoVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RepoVersionResponse>>;
|
|
414
|
+
/**
|
|
415
|
+
* Make a bundle the workflow\'s new main (compare-and-set on the base version). 409 ``repo_head_moved``: main moved since the base; integrate and retry. 409 ``repo_not_fast_forward``: the bundle does not contain main. 422 ``repo_invalid_bundle`` / ``repo_too_large`` / ``repo_unsafe_path``.
|
|
416
|
+
* Save Workflow Repo Version Handler
|
|
417
|
+
*/
|
|
418
|
+
saveWorkflowRepoVersion(requestParameters: SaveWorkflowRepoVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RepoVersionResponse>;
|
|
419
|
+
}
|