@camunda8/hub-public-api-client 0.1.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/README.md +124 -0
- package/dist/client.d.ts +36 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +33 -0
- package/dist/client.js.map +1 -0
- package/dist/generated/schema.d.ts +2568 -0
- package/dist/generated/schema.d.ts.map +1 -0
- package/dist/generated/schema.js +9 -0
- package/dist/generated/schema.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -0
- package/package.json +47 -0
|
@@ -0,0 +1,2568 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file is auto-generated from the public API v2 OpenAPI spec.
|
|
3
|
+
*
|
|
4
|
+
* Do NOT edit it by hand. Update the spec under
|
|
5
|
+
* `restapi/public-api/src/main/resources/openapi/v2` and run `npm run generate`.
|
|
6
|
+
*/
|
|
7
|
+
export interface paths {
|
|
8
|
+
"/catalog/assets/{assetKey}": {
|
|
9
|
+
parameters: {
|
|
10
|
+
query?: never;
|
|
11
|
+
header?: never;
|
|
12
|
+
path?: never;
|
|
13
|
+
cookie?: never;
|
|
14
|
+
};
|
|
15
|
+
get?: never;
|
|
16
|
+
put?: never;
|
|
17
|
+
post?: never;
|
|
18
|
+
/**
|
|
19
|
+
* Delete a catalog asset
|
|
20
|
+
* @description Deletes the catalog asset with the given asset key.
|
|
21
|
+
*/
|
|
22
|
+
delete: operations["deleteCatalogAsset"];
|
|
23
|
+
options?: never;
|
|
24
|
+
head?: never;
|
|
25
|
+
patch?: never;
|
|
26
|
+
trace?: never;
|
|
27
|
+
};
|
|
28
|
+
"/catalog/assets/ingestion": {
|
|
29
|
+
parameters: {
|
|
30
|
+
query?: never;
|
|
31
|
+
header?: never;
|
|
32
|
+
path?: never;
|
|
33
|
+
cookie?: never;
|
|
34
|
+
};
|
|
35
|
+
get?: never;
|
|
36
|
+
/**
|
|
37
|
+
* Ingest catalog assets
|
|
38
|
+
* @description Ingests the full set of catalog assets.
|
|
39
|
+
*
|
|
40
|
+
* For each asset, the actual element template JSON file as well as an accompanying README file must be provided.
|
|
41
|
+
* The README should provide a description of the asset and can use Markdown syntax. It must contain a YAML
|
|
42
|
+
* frontmatter section with a `template` field that references the element template by its file name. Optionally,
|
|
43
|
+
* the frontmatter can specify a `category` and a list of `tags` that can be used to search and filter assets in
|
|
44
|
+
* the catalog.
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
* ---
|
|
48
|
+
* template: banking-system-connector.json
|
|
49
|
+
* category: Finance
|
|
50
|
+
* tags:
|
|
51
|
+
* - invoice
|
|
52
|
+
* - payment
|
|
53
|
+
* - transaction
|
|
54
|
+
* ---
|
|
55
|
+
* ## Description
|
|
56
|
+
* ...
|
|
57
|
+
*
|
|
58
|
+
* ## Usage
|
|
59
|
+
* ...
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* The files must be provided as `multipart/form-data` with the named parts `readme` and `template` (the part name
|
|
63
|
+
* is the same for each file of the respective type).
|
|
64
|
+
*
|
|
65
|
+
* Previously ingested assets that are not included in the request payload will be marked as unpublished in the
|
|
66
|
+
* catalog. Unpublished assets are only accessible to administrators; regular modeling users cannot use them for
|
|
67
|
+
* new diagram elements anymore. Existing diagrams using assets that get unpublished will continue to work as
|
|
68
|
+
* before.
|
|
69
|
+
*/
|
|
70
|
+
put: operations["ingestCatalogAssets"];
|
|
71
|
+
post?: never;
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
77
|
+
};
|
|
78
|
+
"/files": {
|
|
79
|
+
parameters: {
|
|
80
|
+
query?: never;
|
|
81
|
+
header?: never;
|
|
82
|
+
path?: never;
|
|
83
|
+
cookie?: never;
|
|
84
|
+
};
|
|
85
|
+
get?: never;
|
|
86
|
+
put?: never;
|
|
87
|
+
/**
|
|
88
|
+
* Create a file
|
|
89
|
+
* @description Creates a new file in the specified project and folder.
|
|
90
|
+
*/
|
|
91
|
+
post: operations["createFile"];
|
|
92
|
+
delete?: never;
|
|
93
|
+
options?: never;
|
|
94
|
+
head?: never;
|
|
95
|
+
patch?: never;
|
|
96
|
+
trace?: never;
|
|
97
|
+
};
|
|
98
|
+
"/files/{fileKey}": {
|
|
99
|
+
parameters: {
|
|
100
|
+
query?: never;
|
|
101
|
+
header?: never;
|
|
102
|
+
path?: never;
|
|
103
|
+
cookie?: never;
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* Get a file
|
|
107
|
+
* @description Returns the file metadata and content for the given file key.
|
|
108
|
+
*/
|
|
109
|
+
get: operations["getFile"];
|
|
110
|
+
put?: never;
|
|
111
|
+
post?: never;
|
|
112
|
+
/**
|
|
113
|
+
* Delete a file
|
|
114
|
+
* @description Deletes the file with the given file key.
|
|
115
|
+
*/
|
|
116
|
+
delete: operations["deleteFile"];
|
|
117
|
+
options?: never;
|
|
118
|
+
head?: never;
|
|
119
|
+
/**
|
|
120
|
+
* Update a file
|
|
121
|
+
* @description Updates the metadata and/or content of an existing file.
|
|
122
|
+
*/
|
|
123
|
+
patch: operations["updateFile"];
|
|
124
|
+
trace?: never;
|
|
125
|
+
};
|
|
126
|
+
"/files/search": {
|
|
127
|
+
parameters: {
|
|
128
|
+
query?: never;
|
|
129
|
+
header?: never;
|
|
130
|
+
path?: never;
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
133
|
+
get?: never;
|
|
134
|
+
put?: never;
|
|
135
|
+
/**
|
|
136
|
+
* Search files
|
|
137
|
+
* @description Returns files matching the given search criteria.
|
|
138
|
+
*/
|
|
139
|
+
post: operations["searchFiles"];
|
|
140
|
+
delete?: never;
|
|
141
|
+
options?: never;
|
|
142
|
+
head?: never;
|
|
143
|
+
patch?: never;
|
|
144
|
+
trace?: never;
|
|
145
|
+
};
|
|
146
|
+
"/folders": {
|
|
147
|
+
parameters: {
|
|
148
|
+
query?: never;
|
|
149
|
+
header?: never;
|
|
150
|
+
path?: never;
|
|
151
|
+
cookie?: never;
|
|
152
|
+
};
|
|
153
|
+
get?: never;
|
|
154
|
+
put?: never;
|
|
155
|
+
/**
|
|
156
|
+
* Create a folder
|
|
157
|
+
* @description Creates a new folder in the specified project and/or parent folder.
|
|
158
|
+
*/
|
|
159
|
+
post: operations["createFolder"];
|
|
160
|
+
delete?: never;
|
|
161
|
+
options?: never;
|
|
162
|
+
head?: never;
|
|
163
|
+
patch?: never;
|
|
164
|
+
trace?: never;
|
|
165
|
+
};
|
|
166
|
+
"/folders/{folderKey}": {
|
|
167
|
+
parameters: {
|
|
168
|
+
query?: never;
|
|
169
|
+
header?: never;
|
|
170
|
+
path?: never;
|
|
171
|
+
cookie?: never;
|
|
172
|
+
};
|
|
173
|
+
/**
|
|
174
|
+
* Get a folder
|
|
175
|
+
* @description Returns the folder metadata and its content (child folders and files).
|
|
176
|
+
*/
|
|
177
|
+
get: operations["getFolder"];
|
|
178
|
+
put?: never;
|
|
179
|
+
post?: never;
|
|
180
|
+
/**
|
|
181
|
+
* Delete a folder
|
|
182
|
+
* @description Deletes the folder with the given folder key. The folder must have no files in the folder or any of its descendants.
|
|
183
|
+
*/
|
|
184
|
+
delete: operations["deleteFolder"];
|
|
185
|
+
options?: never;
|
|
186
|
+
head?: never;
|
|
187
|
+
/**
|
|
188
|
+
* Update a folder
|
|
189
|
+
* @description Updates the name and/or location of an existing folder.
|
|
190
|
+
*/
|
|
191
|
+
patch: operations["updateFolder"];
|
|
192
|
+
trace?: never;
|
|
193
|
+
};
|
|
194
|
+
"/info": {
|
|
195
|
+
parameters: {
|
|
196
|
+
query?: never;
|
|
197
|
+
header?: never;
|
|
198
|
+
path?: never;
|
|
199
|
+
cookie?: never;
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* Get API info
|
|
203
|
+
* @description Returns metadata about the V2 API, including the API version and the organization authorized by the caller's credentials.
|
|
204
|
+
*/
|
|
205
|
+
get: operations["getInfo"];
|
|
206
|
+
put?: never;
|
|
207
|
+
post?: never;
|
|
208
|
+
delete?: never;
|
|
209
|
+
options?: never;
|
|
210
|
+
head?: never;
|
|
211
|
+
patch?: never;
|
|
212
|
+
trace?: never;
|
|
213
|
+
};
|
|
214
|
+
"/members/search": {
|
|
215
|
+
parameters: {
|
|
216
|
+
query?: never;
|
|
217
|
+
header?: never;
|
|
218
|
+
path?: never;
|
|
219
|
+
cookie?: never;
|
|
220
|
+
};
|
|
221
|
+
get?: never;
|
|
222
|
+
put?: never;
|
|
223
|
+
/**
|
|
224
|
+
* Search members
|
|
225
|
+
* @description Returns members matching the given search criteria. A workspace key filter is required — members cannot be searched across workspaces.
|
|
226
|
+
*/
|
|
227
|
+
post: operations["searchMembers"];
|
|
228
|
+
delete?: never;
|
|
229
|
+
options?: never;
|
|
230
|
+
head?: never;
|
|
231
|
+
patch?: never;
|
|
232
|
+
trace?: never;
|
|
233
|
+
};
|
|
234
|
+
"/projects": {
|
|
235
|
+
parameters: {
|
|
236
|
+
query?: never;
|
|
237
|
+
header?: never;
|
|
238
|
+
path?: never;
|
|
239
|
+
cookie?: never;
|
|
240
|
+
};
|
|
241
|
+
get?: never;
|
|
242
|
+
put?: never;
|
|
243
|
+
/**
|
|
244
|
+
* Create a project
|
|
245
|
+
* @description Creates a new empty project in the specified workspace.
|
|
246
|
+
*/
|
|
247
|
+
post: operations["createProject"];
|
|
248
|
+
delete?: never;
|
|
249
|
+
options?: never;
|
|
250
|
+
head?: never;
|
|
251
|
+
patch?: never;
|
|
252
|
+
trace?: never;
|
|
253
|
+
};
|
|
254
|
+
"/projects/{projectKey}": {
|
|
255
|
+
parameters: {
|
|
256
|
+
query?: never;
|
|
257
|
+
header?: never;
|
|
258
|
+
path?: never;
|
|
259
|
+
cookie?: never;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* Get a project
|
|
263
|
+
* @description Returns the project metadata and its content (child folders and files).
|
|
264
|
+
*/
|
|
265
|
+
get: operations["getProject"];
|
|
266
|
+
put?: never;
|
|
267
|
+
post?: never;
|
|
268
|
+
/**
|
|
269
|
+
* Delete a project
|
|
270
|
+
* @description Deletes the project with the given project key. The project must have no files in the project or any of its descendants. Empty folders and version history are removed as part of the deletion.
|
|
271
|
+
*/
|
|
272
|
+
delete: operations["deleteProject"];
|
|
273
|
+
options?: never;
|
|
274
|
+
head?: never;
|
|
275
|
+
/**
|
|
276
|
+
* Update a project
|
|
277
|
+
* @description Updates the name and/or workspace of an existing project.
|
|
278
|
+
*/
|
|
279
|
+
patch: operations["updateProject"];
|
|
280
|
+
trace?: never;
|
|
281
|
+
};
|
|
282
|
+
"/projects/search": {
|
|
283
|
+
parameters: {
|
|
284
|
+
query?: never;
|
|
285
|
+
header?: never;
|
|
286
|
+
path?: never;
|
|
287
|
+
cookie?: never;
|
|
288
|
+
};
|
|
289
|
+
get?: never;
|
|
290
|
+
put?: never;
|
|
291
|
+
/**
|
|
292
|
+
* Search projects
|
|
293
|
+
* @description Returns projects matching the given search criteria across all workspaces in the caller's organization.
|
|
294
|
+
*/
|
|
295
|
+
post: operations["searchProjects"];
|
|
296
|
+
delete?: never;
|
|
297
|
+
options?: never;
|
|
298
|
+
head?: never;
|
|
299
|
+
patch?: never;
|
|
300
|
+
trace?: never;
|
|
301
|
+
};
|
|
302
|
+
"/versions": {
|
|
303
|
+
parameters: {
|
|
304
|
+
query?: never;
|
|
305
|
+
header?: never;
|
|
306
|
+
path?: never;
|
|
307
|
+
cookie?: never;
|
|
308
|
+
};
|
|
309
|
+
get?: never;
|
|
310
|
+
put?: never;
|
|
311
|
+
/**
|
|
312
|
+
* Create a version
|
|
313
|
+
* @description Creates a new version by taking a snapshot of the current content of the specified file.
|
|
314
|
+
*/
|
|
315
|
+
post: operations["createVersion"];
|
|
316
|
+
delete?: never;
|
|
317
|
+
options?: never;
|
|
318
|
+
head?: never;
|
|
319
|
+
patch?: never;
|
|
320
|
+
trace?: never;
|
|
321
|
+
};
|
|
322
|
+
"/versions/{versionKey}": {
|
|
323
|
+
parameters: {
|
|
324
|
+
query?: never;
|
|
325
|
+
header?: never;
|
|
326
|
+
path?: never;
|
|
327
|
+
cookie?: never;
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* Get a version
|
|
331
|
+
* @description Returns the version metadata and the file content at that version.
|
|
332
|
+
*/
|
|
333
|
+
get: operations["getVersion"];
|
|
334
|
+
put?: never;
|
|
335
|
+
post?: never;
|
|
336
|
+
/**
|
|
337
|
+
* Delete a version
|
|
338
|
+
* @description Deletes the specified version.
|
|
339
|
+
*/
|
|
340
|
+
delete: operations["deleteVersion"];
|
|
341
|
+
options?: never;
|
|
342
|
+
head?: never;
|
|
343
|
+
/**
|
|
344
|
+
* Update a version
|
|
345
|
+
* @description Updates the name of an existing version.
|
|
346
|
+
*/
|
|
347
|
+
patch: operations["updateVersion"];
|
|
348
|
+
trace?: never;
|
|
349
|
+
};
|
|
350
|
+
"/versions/{versionKey}/restoration": {
|
|
351
|
+
parameters: {
|
|
352
|
+
query?: never;
|
|
353
|
+
header?: never;
|
|
354
|
+
path?: never;
|
|
355
|
+
cookie?: never;
|
|
356
|
+
};
|
|
357
|
+
get?: never;
|
|
358
|
+
put?: never;
|
|
359
|
+
/**
|
|
360
|
+
* Restore a version
|
|
361
|
+
* @description Restores the file content to the state captured in this version. A new version is created representing the restored state. For element template files, the request body must include the target version number.
|
|
362
|
+
*/
|
|
363
|
+
post: operations["restoreVersion"];
|
|
364
|
+
delete?: never;
|
|
365
|
+
options?: never;
|
|
366
|
+
head?: never;
|
|
367
|
+
patch?: never;
|
|
368
|
+
trace?: never;
|
|
369
|
+
};
|
|
370
|
+
"/versions/search": {
|
|
371
|
+
parameters: {
|
|
372
|
+
query?: never;
|
|
373
|
+
header?: never;
|
|
374
|
+
path?: never;
|
|
375
|
+
cookie?: never;
|
|
376
|
+
};
|
|
377
|
+
get?: never;
|
|
378
|
+
put?: never;
|
|
379
|
+
/**
|
|
380
|
+
* Search versions
|
|
381
|
+
* @description Returns versions matching the given search criteria.
|
|
382
|
+
*/
|
|
383
|
+
post: operations["searchVersions"];
|
|
384
|
+
delete?: never;
|
|
385
|
+
options?: never;
|
|
386
|
+
head?: never;
|
|
387
|
+
patch?: never;
|
|
388
|
+
trace?: never;
|
|
389
|
+
};
|
|
390
|
+
"/workspaces": {
|
|
391
|
+
parameters: {
|
|
392
|
+
query?: never;
|
|
393
|
+
header?: never;
|
|
394
|
+
path?: never;
|
|
395
|
+
cookie?: never;
|
|
396
|
+
};
|
|
397
|
+
get?: never;
|
|
398
|
+
put?: never;
|
|
399
|
+
/**
|
|
400
|
+
* Create a workspace
|
|
401
|
+
* @description Creates a new workspace in the caller's organization.
|
|
402
|
+
*/
|
|
403
|
+
post: operations["createWorkspace"];
|
|
404
|
+
delete?: never;
|
|
405
|
+
options?: never;
|
|
406
|
+
head?: never;
|
|
407
|
+
patch?: never;
|
|
408
|
+
trace?: never;
|
|
409
|
+
};
|
|
410
|
+
"/workspaces/{workspaceKey}": {
|
|
411
|
+
parameters: {
|
|
412
|
+
query?: never;
|
|
413
|
+
header?: never;
|
|
414
|
+
path?: never;
|
|
415
|
+
cookie?: never;
|
|
416
|
+
};
|
|
417
|
+
/**
|
|
418
|
+
* Get a workspace
|
|
419
|
+
* @description Returns the workspace metadata and its contained projects.
|
|
420
|
+
*/
|
|
421
|
+
get: operations["getWorkspace"];
|
|
422
|
+
put?: never;
|
|
423
|
+
post?: never;
|
|
424
|
+
/**
|
|
425
|
+
* Delete a workspace
|
|
426
|
+
* @description Deletes the workspace with the given key. The workspace must be empty, meaning it contains no files, no projects, and no IDP applications.
|
|
427
|
+
*/
|
|
428
|
+
delete: operations["deleteWorkspace"];
|
|
429
|
+
options?: never;
|
|
430
|
+
head?: never;
|
|
431
|
+
/**
|
|
432
|
+
* Update a workspace
|
|
433
|
+
* @description Updates an existing workspace.
|
|
434
|
+
*/
|
|
435
|
+
patch: operations["updateWorkspace"];
|
|
436
|
+
trace?: never;
|
|
437
|
+
};
|
|
438
|
+
"/workspaces/{workspaceKey}/members": {
|
|
439
|
+
parameters: {
|
|
440
|
+
query?: never;
|
|
441
|
+
header?: never;
|
|
442
|
+
path?: never;
|
|
443
|
+
cookie?: never;
|
|
444
|
+
};
|
|
445
|
+
get?: never;
|
|
446
|
+
put?: never;
|
|
447
|
+
/**
|
|
448
|
+
* Add or update a member
|
|
449
|
+
* @description Adds a member to the workspace, or updates the role of an existing member. The member is identified by their email address.
|
|
450
|
+
*/
|
|
451
|
+
post: operations["addMember"];
|
|
452
|
+
delete?: never;
|
|
453
|
+
options?: never;
|
|
454
|
+
head?: never;
|
|
455
|
+
patch?: never;
|
|
456
|
+
trace?: never;
|
|
457
|
+
};
|
|
458
|
+
"/workspaces/{workspaceKey}/members/{email}": {
|
|
459
|
+
parameters: {
|
|
460
|
+
query?: never;
|
|
461
|
+
header?: never;
|
|
462
|
+
path?: never;
|
|
463
|
+
cookie?: never;
|
|
464
|
+
};
|
|
465
|
+
get?: never;
|
|
466
|
+
put?: never;
|
|
467
|
+
post?: never;
|
|
468
|
+
/**
|
|
469
|
+
* Remove a member
|
|
470
|
+
* @description Removes a member from the workspace.
|
|
471
|
+
*/
|
|
472
|
+
delete: operations["removeMember"];
|
|
473
|
+
options?: never;
|
|
474
|
+
head?: never;
|
|
475
|
+
patch?: never;
|
|
476
|
+
trace?: never;
|
|
477
|
+
};
|
|
478
|
+
"/workspaces/search": {
|
|
479
|
+
parameters: {
|
|
480
|
+
query?: never;
|
|
481
|
+
header?: never;
|
|
482
|
+
path?: never;
|
|
483
|
+
cookie?: never;
|
|
484
|
+
};
|
|
485
|
+
get?: never;
|
|
486
|
+
put?: never;
|
|
487
|
+
/**
|
|
488
|
+
* Search workspaces
|
|
489
|
+
* @description Returns workspaces matching the given search criteria. Results are scoped to the caller's organization.
|
|
490
|
+
*/
|
|
491
|
+
post: operations["searchWorkspaces"];
|
|
492
|
+
delete?: never;
|
|
493
|
+
options?: never;
|
|
494
|
+
head?: never;
|
|
495
|
+
patch?: never;
|
|
496
|
+
trace?: never;
|
|
497
|
+
};
|
|
498
|
+
}
|
|
499
|
+
export type webhooks = Record<string, never>;
|
|
500
|
+
export interface components {
|
|
501
|
+
schemas: {
|
|
502
|
+
/**
|
|
503
|
+
* Advanced filter
|
|
504
|
+
* @description Advanced date-time filter.
|
|
505
|
+
*/
|
|
506
|
+
AdvancedDateTimeFilter: {
|
|
507
|
+
/**
|
|
508
|
+
* Format: date-time
|
|
509
|
+
* @description Checks for equality with the provided value.
|
|
510
|
+
*/
|
|
511
|
+
$eq?: string;
|
|
512
|
+
/** @description Checks if the current property exists. */
|
|
513
|
+
$exists?: boolean;
|
|
514
|
+
/**
|
|
515
|
+
* Format: date-time
|
|
516
|
+
* @description Greater than comparison with the provided value.
|
|
517
|
+
*/
|
|
518
|
+
$gt?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Format: date-time
|
|
521
|
+
* @description Greater than or equal comparison with the provided value.
|
|
522
|
+
*/
|
|
523
|
+
$gte?: string;
|
|
524
|
+
/** @description Checks if the property matches any of the provided values. */
|
|
525
|
+
$in?: string[];
|
|
526
|
+
/**
|
|
527
|
+
* Format: date-time
|
|
528
|
+
* @description Lower than comparison with the provided value.
|
|
529
|
+
*/
|
|
530
|
+
$lt?: string;
|
|
531
|
+
/**
|
|
532
|
+
* Format: date-time
|
|
533
|
+
* @description Lower than or equal comparison with the provided value.
|
|
534
|
+
*/
|
|
535
|
+
$lte?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Format: date-time
|
|
538
|
+
* @description Checks for inequality with the provided value.
|
|
539
|
+
*/
|
|
540
|
+
$neq?: string;
|
|
541
|
+
/** @description Checks if the property matches none of the provided values. */
|
|
542
|
+
$notIn?: string[];
|
|
543
|
+
};
|
|
544
|
+
/**
|
|
545
|
+
* Advanced filter
|
|
546
|
+
* @description Advanced string filter.
|
|
547
|
+
*/
|
|
548
|
+
AdvancedStringFilter: components["schemas"]["BasicStringFilter"] & {
|
|
549
|
+
$like?: components["schemas"]["LikeFilter"];
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* Advanced filter
|
|
553
|
+
* @description Basic advanced string filter.
|
|
554
|
+
*/
|
|
555
|
+
BasicStringFilter: {
|
|
556
|
+
/** @description Checks for equality with the provided value. */
|
|
557
|
+
$eq?: string;
|
|
558
|
+
/** @description Checks if the current property exists. */
|
|
559
|
+
$exists?: boolean;
|
|
560
|
+
/** @description Checks if the property matches any of the provided values. */
|
|
561
|
+
$in?: string[];
|
|
562
|
+
/** @description Checks for inequality with the provided value. */
|
|
563
|
+
$neq?: string;
|
|
564
|
+
/** @description Checks if the property matches none of the provided values. */
|
|
565
|
+
$notIn?: string[];
|
|
566
|
+
};
|
|
567
|
+
/** @description String property with basic advanced search capabilities. */
|
|
568
|
+
BasicStringFilterProperty: string | components["schemas"]["BasicStringFilter"];
|
|
569
|
+
CatalogAssetIngestionRequest: {
|
|
570
|
+
/** @description The README files. Each README must reference an element template in its YAML frontmatter. */
|
|
571
|
+
readme: string[];
|
|
572
|
+
/** @description The element template files. Each element template must have a corresponding README file. */
|
|
573
|
+
template: string[];
|
|
574
|
+
};
|
|
575
|
+
/** @description Date-time property with full advanced search capabilities. */
|
|
576
|
+
DateTimeFilterProperty: string | components["schemas"]["AdvancedDateTimeFilter"];
|
|
577
|
+
/**
|
|
578
|
+
* Format: base64
|
|
579
|
+
* @description The end cursor in a search query result set.
|
|
580
|
+
* @example WzIyNTE3OTk4MTM2ODcxMDJd
|
|
581
|
+
*/
|
|
582
|
+
EndCursor: string;
|
|
583
|
+
/**
|
|
584
|
+
* @example {
|
|
585
|
+
* "name": "order-process.bpmn",
|
|
586
|
+
* "projectKey": "prj-def-456",
|
|
587
|
+
* "folderKey": "fld-012-ghi",
|
|
588
|
+
* "type": "bpmn",
|
|
589
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>..."
|
|
590
|
+
* }
|
|
591
|
+
*/
|
|
592
|
+
FileCreateRequest: {
|
|
593
|
+
/** @description The content of the file. */
|
|
594
|
+
content: string;
|
|
595
|
+
/** @description The key of the parent folder. If omitted or null, the file is created at project root. */
|
|
596
|
+
folderKey?: string | null;
|
|
597
|
+
/** @description The name of the file. */
|
|
598
|
+
name: string;
|
|
599
|
+
/** @description The key of the project this file belongs to. */
|
|
600
|
+
projectKey: string;
|
|
601
|
+
/**
|
|
602
|
+
* @description The type of the file.
|
|
603
|
+
* @enum {string}
|
|
604
|
+
*/
|
|
605
|
+
type: "bpmn" | "dmn" | "form" | "element-template" | "rpa" | "markdown" | "tests";
|
|
606
|
+
};
|
|
607
|
+
/** @description Filter criteria for searching files. */
|
|
608
|
+
FileFilter: {
|
|
609
|
+
/** @description Filter by creation date. */
|
|
610
|
+
created?: components["schemas"]["DateTimeFilterProperty"];
|
|
611
|
+
/** @description Filter by creator email address. */
|
|
612
|
+
createdBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
613
|
+
/** @description Filter by parent folder key. */
|
|
614
|
+
folderKey?: components["schemas"]["BasicStringFilterProperty"];
|
|
615
|
+
/** @description Filter by file name. */
|
|
616
|
+
name?: components["schemas"]["StringFilterProperty"];
|
|
617
|
+
/** @description Filter by project key. */
|
|
618
|
+
projectKey?: components["schemas"]["BasicStringFilterProperty"];
|
|
619
|
+
/** @description Filter by file type. */
|
|
620
|
+
type?: components["schemas"]["BasicStringFilterProperty"];
|
|
621
|
+
/** @description Filter by last update date. */
|
|
622
|
+
updated?: components["schemas"]["DateTimeFilterProperty"];
|
|
623
|
+
/** @description Filter by last updater email address. */
|
|
624
|
+
updatedBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
625
|
+
};
|
|
626
|
+
/**
|
|
627
|
+
* @example {
|
|
628
|
+
* "fileKey": "file-789-xyz",
|
|
629
|
+
* "name": "order-process.bpmn",
|
|
630
|
+
* "projectKey": "prj-def-456",
|
|
631
|
+
* "folderKey": "fld-012-ghi",
|
|
632
|
+
* "simplePath": "/processes/order-process.bpmn",
|
|
633
|
+
* "canonicalPath": "/fld-012-ghi/file-789-xyz",
|
|
634
|
+
* "revision": 3,
|
|
635
|
+
* "type": "bpmn",
|
|
636
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>...",
|
|
637
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
638
|
+
* "createdBy": {
|
|
639
|
+
* "name": "Jane Doe",
|
|
640
|
+
* "email": "jane.doe@example.com"
|
|
641
|
+
* },
|
|
642
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
643
|
+
* "updatedBy": {
|
|
644
|
+
* "name": "Jane Doe",
|
|
645
|
+
* "email": "jane.doe@example.com"
|
|
646
|
+
* }
|
|
647
|
+
* }
|
|
648
|
+
*/
|
|
649
|
+
FileResult: {
|
|
650
|
+
/** @description The canonical (ID-based) path of the file within its project. */
|
|
651
|
+
canonicalPath: string;
|
|
652
|
+
/** @description The content of the file. Present in single-file responses (get, create, update) but null in search results for performance reasons. */
|
|
653
|
+
content: string | null;
|
|
654
|
+
/**
|
|
655
|
+
* Format: date-time
|
|
656
|
+
* @description The timestamp when the file was created.
|
|
657
|
+
*/
|
|
658
|
+
created: string;
|
|
659
|
+
/** @description The user who created the file. */
|
|
660
|
+
createdBy: components["schemas"]["UserReference"];
|
|
661
|
+
/** @description The unique key identifying this file. */
|
|
662
|
+
fileKey: string;
|
|
663
|
+
/** @description The key of the parent folder. Null if the file is at project root. */
|
|
664
|
+
folderKey: string | null;
|
|
665
|
+
/** @description The name of the file. */
|
|
666
|
+
name: string;
|
|
667
|
+
/** @description The key of the project this file belongs to. */
|
|
668
|
+
projectKey: string;
|
|
669
|
+
/**
|
|
670
|
+
* Format: int32
|
|
671
|
+
* @description The current revision number, used for optimistic locking.
|
|
672
|
+
*/
|
|
673
|
+
revision: number;
|
|
674
|
+
/** @description The human-readable path of the file within its project. */
|
|
675
|
+
simplePath: string;
|
|
676
|
+
/**
|
|
677
|
+
* @description The type of the file.
|
|
678
|
+
* @enum {string}
|
|
679
|
+
*/
|
|
680
|
+
type: "bpmn" | "dmn" | "form" | "element-template" | "rpa" | "markdown" | "tests";
|
|
681
|
+
/**
|
|
682
|
+
* Format: date-time
|
|
683
|
+
* @description The timestamp when the file was last updated.
|
|
684
|
+
*/
|
|
685
|
+
updated: string;
|
|
686
|
+
/** @description The user who last updated the file. */
|
|
687
|
+
updatedBy: components["schemas"]["UserReference"];
|
|
688
|
+
};
|
|
689
|
+
FileSearchQuery: {
|
|
690
|
+
/** @description The file search filters. */
|
|
691
|
+
filter?: components["schemas"]["FileFilter"];
|
|
692
|
+
/** @description Pagination criteria. Supports offset-based pagination (from/limit) or a simple limit. */
|
|
693
|
+
page?: components["schemas"]["SearchQueryPage"];
|
|
694
|
+
/** @description Sort field criteria. */
|
|
695
|
+
sort?: components["schemas"]["FileSearchQuerySortRequest"][];
|
|
696
|
+
};
|
|
697
|
+
FileSearchQueryResult: {
|
|
698
|
+
/** @description The matching files. */
|
|
699
|
+
items: components["schemas"]["FileResult"][];
|
|
700
|
+
/** @description Pagination metadata for the search results. */
|
|
701
|
+
page: components["schemas"]["SearchQueryPageResponse"];
|
|
702
|
+
};
|
|
703
|
+
FileSearchQuerySortRequest: {
|
|
704
|
+
/**
|
|
705
|
+
* @description The field to sort by.
|
|
706
|
+
* @enum {string}
|
|
707
|
+
*/
|
|
708
|
+
field: "name" | "type" | "created" | "updated";
|
|
709
|
+
/** @description The sort direction. Defaults to ASC. */
|
|
710
|
+
order?: components["schemas"]["SortOrderEnum"];
|
|
711
|
+
};
|
|
712
|
+
/**
|
|
713
|
+
* @example {
|
|
714
|
+
* "name": "order-process-v2.bpmn",
|
|
715
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>...",
|
|
716
|
+
* "revision": 3
|
|
717
|
+
* }
|
|
718
|
+
*/
|
|
719
|
+
FileUpdateRequest: {
|
|
720
|
+
/** @description The updated content of the file. */
|
|
721
|
+
content?: string;
|
|
722
|
+
/** @description The updated parent folder key. Set to null to move to project root. */
|
|
723
|
+
folderKey?: string | null;
|
|
724
|
+
/** @description The updated name of the file. */
|
|
725
|
+
name?: string;
|
|
726
|
+
/** @description The project to move the file to. */
|
|
727
|
+
projectKey?: string;
|
|
728
|
+
/**
|
|
729
|
+
* Format: int32
|
|
730
|
+
* @description The current revision of the file for optimistic locking.
|
|
731
|
+
*/
|
|
732
|
+
revision: number;
|
|
733
|
+
};
|
|
734
|
+
/** @description The content of a folder, listing its direct children. */
|
|
735
|
+
FolderContent: {
|
|
736
|
+
/** @description The files within this folder. */
|
|
737
|
+
files: components["schemas"]["FileResult"][];
|
|
738
|
+
/** @description The child folders within this folder. */
|
|
739
|
+
folders: components["schemas"]["FolderResult"][];
|
|
740
|
+
};
|
|
741
|
+
/**
|
|
742
|
+
* @example {
|
|
743
|
+
* "name": "processes",
|
|
744
|
+
* "projectKey": "prj-def-456"
|
|
745
|
+
* }
|
|
746
|
+
*/
|
|
747
|
+
FolderCreateRequest: {
|
|
748
|
+
/** @description The name of the folder. */
|
|
749
|
+
name: string;
|
|
750
|
+
/** @description The key of the parent folder. If omitted or null, the folder is created at project root. */
|
|
751
|
+
parentFolderKey?: string | null;
|
|
752
|
+
/** @description The key of the project this folder belongs to. */
|
|
753
|
+
projectKey: string;
|
|
754
|
+
};
|
|
755
|
+
/**
|
|
756
|
+
* @description A folder with its metadata and content (child folders and files).
|
|
757
|
+
* @example {
|
|
758
|
+
* "folder": {
|
|
759
|
+
* "folderKey": "fld-012-ghi",
|
|
760
|
+
* "name": "processes",
|
|
761
|
+
* "projectKey": "prj-def-456",
|
|
762
|
+
* "parentFolderKey": "fld-parent-001",
|
|
763
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
764
|
+
* "createdBy": {
|
|
765
|
+
* "name": "Jane Doe",
|
|
766
|
+
* "email": "jane.doe@example.com"
|
|
767
|
+
* },
|
|
768
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
769
|
+
* "updatedBy": {
|
|
770
|
+
* "name": "Jane Doe",
|
|
771
|
+
* "email": "jane.doe@example.com"
|
|
772
|
+
* }
|
|
773
|
+
* },
|
|
774
|
+
* "content": {
|
|
775
|
+
* "folders": [
|
|
776
|
+
* {
|
|
777
|
+
* "folderKey": "fld-child-001",
|
|
778
|
+
* "name": "sub-processes",
|
|
779
|
+
* "projectKey": "prj-def-456",
|
|
780
|
+
* "parentFolderKey": "fld-012-ghi",
|
|
781
|
+
* "created": "2025-04-01T08:00:00.000Z",
|
|
782
|
+
* "createdBy": {
|
|
783
|
+
* "name": "Jane Doe",
|
|
784
|
+
* "email": "jane.doe@example.com"
|
|
785
|
+
* },
|
|
786
|
+
* "updated": "2025-04-01T08:00:00.000Z",
|
|
787
|
+
* "updatedBy": {
|
|
788
|
+
* "name": "Jane Doe",
|
|
789
|
+
* "email": "jane.doe@example.com"
|
|
790
|
+
* }
|
|
791
|
+
* }
|
|
792
|
+
* ],
|
|
793
|
+
* "files": [
|
|
794
|
+
* {
|
|
795
|
+
* "fileKey": "file-789-xyz",
|
|
796
|
+
* "name": "order-process.bpmn",
|
|
797
|
+
* "projectKey": "prj-def-456",
|
|
798
|
+
* "folderKey": "fld-012-ghi",
|
|
799
|
+
* "simplePath": "/processes/order-process.bpmn",
|
|
800
|
+
* "canonicalPath": "/fld-012-ghi/file-789-xyz",
|
|
801
|
+
* "revision": 3,
|
|
802
|
+
* "type": "bpmn",
|
|
803
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>...",
|
|
804
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
805
|
+
* "createdBy": {
|
|
806
|
+
* "name": "Jane Doe",
|
|
807
|
+
* "email": "jane.doe@example.com"
|
|
808
|
+
* },
|
|
809
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
810
|
+
* "updatedBy": {
|
|
811
|
+
* "name": "Jane Doe",
|
|
812
|
+
* "email": "jane.doe@example.com"
|
|
813
|
+
* }
|
|
814
|
+
* }
|
|
815
|
+
* ]
|
|
816
|
+
* }
|
|
817
|
+
* }
|
|
818
|
+
*/
|
|
819
|
+
FolderDetailResult: {
|
|
820
|
+
/** @description The content of the folder (child folders and files). */
|
|
821
|
+
content: components["schemas"]["FolderContent"];
|
|
822
|
+
/** @description The folder metadata. */
|
|
823
|
+
folder: components["schemas"]["FolderResult"];
|
|
824
|
+
};
|
|
825
|
+
/**
|
|
826
|
+
* @example {
|
|
827
|
+
* "folderKey": "fld-012-ghi",
|
|
828
|
+
* "name": "processes",
|
|
829
|
+
* "projectKey": "prj-def-456",
|
|
830
|
+
* "parentFolderKey": "fld-parent-001",
|
|
831
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
832
|
+
* "createdBy": {
|
|
833
|
+
* "name": "Jane Doe",
|
|
834
|
+
* "email": "jane.doe@example.com"
|
|
835
|
+
* },
|
|
836
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
837
|
+
* "updatedBy": {
|
|
838
|
+
* "name": "Jane Doe",
|
|
839
|
+
* "email": "jane.doe@example.com"
|
|
840
|
+
* }
|
|
841
|
+
* }
|
|
842
|
+
*/
|
|
843
|
+
FolderResult: {
|
|
844
|
+
/**
|
|
845
|
+
* Format: date-time
|
|
846
|
+
* @description The timestamp when the folder was created.
|
|
847
|
+
*/
|
|
848
|
+
created: string;
|
|
849
|
+
/** @description The user who created the folder. */
|
|
850
|
+
createdBy: components["schemas"]["UserReference"];
|
|
851
|
+
/** @description The unique key identifying this folder. */
|
|
852
|
+
folderKey: string;
|
|
853
|
+
/** @description The name of the folder. */
|
|
854
|
+
name: string;
|
|
855
|
+
/** @description The key of the parent folder. Null if the folder is at project root. */
|
|
856
|
+
parentFolderKey: string | null;
|
|
857
|
+
/** @description The key of the project this folder belongs to. */
|
|
858
|
+
projectKey: string;
|
|
859
|
+
/**
|
|
860
|
+
* Format: date-time
|
|
861
|
+
* @description The timestamp when the folder was last updated.
|
|
862
|
+
*/
|
|
863
|
+
updated: string;
|
|
864
|
+
/** @description The user who last updated the folder. */
|
|
865
|
+
updatedBy: components["schemas"]["UserReference"];
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* @example {
|
|
869
|
+
* "name": "archived-processes",
|
|
870
|
+
* "parentFolderKey": "fld-parent-999"
|
|
871
|
+
* }
|
|
872
|
+
*/
|
|
873
|
+
FolderUpdateRequest: {
|
|
874
|
+
/** @description The updated name of the folder. */
|
|
875
|
+
name?: string;
|
|
876
|
+
/** @description The updated parent folder key. Set to null to move to project root. Cannot be the same as the folder being updated. */
|
|
877
|
+
parentFolderKey?: string | null;
|
|
878
|
+
/** @description The project to move the folder to. */
|
|
879
|
+
projectKey?: string;
|
|
880
|
+
};
|
|
881
|
+
/**
|
|
882
|
+
* @example {
|
|
883
|
+
* "version": "v2",
|
|
884
|
+
* "authorizedOrganization": "org-mno-789"
|
|
885
|
+
* }
|
|
886
|
+
*/
|
|
887
|
+
InfoResult: {
|
|
888
|
+
/** @description The organization ID that the caller's credentials are authorized for. */
|
|
889
|
+
authorizedOrganization: string;
|
|
890
|
+
/** @description The API version. */
|
|
891
|
+
version: string;
|
|
892
|
+
};
|
|
893
|
+
/**
|
|
894
|
+
* @description Checks if the property matches the provided like value.
|
|
895
|
+
*
|
|
896
|
+
* Supported wildcard characters are:
|
|
897
|
+
*
|
|
898
|
+
* * `*`: matches zero, one, or multiple characters.
|
|
899
|
+
* * `?`: matches one, single character.
|
|
900
|
+
*
|
|
901
|
+
* Wildcard characters can be escaped with backslash, for instance: `\*`.
|
|
902
|
+
*/
|
|
903
|
+
LikeFilter: string;
|
|
904
|
+
/** Limit-based pagination */
|
|
905
|
+
LimitPagination: {
|
|
906
|
+
/**
|
|
907
|
+
* Format: int32
|
|
908
|
+
* @description The maximum number of items to return in one request.
|
|
909
|
+
* @default 100
|
|
910
|
+
*/
|
|
911
|
+
limit: number;
|
|
912
|
+
};
|
|
913
|
+
/**
|
|
914
|
+
* @example {
|
|
915
|
+
* "email": "alice@example.com",
|
|
916
|
+
* "role": "editor"
|
|
917
|
+
* }
|
|
918
|
+
*/
|
|
919
|
+
MemberCreateRequest: {
|
|
920
|
+
/**
|
|
921
|
+
* Format: email
|
|
922
|
+
* @description The email address of the member to add or update.
|
|
923
|
+
*/
|
|
924
|
+
email: string;
|
|
925
|
+
/** @description The role to assign to the member. */
|
|
926
|
+
role: components["schemas"]["MemberRole"];
|
|
927
|
+
};
|
|
928
|
+
/** @description Filter criteria for searching members. */
|
|
929
|
+
MemberFilter: {
|
|
930
|
+
/** @description Filter by member email address. */
|
|
931
|
+
email?: components["schemas"]["StringFilterProperty"];
|
|
932
|
+
/** @description Filter by member display name. */
|
|
933
|
+
name?: components["schemas"]["StringFilterProperty"];
|
|
934
|
+
/** @description Filter by member role. */
|
|
935
|
+
role?: components["schemas"]["BasicStringFilterProperty"];
|
|
936
|
+
/** @description Filter by workspace key. Only the `$eq` operator is supported — members cannot be searched across workspaces. */
|
|
937
|
+
workspaceKey: components["schemas"]["BasicStringFilterProperty"];
|
|
938
|
+
};
|
|
939
|
+
/**
|
|
940
|
+
* @example {
|
|
941
|
+
* "workspaceKey": "wks-abc-123",
|
|
942
|
+
* "email": "alice@example.com",
|
|
943
|
+
* "name": "Alice Smith",
|
|
944
|
+
* "role": "editor"
|
|
945
|
+
* }
|
|
946
|
+
*/
|
|
947
|
+
MemberResult: {
|
|
948
|
+
/**
|
|
949
|
+
* Format: email
|
|
950
|
+
* @description The email address of the member.
|
|
951
|
+
*/
|
|
952
|
+
email: string;
|
|
953
|
+
/** @description The display name of the member, if known. */
|
|
954
|
+
name: string;
|
|
955
|
+
/** @description The role of the member in the workspace. */
|
|
956
|
+
role: components["schemas"]["MemberRole"];
|
|
957
|
+
/** @description The unique key of the workspace the member belongs to. */
|
|
958
|
+
workspaceKey: string;
|
|
959
|
+
};
|
|
960
|
+
/**
|
|
961
|
+
* @description The role a member can have in a workspace.
|
|
962
|
+
* @enum {string}
|
|
963
|
+
*/
|
|
964
|
+
MemberRole: "workspace_admin" | "editor" | "commenter" | "viewer";
|
|
965
|
+
MemberSearchQuery: {
|
|
966
|
+
/** @description The member search filters. The workspaceKey filter is required. */
|
|
967
|
+
filter: components["schemas"]["MemberFilter"];
|
|
968
|
+
/** @description Pagination criteria. Supports offset-based pagination (from/limit) or a simple limit. */
|
|
969
|
+
page?: components["schemas"]["SearchQueryPage"];
|
|
970
|
+
/** @description Sort field criteria. */
|
|
971
|
+
sort?: components["schemas"]["MemberSearchQuerySortRequest"][];
|
|
972
|
+
};
|
|
973
|
+
MemberSearchQueryResult: {
|
|
974
|
+
/** @description The matching members. */
|
|
975
|
+
items: components["schemas"]["MemberResult"][];
|
|
976
|
+
/** @description Pagination metadata for the search results. */
|
|
977
|
+
page: components["schemas"]["SearchQueryPageResponse"];
|
|
978
|
+
};
|
|
979
|
+
MemberSearchQuerySortRequest: {
|
|
980
|
+
/**
|
|
981
|
+
* @description The field to sort by.
|
|
982
|
+
* @enum {string}
|
|
983
|
+
*/
|
|
984
|
+
field: "email" | "name" | "role";
|
|
985
|
+
/** @description The sort direction. Defaults to ASC. */
|
|
986
|
+
order?: components["schemas"]["SortOrderEnum"];
|
|
987
|
+
};
|
|
988
|
+
/** Offset-based pagination */
|
|
989
|
+
OffsetPagination: {
|
|
990
|
+
/**
|
|
991
|
+
* Format: int32
|
|
992
|
+
* @description The index of items to start searching from.
|
|
993
|
+
*/
|
|
994
|
+
from: number;
|
|
995
|
+
/**
|
|
996
|
+
* Format: int32
|
|
997
|
+
* @description The maximum number of items to return in one request.
|
|
998
|
+
* @default 100
|
|
999
|
+
*/
|
|
1000
|
+
limit: number;
|
|
1001
|
+
};
|
|
1002
|
+
/** @description A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type. */
|
|
1003
|
+
ProblemDetail: {
|
|
1004
|
+
/**
|
|
1005
|
+
* @description An explanation of the problem in more detail.
|
|
1006
|
+
* @example Request property [maxJobsToActivates] cannot be parsed
|
|
1007
|
+
*/
|
|
1008
|
+
detail: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Format: uri-reference
|
|
1011
|
+
* @description A URI path identifying the origin of the problem.
|
|
1012
|
+
* @example /v2/jobs/activation
|
|
1013
|
+
*/
|
|
1014
|
+
instance: string;
|
|
1015
|
+
/**
|
|
1016
|
+
* Format: int32
|
|
1017
|
+
* @description The HTTP status code for this problem.
|
|
1018
|
+
* @example 400
|
|
1019
|
+
*/
|
|
1020
|
+
status: number;
|
|
1021
|
+
/**
|
|
1022
|
+
* @description A summary of the problem type.
|
|
1023
|
+
* @example Bad Request
|
|
1024
|
+
*/
|
|
1025
|
+
title: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* Format: uri
|
|
1028
|
+
* @description A URI identifying the problem type.
|
|
1029
|
+
* @default about:blank
|
|
1030
|
+
* @example https://docs.camunda.io/api/v2.0/problem-types/bad-request
|
|
1031
|
+
*/
|
|
1032
|
+
type: string;
|
|
1033
|
+
};
|
|
1034
|
+
/** @description The content of a project, listing its direct children. */
|
|
1035
|
+
ProjectContent: {
|
|
1036
|
+
/** @description The files within this project. */
|
|
1037
|
+
files: components["schemas"]["FileResult"][];
|
|
1038
|
+
/** @description The child folders within this project. */
|
|
1039
|
+
folders: components["schemas"]["FolderResult"][];
|
|
1040
|
+
};
|
|
1041
|
+
/**
|
|
1042
|
+
* @example {
|
|
1043
|
+
* "name": "Payment Flow",
|
|
1044
|
+
* "workspaceKey": "wks-abc-123"
|
|
1045
|
+
* }
|
|
1046
|
+
*/
|
|
1047
|
+
ProjectCreateRequest: {
|
|
1048
|
+
/** @description The name of the project. */
|
|
1049
|
+
name: string;
|
|
1050
|
+
/** @description The key of the workspace this project belongs to. */
|
|
1051
|
+
workspaceKey: string;
|
|
1052
|
+
};
|
|
1053
|
+
/**
|
|
1054
|
+
* @description A project with its metadata and content (child folders and files).
|
|
1055
|
+
* @example {
|
|
1056
|
+
* "project": {
|
|
1057
|
+
* "projectKey": "prj-def-456",
|
|
1058
|
+
* "name": "Payment Flow",
|
|
1059
|
+
* "workspaceKey": "wks-abc-123",
|
|
1060
|
+
* "created": "2025-02-01T08:00:00.000Z",
|
|
1061
|
+
* "createdBy": {
|
|
1062
|
+
* "name": "Jane Doe",
|
|
1063
|
+
* "email": "jane.doe@example.com"
|
|
1064
|
+
* },
|
|
1065
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1066
|
+
* "updatedBy": {
|
|
1067
|
+
* "name": "Jane Doe",
|
|
1068
|
+
* "email": "jane.doe@example.com"
|
|
1069
|
+
* }
|
|
1070
|
+
* },
|
|
1071
|
+
* "content": {
|
|
1072
|
+
* "folders": [
|
|
1073
|
+
* {
|
|
1074
|
+
* "folderKey": "fld-012-ghi",
|
|
1075
|
+
* "name": "processes",
|
|
1076
|
+
* "projectKey": "prj-def-456",
|
|
1077
|
+
* "parentFolderKey": "fld-parent-001",
|
|
1078
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
1079
|
+
* "createdBy": {
|
|
1080
|
+
* "name": "Jane Doe",
|
|
1081
|
+
* "email": "jane.doe@example.com"
|
|
1082
|
+
* },
|
|
1083
|
+
* "updated": "2025-03-15T10:30:00.000Z",
|
|
1084
|
+
* "updatedBy": {
|
|
1085
|
+
* "name": "Jane Doe",
|
|
1086
|
+
* "email": "jane.doe@example.com"
|
|
1087
|
+
* }
|
|
1088
|
+
* }
|
|
1089
|
+
* ],
|
|
1090
|
+
* "files": [
|
|
1091
|
+
* {
|
|
1092
|
+
* "fileKey": "file-789-xyz",
|
|
1093
|
+
* "name": "order-process.bpmn",
|
|
1094
|
+
* "projectKey": "prj-def-456",
|
|
1095
|
+
* "folderKey": "fld-012-ghi",
|
|
1096
|
+
* "simplePath": "/processes/order-process.bpmn",
|
|
1097
|
+
* "canonicalPath": "/fld-012-ghi/file-789-xyz",
|
|
1098
|
+
* "revision": 1,
|
|
1099
|
+
* "type": "bpmn",
|
|
1100
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>...",
|
|
1101
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
1102
|
+
* "createdBy": {
|
|
1103
|
+
* "name": "Jane Doe",
|
|
1104
|
+
* "email": "jane.doe@example.com"
|
|
1105
|
+
* },
|
|
1106
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1107
|
+
* "updatedBy": {
|
|
1108
|
+
* "name": "Jane Doe",
|
|
1109
|
+
* "email": "jane.doe@example.com"
|
|
1110
|
+
* }
|
|
1111
|
+
* }
|
|
1112
|
+
* ]
|
|
1113
|
+
* }
|
|
1114
|
+
* }
|
|
1115
|
+
*/
|
|
1116
|
+
ProjectDetailResult: {
|
|
1117
|
+
/** @description The content of the project (child folders and files). */
|
|
1118
|
+
content: components["schemas"]["ProjectContent"];
|
|
1119
|
+
/** @description The project metadata. */
|
|
1120
|
+
project: components["schemas"]["ProjectResult"];
|
|
1121
|
+
};
|
|
1122
|
+
/** @description Filter criteria for searching projects. */
|
|
1123
|
+
ProjectFilter: {
|
|
1124
|
+
/** @description Filter by creation date. */
|
|
1125
|
+
created?: components["schemas"]["DateTimeFilterProperty"];
|
|
1126
|
+
/** @description Filter by creator email address. */
|
|
1127
|
+
createdBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
1128
|
+
/** @description Filter by project name. */
|
|
1129
|
+
name?: components["schemas"]["StringFilterProperty"];
|
|
1130
|
+
/** @description Filter by last update date. */
|
|
1131
|
+
updated?: components["schemas"]["DateTimeFilterProperty"];
|
|
1132
|
+
/** @description Filter by last updater email address. */
|
|
1133
|
+
updatedBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
1134
|
+
/** @description Filter by workspace key. */
|
|
1135
|
+
workspaceKey?: components["schemas"]["BasicStringFilterProperty"];
|
|
1136
|
+
};
|
|
1137
|
+
/**
|
|
1138
|
+
* @example {
|
|
1139
|
+
* "projectKey": "prj-def-456",
|
|
1140
|
+
* "name": "Payment Flow",
|
|
1141
|
+
* "workspaceKey": "wks-abc-123",
|
|
1142
|
+
* "created": "2025-02-01T08:00:00.000Z",
|
|
1143
|
+
* "createdBy": {
|
|
1144
|
+
* "name": "Jane Doe",
|
|
1145
|
+
* "email": "jane.doe@example.com"
|
|
1146
|
+
* },
|
|
1147
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1148
|
+
* "updatedBy": {
|
|
1149
|
+
* "name": "Jane Doe",
|
|
1150
|
+
* "email": "jane.doe@example.com"
|
|
1151
|
+
* }
|
|
1152
|
+
* }
|
|
1153
|
+
*/
|
|
1154
|
+
ProjectResult: {
|
|
1155
|
+
/**
|
|
1156
|
+
* Format: date-time
|
|
1157
|
+
* @description The timestamp when the project was created.
|
|
1158
|
+
*/
|
|
1159
|
+
created: string;
|
|
1160
|
+
/** @description The user who created the project. */
|
|
1161
|
+
createdBy: components["schemas"]["UserReference"];
|
|
1162
|
+
/** @description The name of the project. */
|
|
1163
|
+
name: string;
|
|
1164
|
+
/** @description The unique key identifying this project. */
|
|
1165
|
+
projectKey: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* Format: date-time
|
|
1168
|
+
* @description The timestamp when the project was last updated.
|
|
1169
|
+
*/
|
|
1170
|
+
updated: string;
|
|
1171
|
+
/** @description The user who last updated the project. */
|
|
1172
|
+
updatedBy: components["schemas"]["UserReference"];
|
|
1173
|
+
/** @description The key of the workspace this project belongs to. */
|
|
1174
|
+
workspaceKey: string;
|
|
1175
|
+
};
|
|
1176
|
+
ProjectSearchQuery: {
|
|
1177
|
+
/** @description The project search filters. */
|
|
1178
|
+
filter?: components["schemas"]["ProjectFilter"];
|
|
1179
|
+
/** @description Pagination criteria. Supports offset-based pagination (from/limit) or a simple limit. */
|
|
1180
|
+
page?: components["schemas"]["SearchQueryPage"];
|
|
1181
|
+
/** @description Sort field criteria. */
|
|
1182
|
+
sort?: components["schemas"]["ProjectSearchQuerySortRequest"][];
|
|
1183
|
+
};
|
|
1184
|
+
ProjectSearchQueryResult: {
|
|
1185
|
+
/** @description The matching projects. */
|
|
1186
|
+
items: components["schemas"]["ProjectResult"][];
|
|
1187
|
+
/** @description Pagination metadata for the search results. */
|
|
1188
|
+
page: components["schemas"]["SearchQueryPageResponse"];
|
|
1189
|
+
};
|
|
1190
|
+
ProjectSearchQuerySortRequest: {
|
|
1191
|
+
/**
|
|
1192
|
+
* @description The field to sort by.
|
|
1193
|
+
* @enum {string}
|
|
1194
|
+
*/
|
|
1195
|
+
field: "name" | "created" | "updated";
|
|
1196
|
+
/** @description The sort direction. Defaults to ASC. */
|
|
1197
|
+
order?: components["schemas"]["SortOrderEnum"];
|
|
1198
|
+
};
|
|
1199
|
+
/**
|
|
1200
|
+
* @example {
|
|
1201
|
+
* "name": "Payment Flow v2"
|
|
1202
|
+
* }
|
|
1203
|
+
*/
|
|
1204
|
+
ProjectUpdateRequest: {
|
|
1205
|
+
/** @description The updated name of the project. */
|
|
1206
|
+
name?: string;
|
|
1207
|
+
/** @description The key of the workspace to move the project to. */
|
|
1208
|
+
workspaceKey?: string;
|
|
1209
|
+
};
|
|
1210
|
+
SearchQueryPage: components["schemas"]["LimitPagination"] | components["schemas"]["OffsetPagination"];
|
|
1211
|
+
/** @description Pagination information about the search results. */
|
|
1212
|
+
SearchQueryPageResponse: {
|
|
1213
|
+
/** @description The cursor value for getting the next page of results. Use this in the `after` field of an ensuing request. */
|
|
1214
|
+
endCursor: components["schemas"]["EndCursor"] | null;
|
|
1215
|
+
/**
|
|
1216
|
+
* @description Indicates whether the `totalItems` value has been capped due to system limits.
|
|
1217
|
+
* When true, `totalItems` is a lower bound and the actual number of matching
|
|
1218
|
+
* items is greater than the reported value.
|
|
1219
|
+
*/
|
|
1220
|
+
hasMoreTotalItems: boolean;
|
|
1221
|
+
/** @description The cursor value for getting the previous page of results. Use this in the `before` field of an ensuing request. */
|
|
1222
|
+
startCursor: components["schemas"]["StartCursor"] | null;
|
|
1223
|
+
/**
|
|
1224
|
+
* Format: int64
|
|
1225
|
+
* @description Total items matching the criteria.
|
|
1226
|
+
*/
|
|
1227
|
+
totalItems: number;
|
|
1228
|
+
};
|
|
1229
|
+
/**
|
|
1230
|
+
* @description The order in which to sort the related field.
|
|
1231
|
+
* @default ASC
|
|
1232
|
+
* @enum {string}
|
|
1233
|
+
*/
|
|
1234
|
+
SortOrderEnum: "ASC" | "DESC";
|
|
1235
|
+
/**
|
|
1236
|
+
* Format: base64
|
|
1237
|
+
* @description The start cursor in a search query result set.
|
|
1238
|
+
* @example WzIyNTE3OTk4MTM2ODcxMDJd
|
|
1239
|
+
*/
|
|
1240
|
+
StartCursor: string;
|
|
1241
|
+
/** @description String property with full advanced search capabilities. */
|
|
1242
|
+
StringFilterProperty: string | components["schemas"]["AdvancedStringFilter"];
|
|
1243
|
+
/** @description A reference to a user. */
|
|
1244
|
+
UserReference: {
|
|
1245
|
+
/**
|
|
1246
|
+
* Format: email
|
|
1247
|
+
* @description The email address of the user.
|
|
1248
|
+
*/
|
|
1249
|
+
email: string;
|
|
1250
|
+
/** @description The display name of the user. */
|
|
1251
|
+
name: string;
|
|
1252
|
+
};
|
|
1253
|
+
/**
|
|
1254
|
+
* @example {
|
|
1255
|
+
* "fileKey": "file-789-xyz",
|
|
1256
|
+
* "name": "Release 1.0",
|
|
1257
|
+
* "description": "First stable release of the order process.",
|
|
1258
|
+
* "organizationPublic": false
|
|
1259
|
+
* }
|
|
1260
|
+
*/
|
|
1261
|
+
VersionCreateRequest: {
|
|
1262
|
+
/** @description An optional description for the version. */
|
|
1263
|
+
description?: string;
|
|
1264
|
+
/** @description The key of the file to create a version for. */
|
|
1265
|
+
fileKey: string;
|
|
1266
|
+
/** @description The name for the version. */
|
|
1267
|
+
name: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* @description Whether the version is published to shared resources (visible organization-wide). Only applicable to element template files. Defaults to false.
|
|
1270
|
+
* @default false
|
|
1271
|
+
*/
|
|
1272
|
+
organizationPublic: boolean;
|
|
1273
|
+
};
|
|
1274
|
+
/**
|
|
1275
|
+
* @description A version with its full metadata and file content.
|
|
1276
|
+
* @example {
|
|
1277
|
+
* "versionKey": "ver-345-jkl",
|
|
1278
|
+
* "name": "Release 1.0",
|
|
1279
|
+
* "description": "First stable release of the order process.",
|
|
1280
|
+
* "fileKey": "file-789-xyz",
|
|
1281
|
+
* "organizationPublic": false,
|
|
1282
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
1283
|
+
* "createdBy": {
|
|
1284
|
+
* "name": "Jane Doe",
|
|
1285
|
+
* "email": "jane.doe@example.com"
|
|
1286
|
+
* },
|
|
1287
|
+
* "updated": "2025-03-15T10:30:00.000Z",
|
|
1288
|
+
* "updatedBy": {
|
|
1289
|
+
* "name": "Jane Doe",
|
|
1290
|
+
* "email": "jane.doe@example.com"
|
|
1291
|
+
* },
|
|
1292
|
+
* "content": "<?xml version='1.0' encoding='UTF-8'?>..."
|
|
1293
|
+
* }
|
|
1294
|
+
*/
|
|
1295
|
+
VersionDetailResult: {
|
|
1296
|
+
/** @description The file content at this version. */
|
|
1297
|
+
content: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* Format: date-time
|
|
1300
|
+
* @description The timestamp when the version was created.
|
|
1301
|
+
*/
|
|
1302
|
+
created: string;
|
|
1303
|
+
/** @description The user who created the version. May be null for legacy or system-created versions. */
|
|
1304
|
+
createdBy: components["schemas"]["UserReference"] | null;
|
|
1305
|
+
/** @description The description of the version. */
|
|
1306
|
+
description: string | null;
|
|
1307
|
+
/** @description The key of the file this version belongs to. */
|
|
1308
|
+
fileKey: string;
|
|
1309
|
+
/** @description The name of the version. */
|
|
1310
|
+
name: string;
|
|
1311
|
+
/** @description Whether the version is published to shared resources. */
|
|
1312
|
+
organizationPublic: boolean;
|
|
1313
|
+
/**
|
|
1314
|
+
* Format: date-time
|
|
1315
|
+
* @description The timestamp when the version was last updated.
|
|
1316
|
+
*/
|
|
1317
|
+
updated: string;
|
|
1318
|
+
/** @description The user who last updated the version. May be null for legacy or system-created versions. */
|
|
1319
|
+
updatedBy: components["schemas"]["UserReference"] | null;
|
|
1320
|
+
/** @description The unique key of the version. */
|
|
1321
|
+
versionKey: string;
|
|
1322
|
+
};
|
|
1323
|
+
/** @description Filter criteria for searching versions. */
|
|
1324
|
+
VersionFilter: {
|
|
1325
|
+
/** @description Filter by creation date. */
|
|
1326
|
+
created?: components["schemas"]["DateTimeFilterProperty"];
|
|
1327
|
+
/** @description Filter by creator email address. */
|
|
1328
|
+
createdBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
1329
|
+
/** @description Filter by file key. This is a required filter — versions cannot be searched across files. */
|
|
1330
|
+
fileKey: components["schemas"]["StringFilterProperty"];
|
|
1331
|
+
/** @description Filter by version name. */
|
|
1332
|
+
name?: components["schemas"]["StringFilterProperty"];
|
|
1333
|
+
};
|
|
1334
|
+
VersionRestorationRequest: {
|
|
1335
|
+
/**
|
|
1336
|
+
* Format: int64
|
|
1337
|
+
* @description The target version number to set in the restored file content. Required when restoring an element template file. Ignored for other file types.
|
|
1338
|
+
*/
|
|
1339
|
+
version?: number;
|
|
1340
|
+
};
|
|
1341
|
+
/**
|
|
1342
|
+
* @example {
|
|
1343
|
+
* "versionKey": "ver-345-jkl",
|
|
1344
|
+
* "name": "Release 1.0",
|
|
1345
|
+
* "description": "First stable release of the order process.",
|
|
1346
|
+
* "fileKey": "file-789-xyz",
|
|
1347
|
+
* "organizationPublic": false,
|
|
1348
|
+
* "created": "2025-03-15T10:30:00.000Z",
|
|
1349
|
+
* "createdBy": {
|
|
1350
|
+
* "name": "Jane Doe",
|
|
1351
|
+
* "email": "jane.doe@example.com"
|
|
1352
|
+
* },
|
|
1353
|
+
* "updated": "2025-03-15T10:30:00.000Z",
|
|
1354
|
+
* "updatedBy": {
|
|
1355
|
+
* "name": "Jane Doe",
|
|
1356
|
+
* "email": "jane.doe@example.com"
|
|
1357
|
+
* }
|
|
1358
|
+
* }
|
|
1359
|
+
*/
|
|
1360
|
+
VersionResult: {
|
|
1361
|
+
/**
|
|
1362
|
+
* Format: date-time
|
|
1363
|
+
* @description The timestamp when the version was created.
|
|
1364
|
+
*/
|
|
1365
|
+
created: string;
|
|
1366
|
+
/** @description The user who created the version. May be null for legacy or system-created versions. */
|
|
1367
|
+
createdBy: components["schemas"]["UserReference"] | null;
|
|
1368
|
+
/** @description The description of the version. */
|
|
1369
|
+
description: string | null;
|
|
1370
|
+
/** @description The key of the file this version belongs to. */
|
|
1371
|
+
fileKey: string;
|
|
1372
|
+
/** @description The name of the version. */
|
|
1373
|
+
name: string;
|
|
1374
|
+
/** @description Whether the version is published to shared resources. */
|
|
1375
|
+
organizationPublic: boolean;
|
|
1376
|
+
/**
|
|
1377
|
+
* Format: date-time
|
|
1378
|
+
* @description The timestamp when the version was last updated.
|
|
1379
|
+
*/
|
|
1380
|
+
updated: string;
|
|
1381
|
+
/** @description The user who last updated the version. May be null for legacy or system-created versions. */
|
|
1382
|
+
updatedBy: components["schemas"]["UserReference"] | null;
|
|
1383
|
+
/** @description The unique key of the version. */
|
|
1384
|
+
versionKey: string;
|
|
1385
|
+
};
|
|
1386
|
+
VersionSearchQuery: {
|
|
1387
|
+
/** @description The version search filters. The fileKey filter is required. */
|
|
1388
|
+
filter: components["schemas"]["VersionFilter"];
|
|
1389
|
+
/** @description Pagination criteria. Supports offset-based pagination (from/limit) or a simple limit. */
|
|
1390
|
+
page?: components["schemas"]["SearchQueryPage"];
|
|
1391
|
+
/** @description Sort field criteria. */
|
|
1392
|
+
sort?: components["schemas"]["VersionSearchQuerySortRequest"][];
|
|
1393
|
+
};
|
|
1394
|
+
VersionSearchQueryResult: {
|
|
1395
|
+
/** @description The matching versions. */
|
|
1396
|
+
items: components["schemas"]["VersionResult"][];
|
|
1397
|
+
/** @description Pagination metadata for the search results. */
|
|
1398
|
+
page: components["schemas"]["SearchQueryPageResponse"];
|
|
1399
|
+
};
|
|
1400
|
+
VersionSearchQuerySortRequest: {
|
|
1401
|
+
/**
|
|
1402
|
+
* @description The field to sort by.
|
|
1403
|
+
* @enum {string}
|
|
1404
|
+
*/
|
|
1405
|
+
field: "name" | "created";
|
|
1406
|
+
/** @description The sort direction. Defaults to ASC. */
|
|
1407
|
+
order?: components["schemas"]["SortOrderEnum"];
|
|
1408
|
+
};
|
|
1409
|
+
/**
|
|
1410
|
+
* @example {
|
|
1411
|
+
* "name": "Release 1.1",
|
|
1412
|
+
* "description": "Updated with error-handling improvements."
|
|
1413
|
+
* }
|
|
1414
|
+
*/
|
|
1415
|
+
VersionUpdateRequest: {
|
|
1416
|
+
/** @description An optional description for the version. */
|
|
1417
|
+
description?: string | null;
|
|
1418
|
+
/** @description The new name for the version. */
|
|
1419
|
+
name: string;
|
|
1420
|
+
/** @description Whether the version is published to shared resources (visible organization-wide). Only applicable to element template files. */
|
|
1421
|
+
organizationPublic?: boolean;
|
|
1422
|
+
};
|
|
1423
|
+
WorkspaceContent: {
|
|
1424
|
+
/** @description The projects contained in this workspace. */
|
|
1425
|
+
projects: components["schemas"]["ProjectResult"][];
|
|
1426
|
+
};
|
|
1427
|
+
/**
|
|
1428
|
+
* @example {
|
|
1429
|
+
* "name": "My Workspace"
|
|
1430
|
+
* }
|
|
1431
|
+
*/
|
|
1432
|
+
WorkspaceCreateRequest: {
|
|
1433
|
+
/** @description The name of the workspace. */
|
|
1434
|
+
name: string;
|
|
1435
|
+
};
|
|
1436
|
+
/**
|
|
1437
|
+
* @description A workspace with its metadata and content (projects).
|
|
1438
|
+
* @example {
|
|
1439
|
+
* "workspace": {
|
|
1440
|
+
* "workspaceKey": "wks-abc-123",
|
|
1441
|
+
* "name": "My Workspace",
|
|
1442
|
+
* "created": "2025-01-20T09:00:00.000Z",
|
|
1443
|
+
* "createdBy": {
|
|
1444
|
+
* "name": "Jane Doe",
|
|
1445
|
+
* "email": "jane.doe@example.com"
|
|
1446
|
+
* },
|
|
1447
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1448
|
+
* "updatedBy": {
|
|
1449
|
+
* "name": "Jane Doe",
|
|
1450
|
+
* "email": "jane.doe@example.com"
|
|
1451
|
+
* }
|
|
1452
|
+
* },
|
|
1453
|
+
* "content": {
|
|
1454
|
+
* "projects": [
|
|
1455
|
+
* {
|
|
1456
|
+
* "projectKey": "prj-def-456",
|
|
1457
|
+
* "name": "Payment Flow",
|
|
1458
|
+
* "workspaceKey": "wks-abc-123",
|
|
1459
|
+
* "created": "2025-02-01T08:00:00.000Z",
|
|
1460
|
+
* "createdBy": {
|
|
1461
|
+
* "name": "Jane Doe",
|
|
1462
|
+
* "email": "jane.doe@example.com"
|
|
1463
|
+
* },
|
|
1464
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1465
|
+
* "updatedBy": {
|
|
1466
|
+
* "name": "Jane Doe",
|
|
1467
|
+
* "email": "jane.doe@example.com"
|
|
1468
|
+
* }
|
|
1469
|
+
* }
|
|
1470
|
+
* ]
|
|
1471
|
+
* }
|
|
1472
|
+
* }
|
|
1473
|
+
*/
|
|
1474
|
+
WorkspaceDetailResult: {
|
|
1475
|
+
/** @description The contents of the workspace. */
|
|
1476
|
+
content: components["schemas"]["WorkspaceContent"];
|
|
1477
|
+
/** @description The workspace metadata. */
|
|
1478
|
+
workspace: components["schemas"]["WorkspaceResult"];
|
|
1479
|
+
};
|
|
1480
|
+
/** @description Filter criteria for searching workspaces. */
|
|
1481
|
+
WorkspaceFilter: {
|
|
1482
|
+
/** @description Filter by creation date. */
|
|
1483
|
+
created?: components["schemas"]["DateTimeFilterProperty"];
|
|
1484
|
+
/** @description Filter by creator email address. */
|
|
1485
|
+
createdBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
1486
|
+
/** @description Filter by workspace name. */
|
|
1487
|
+
name?: components["schemas"]["StringFilterProperty"];
|
|
1488
|
+
/** @description Filter by last update date. */
|
|
1489
|
+
updated?: components["schemas"]["DateTimeFilterProperty"];
|
|
1490
|
+
/** @description Filter by last updater email address. */
|
|
1491
|
+
updatedBy?: components["schemas"]["BasicStringFilterProperty"];
|
|
1492
|
+
};
|
|
1493
|
+
/**
|
|
1494
|
+
* @example {
|
|
1495
|
+
* "workspaceKey": "wks-abc-123",
|
|
1496
|
+
* "name": "My Workspace",
|
|
1497
|
+
* "created": "2025-01-20T09:00:00.000Z",
|
|
1498
|
+
* "createdBy": {
|
|
1499
|
+
* "name": "Jane Doe",
|
|
1500
|
+
* "email": "jane.doe@example.com"
|
|
1501
|
+
* },
|
|
1502
|
+
* "updated": "2025-06-10T14:22:00.000Z",
|
|
1503
|
+
* "updatedBy": {
|
|
1504
|
+
* "name": "Jane Doe",
|
|
1505
|
+
* "email": "jane.doe@example.com"
|
|
1506
|
+
* }
|
|
1507
|
+
* }
|
|
1508
|
+
*/
|
|
1509
|
+
WorkspaceResult: {
|
|
1510
|
+
/**
|
|
1511
|
+
* Format: date-time
|
|
1512
|
+
* @description The timestamp when the workspace was created.
|
|
1513
|
+
*/
|
|
1514
|
+
created: string;
|
|
1515
|
+
/** @description The user who created the workspace. */
|
|
1516
|
+
createdBy: components["schemas"]["UserReference"];
|
|
1517
|
+
/** @description The name of the workspace. */
|
|
1518
|
+
name: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* Format: date-time
|
|
1521
|
+
* @description The timestamp when the workspace was last updated.
|
|
1522
|
+
*/
|
|
1523
|
+
updated: string;
|
|
1524
|
+
/** @description The user who last updated the workspace. */
|
|
1525
|
+
updatedBy: components["schemas"]["UserReference"];
|
|
1526
|
+
/** @description The unique key identifying this workspace. */
|
|
1527
|
+
workspaceKey: string;
|
|
1528
|
+
};
|
|
1529
|
+
WorkspaceSearchQuery: {
|
|
1530
|
+
/** @description The workspace search filters. */
|
|
1531
|
+
filter?: components["schemas"]["WorkspaceFilter"];
|
|
1532
|
+
/** @description Pagination criteria. Supports offset-based pagination (from/limit) or a simple limit. */
|
|
1533
|
+
page?: components["schemas"]["SearchQueryPage"];
|
|
1534
|
+
/** @description Sort field criteria. */
|
|
1535
|
+
sort?: components["schemas"]["WorkspaceSearchQuerySortRequest"][];
|
|
1536
|
+
};
|
|
1537
|
+
WorkspaceSearchQueryResult: {
|
|
1538
|
+
/** @description The matching workspaces. */
|
|
1539
|
+
items: components["schemas"]["WorkspaceResult"][];
|
|
1540
|
+
/** @description Pagination metadata for the search results. */
|
|
1541
|
+
page: components["schemas"]["SearchQueryPageResponse"];
|
|
1542
|
+
};
|
|
1543
|
+
WorkspaceSearchQuerySortRequest: {
|
|
1544
|
+
/**
|
|
1545
|
+
* @description The field to sort by.
|
|
1546
|
+
* @enum {string}
|
|
1547
|
+
*/
|
|
1548
|
+
field: "name" | "created" | "updated";
|
|
1549
|
+
/** @description The sort direction. Defaults to ASC. */
|
|
1550
|
+
order?: components["schemas"]["SortOrderEnum"];
|
|
1551
|
+
};
|
|
1552
|
+
/**
|
|
1553
|
+
* @example {
|
|
1554
|
+
* "name": "Renamed Workspace"
|
|
1555
|
+
* }
|
|
1556
|
+
*/
|
|
1557
|
+
WorkspaceUpdateRequest: {
|
|
1558
|
+
/** @description The updated name of the workspace. */
|
|
1559
|
+
name?: string;
|
|
1560
|
+
};
|
|
1561
|
+
};
|
|
1562
|
+
responses: {
|
|
1563
|
+
/** @description A conflict occurred while processing the request. */
|
|
1564
|
+
Conflict: {
|
|
1565
|
+
headers: {
|
|
1566
|
+
[name: string]: unknown;
|
|
1567
|
+
};
|
|
1568
|
+
content: {
|
|
1569
|
+
/**
|
|
1570
|
+
* @example {
|
|
1571
|
+
* "type": "about:blank",
|
|
1572
|
+
* "title": "Conflict",
|
|
1573
|
+
* "status": 409,
|
|
1574
|
+
* "detail": "The request conflicts with the current state of the resource.",
|
|
1575
|
+
* "instance": "/api/v2/files/file-789-xyz"
|
|
1576
|
+
* }
|
|
1577
|
+
*/
|
|
1578
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1579
|
+
};
|
|
1580
|
+
};
|
|
1581
|
+
/** @description Forbidden. The request is not allowed. */
|
|
1582
|
+
Forbidden: {
|
|
1583
|
+
headers: {
|
|
1584
|
+
[name: string]: unknown;
|
|
1585
|
+
};
|
|
1586
|
+
content: {
|
|
1587
|
+
/**
|
|
1588
|
+
* @example {
|
|
1589
|
+
* "type": "about:blank",
|
|
1590
|
+
* "title": "Forbidden",
|
|
1591
|
+
* "status": 403,
|
|
1592
|
+
* "detail": "Operation not allowed. Ensure your API credentials have the required permissions.",
|
|
1593
|
+
* "instance": "/api/v2/files/file-789-xyz"
|
|
1594
|
+
* }
|
|
1595
|
+
*/
|
|
1596
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
/** @description An internal error occurred while processing the request. */
|
|
1600
|
+
InternalServerError: {
|
|
1601
|
+
headers: {
|
|
1602
|
+
[name: string]: unknown;
|
|
1603
|
+
};
|
|
1604
|
+
content: {
|
|
1605
|
+
/**
|
|
1606
|
+
* @example {
|
|
1607
|
+
* "type": "about:blank",
|
|
1608
|
+
* "title": "Internal Server Error",
|
|
1609
|
+
* "status": 500,
|
|
1610
|
+
* "detail": "An unexpected error occurred while processing your request. Please try again later.",
|
|
1611
|
+
* "instance": "/api/v2/files"
|
|
1612
|
+
* }
|
|
1613
|
+
*/
|
|
1614
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
/** @description The provided data is not valid. */
|
|
1618
|
+
InvalidData: {
|
|
1619
|
+
headers: {
|
|
1620
|
+
[name: string]: unknown;
|
|
1621
|
+
};
|
|
1622
|
+
content: {
|
|
1623
|
+
/**
|
|
1624
|
+
* @example {
|
|
1625
|
+
* "type": "about:blank",
|
|
1626
|
+
* "title": "Bad Request",
|
|
1627
|
+
* "status": 400,
|
|
1628
|
+
* "detail": "Validation failed for request body: 'name' must not be blank.",
|
|
1629
|
+
* "instance": "/api/v2/files"
|
|
1630
|
+
* }
|
|
1631
|
+
*/
|
|
1632
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
/** @description The requested resource was not found. */
|
|
1636
|
+
NotFound: {
|
|
1637
|
+
headers: {
|
|
1638
|
+
[name: string]: unknown;
|
|
1639
|
+
};
|
|
1640
|
+
content: {
|
|
1641
|
+
/**
|
|
1642
|
+
* @example {
|
|
1643
|
+
* "type": "about:blank",
|
|
1644
|
+
* "title": "Not Found",
|
|
1645
|
+
* "status": 404,
|
|
1646
|
+
* "detail": "The requested resource was not found.",
|
|
1647
|
+
* "instance": "/api/v2/files/file-789-xyz"
|
|
1648
|
+
* }
|
|
1649
|
+
*/
|
|
1650
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1651
|
+
};
|
|
1652
|
+
};
|
|
1653
|
+
/** @description The request lacks valid authentication credentials. */
|
|
1654
|
+
Unauthorized: {
|
|
1655
|
+
headers: {
|
|
1656
|
+
"WWW-Authenticate"?: string;
|
|
1657
|
+
[name: string]: unknown;
|
|
1658
|
+
};
|
|
1659
|
+
content: {
|
|
1660
|
+
/**
|
|
1661
|
+
* @example {
|
|
1662
|
+
* "type": "about:blank",
|
|
1663
|
+
* "title": "Unauthorized",
|
|
1664
|
+
* "status": 401,
|
|
1665
|
+
* "detail": "The supplied authentication is not authorized to access this resource.",
|
|
1666
|
+
* "instance": "/api/v2/files"
|
|
1667
|
+
* }
|
|
1668
|
+
*/
|
|
1669
|
+
"application/problem+json": components["schemas"]["ProblemDetail"];
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
parameters: {
|
|
1674
|
+
/** @description The unique key identifying the catalog asset. */
|
|
1675
|
+
AssetKeyPathParam: string;
|
|
1676
|
+
/** @description The unique key identifying the file. */
|
|
1677
|
+
FileKeyPathParam: string;
|
|
1678
|
+
/** @description The unique key identifying the folder. */
|
|
1679
|
+
FolderKeyPathParam: string;
|
|
1680
|
+
/** @description The email address of the member. */
|
|
1681
|
+
MemberEmailPathParam: string;
|
|
1682
|
+
/** @description The unique key identifying the project. */
|
|
1683
|
+
ProjectKeyPathParam: string;
|
|
1684
|
+
/** @description The unique key of the version. */
|
|
1685
|
+
VersionKeyPathParam: string;
|
|
1686
|
+
/** @description The unique key identifying the workspace. */
|
|
1687
|
+
WorkspaceKeyPathParam: string;
|
|
1688
|
+
};
|
|
1689
|
+
requestBodies: never;
|
|
1690
|
+
headers: never;
|
|
1691
|
+
pathItems: never;
|
|
1692
|
+
}
|
|
1693
|
+
export type $defs = Record<string, never>;
|
|
1694
|
+
export interface operations {
|
|
1695
|
+
deleteCatalogAsset: {
|
|
1696
|
+
parameters: {
|
|
1697
|
+
query?: never;
|
|
1698
|
+
header?: never;
|
|
1699
|
+
path: {
|
|
1700
|
+
/** @description The unique key identifying the catalog asset. */
|
|
1701
|
+
assetKey: components["parameters"]["AssetKeyPathParam"];
|
|
1702
|
+
};
|
|
1703
|
+
cookie?: never;
|
|
1704
|
+
};
|
|
1705
|
+
requestBody?: never;
|
|
1706
|
+
responses: {
|
|
1707
|
+
/** @description The catalog asset was deleted successfully. */
|
|
1708
|
+
204: {
|
|
1709
|
+
headers: {
|
|
1710
|
+
[name: string]: unknown;
|
|
1711
|
+
};
|
|
1712
|
+
content?: never;
|
|
1713
|
+
};
|
|
1714
|
+
401: components["responses"]["Unauthorized"];
|
|
1715
|
+
403: components["responses"]["Forbidden"];
|
|
1716
|
+
404: components["responses"]["NotFound"];
|
|
1717
|
+
500: components["responses"]["InternalServerError"];
|
|
1718
|
+
};
|
|
1719
|
+
};
|
|
1720
|
+
ingestCatalogAssets: {
|
|
1721
|
+
parameters: {
|
|
1722
|
+
query?: never;
|
|
1723
|
+
header?: never;
|
|
1724
|
+
path?: never;
|
|
1725
|
+
cookie?: never;
|
|
1726
|
+
};
|
|
1727
|
+
requestBody: {
|
|
1728
|
+
content: {
|
|
1729
|
+
"multipart/form-data": components["schemas"]["CatalogAssetIngestionRequest"];
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
responses: {
|
|
1733
|
+
/** @description The catalog assets were ingested successfully. */
|
|
1734
|
+
204: {
|
|
1735
|
+
headers: {
|
|
1736
|
+
[name: string]: unknown;
|
|
1737
|
+
};
|
|
1738
|
+
content?: never;
|
|
1739
|
+
};
|
|
1740
|
+
400: components["responses"]["InvalidData"];
|
|
1741
|
+
401: components["responses"]["Unauthorized"];
|
|
1742
|
+
403: components["responses"]["Forbidden"];
|
|
1743
|
+
500: components["responses"]["InternalServerError"];
|
|
1744
|
+
};
|
|
1745
|
+
};
|
|
1746
|
+
createFile: {
|
|
1747
|
+
parameters: {
|
|
1748
|
+
query?: never;
|
|
1749
|
+
header?: never;
|
|
1750
|
+
path?: never;
|
|
1751
|
+
cookie?: never;
|
|
1752
|
+
};
|
|
1753
|
+
requestBody: {
|
|
1754
|
+
content: {
|
|
1755
|
+
"application/json": components["schemas"]["FileCreateRequest"];
|
|
1756
|
+
};
|
|
1757
|
+
};
|
|
1758
|
+
responses: {
|
|
1759
|
+
/** @description The file was created successfully. */
|
|
1760
|
+
200: {
|
|
1761
|
+
headers: {
|
|
1762
|
+
[name: string]: unknown;
|
|
1763
|
+
};
|
|
1764
|
+
content: {
|
|
1765
|
+
"application/json": components["schemas"]["FileResult"];
|
|
1766
|
+
};
|
|
1767
|
+
};
|
|
1768
|
+
400: components["responses"]["InvalidData"];
|
|
1769
|
+
401: components["responses"]["Unauthorized"];
|
|
1770
|
+
403: components["responses"]["Forbidden"];
|
|
1771
|
+
500: components["responses"]["InternalServerError"];
|
|
1772
|
+
};
|
|
1773
|
+
};
|
|
1774
|
+
getFile: {
|
|
1775
|
+
parameters: {
|
|
1776
|
+
query?: never;
|
|
1777
|
+
header?: never;
|
|
1778
|
+
path: {
|
|
1779
|
+
/** @description The unique key identifying the file. */
|
|
1780
|
+
fileKey: components["parameters"]["FileKeyPathParam"];
|
|
1781
|
+
};
|
|
1782
|
+
cookie?: never;
|
|
1783
|
+
};
|
|
1784
|
+
requestBody?: never;
|
|
1785
|
+
responses: {
|
|
1786
|
+
/** @description The file was retrieved successfully. */
|
|
1787
|
+
200: {
|
|
1788
|
+
headers: {
|
|
1789
|
+
[name: string]: unknown;
|
|
1790
|
+
};
|
|
1791
|
+
content: {
|
|
1792
|
+
"application/json": components["schemas"]["FileResult"];
|
|
1793
|
+
};
|
|
1794
|
+
};
|
|
1795
|
+
401: components["responses"]["Unauthorized"];
|
|
1796
|
+
403: components["responses"]["Forbidden"];
|
|
1797
|
+
404: components["responses"]["NotFound"];
|
|
1798
|
+
500: components["responses"]["InternalServerError"];
|
|
1799
|
+
};
|
|
1800
|
+
};
|
|
1801
|
+
deleteFile: {
|
|
1802
|
+
parameters: {
|
|
1803
|
+
query?: never;
|
|
1804
|
+
header?: never;
|
|
1805
|
+
path: {
|
|
1806
|
+
/** @description The unique key identifying the file. */
|
|
1807
|
+
fileKey: components["parameters"]["FileKeyPathParam"];
|
|
1808
|
+
};
|
|
1809
|
+
cookie?: never;
|
|
1810
|
+
};
|
|
1811
|
+
requestBody?: never;
|
|
1812
|
+
responses: {
|
|
1813
|
+
/** @description The file was deleted successfully. */
|
|
1814
|
+
204: {
|
|
1815
|
+
headers: {
|
|
1816
|
+
[name: string]: unknown;
|
|
1817
|
+
};
|
|
1818
|
+
content?: never;
|
|
1819
|
+
};
|
|
1820
|
+
401: components["responses"]["Unauthorized"];
|
|
1821
|
+
403: components["responses"]["Forbidden"];
|
|
1822
|
+
404: components["responses"]["NotFound"];
|
|
1823
|
+
500: components["responses"]["InternalServerError"];
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1826
|
+
updateFile: {
|
|
1827
|
+
parameters: {
|
|
1828
|
+
query?: never;
|
|
1829
|
+
header?: never;
|
|
1830
|
+
path: {
|
|
1831
|
+
/** @description The unique key identifying the file. */
|
|
1832
|
+
fileKey: components["parameters"]["FileKeyPathParam"];
|
|
1833
|
+
};
|
|
1834
|
+
cookie?: never;
|
|
1835
|
+
};
|
|
1836
|
+
requestBody: {
|
|
1837
|
+
content: {
|
|
1838
|
+
"application/json": components["schemas"]["FileUpdateRequest"];
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
responses: {
|
|
1842
|
+
/** @description The file was updated successfully. */
|
|
1843
|
+
200: {
|
|
1844
|
+
headers: {
|
|
1845
|
+
[name: string]: unknown;
|
|
1846
|
+
};
|
|
1847
|
+
content: {
|
|
1848
|
+
"application/json": components["schemas"]["FileResult"];
|
|
1849
|
+
};
|
|
1850
|
+
};
|
|
1851
|
+
400: components["responses"]["InvalidData"];
|
|
1852
|
+
401: components["responses"]["Unauthorized"];
|
|
1853
|
+
403: components["responses"]["Forbidden"];
|
|
1854
|
+
404: components["responses"]["NotFound"];
|
|
1855
|
+
409: components["responses"]["Conflict"];
|
|
1856
|
+
500: components["responses"]["InternalServerError"];
|
|
1857
|
+
};
|
|
1858
|
+
};
|
|
1859
|
+
searchFiles: {
|
|
1860
|
+
parameters: {
|
|
1861
|
+
query?: never;
|
|
1862
|
+
header?: never;
|
|
1863
|
+
path?: never;
|
|
1864
|
+
cookie?: never;
|
|
1865
|
+
};
|
|
1866
|
+
requestBody?: {
|
|
1867
|
+
content: {
|
|
1868
|
+
"application/json": components["schemas"]["FileSearchQuery"];
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
responses: {
|
|
1872
|
+
/** @description The search completed successfully. */
|
|
1873
|
+
200: {
|
|
1874
|
+
headers: {
|
|
1875
|
+
[name: string]: unknown;
|
|
1876
|
+
};
|
|
1877
|
+
content: {
|
|
1878
|
+
"application/json": components["schemas"]["FileSearchQueryResult"];
|
|
1879
|
+
};
|
|
1880
|
+
};
|
|
1881
|
+
400: components["responses"]["InvalidData"];
|
|
1882
|
+
401: components["responses"]["Unauthorized"];
|
|
1883
|
+
403: components["responses"]["Forbidden"];
|
|
1884
|
+
500: components["responses"]["InternalServerError"];
|
|
1885
|
+
};
|
|
1886
|
+
};
|
|
1887
|
+
createFolder: {
|
|
1888
|
+
parameters: {
|
|
1889
|
+
query?: never;
|
|
1890
|
+
header?: never;
|
|
1891
|
+
path?: never;
|
|
1892
|
+
cookie?: never;
|
|
1893
|
+
};
|
|
1894
|
+
requestBody: {
|
|
1895
|
+
content: {
|
|
1896
|
+
"application/json": components["schemas"]["FolderCreateRequest"];
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
responses: {
|
|
1900
|
+
/** @description The folder was created successfully. */
|
|
1901
|
+
200: {
|
|
1902
|
+
headers: {
|
|
1903
|
+
[name: string]: unknown;
|
|
1904
|
+
};
|
|
1905
|
+
content: {
|
|
1906
|
+
"application/json": components["schemas"]["FolderResult"];
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
400: components["responses"]["InvalidData"];
|
|
1910
|
+
401: components["responses"]["Unauthorized"];
|
|
1911
|
+
403: components["responses"]["Forbidden"];
|
|
1912
|
+
500: components["responses"]["InternalServerError"];
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
getFolder: {
|
|
1916
|
+
parameters: {
|
|
1917
|
+
query?: never;
|
|
1918
|
+
header?: never;
|
|
1919
|
+
path: {
|
|
1920
|
+
/** @description The unique key identifying the folder. */
|
|
1921
|
+
folderKey: components["parameters"]["FolderKeyPathParam"];
|
|
1922
|
+
};
|
|
1923
|
+
cookie?: never;
|
|
1924
|
+
};
|
|
1925
|
+
requestBody?: never;
|
|
1926
|
+
responses: {
|
|
1927
|
+
/** @description The folder was retrieved successfully. */
|
|
1928
|
+
200: {
|
|
1929
|
+
headers: {
|
|
1930
|
+
[name: string]: unknown;
|
|
1931
|
+
};
|
|
1932
|
+
content: {
|
|
1933
|
+
"application/json": components["schemas"]["FolderDetailResult"];
|
|
1934
|
+
};
|
|
1935
|
+
};
|
|
1936
|
+
401: components["responses"]["Unauthorized"];
|
|
1937
|
+
403: components["responses"]["Forbidden"];
|
|
1938
|
+
404: components["responses"]["NotFound"];
|
|
1939
|
+
500: components["responses"]["InternalServerError"];
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
deleteFolder: {
|
|
1943
|
+
parameters: {
|
|
1944
|
+
query?: never;
|
|
1945
|
+
header?: never;
|
|
1946
|
+
path: {
|
|
1947
|
+
/** @description The unique key identifying the folder. */
|
|
1948
|
+
folderKey: components["parameters"]["FolderKeyPathParam"];
|
|
1949
|
+
};
|
|
1950
|
+
cookie?: never;
|
|
1951
|
+
};
|
|
1952
|
+
requestBody?: never;
|
|
1953
|
+
responses: {
|
|
1954
|
+
/** @description The folder was deleted successfully. */
|
|
1955
|
+
204: {
|
|
1956
|
+
headers: {
|
|
1957
|
+
[name: string]: unknown;
|
|
1958
|
+
};
|
|
1959
|
+
content?: never;
|
|
1960
|
+
};
|
|
1961
|
+
400: components["responses"]["InvalidData"];
|
|
1962
|
+
401: components["responses"]["Unauthorized"];
|
|
1963
|
+
403: components["responses"]["Forbidden"];
|
|
1964
|
+
404: components["responses"]["NotFound"];
|
|
1965
|
+
500: components["responses"]["InternalServerError"];
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
updateFolder: {
|
|
1969
|
+
parameters: {
|
|
1970
|
+
query?: never;
|
|
1971
|
+
header?: never;
|
|
1972
|
+
path: {
|
|
1973
|
+
/** @description The unique key identifying the folder. */
|
|
1974
|
+
folderKey: components["parameters"]["FolderKeyPathParam"];
|
|
1975
|
+
};
|
|
1976
|
+
cookie?: never;
|
|
1977
|
+
};
|
|
1978
|
+
requestBody: {
|
|
1979
|
+
content: {
|
|
1980
|
+
"application/json": components["schemas"]["FolderUpdateRequest"];
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
responses: {
|
|
1984
|
+
/** @description The folder was updated successfully. */
|
|
1985
|
+
200: {
|
|
1986
|
+
headers: {
|
|
1987
|
+
[name: string]: unknown;
|
|
1988
|
+
};
|
|
1989
|
+
content: {
|
|
1990
|
+
"application/json": components["schemas"]["FolderResult"];
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1993
|
+
400: components["responses"]["InvalidData"];
|
|
1994
|
+
401: components["responses"]["Unauthorized"];
|
|
1995
|
+
403: components["responses"]["Forbidden"];
|
|
1996
|
+
404: components["responses"]["NotFound"];
|
|
1997
|
+
500: components["responses"]["InternalServerError"];
|
|
1998
|
+
};
|
|
1999
|
+
};
|
|
2000
|
+
getInfo: {
|
|
2001
|
+
parameters: {
|
|
2002
|
+
query?: never;
|
|
2003
|
+
header?: never;
|
|
2004
|
+
path?: never;
|
|
2005
|
+
cookie?: never;
|
|
2006
|
+
};
|
|
2007
|
+
requestBody?: never;
|
|
2008
|
+
responses: {
|
|
2009
|
+
/** @description The API info was retrieved successfully. */
|
|
2010
|
+
200: {
|
|
2011
|
+
headers: {
|
|
2012
|
+
[name: string]: unknown;
|
|
2013
|
+
};
|
|
2014
|
+
content: {
|
|
2015
|
+
"application/json": components["schemas"]["InfoResult"];
|
|
2016
|
+
};
|
|
2017
|
+
};
|
|
2018
|
+
401: components["responses"]["Unauthorized"];
|
|
2019
|
+
403: components["responses"]["Forbidden"];
|
|
2020
|
+
500: components["responses"]["InternalServerError"];
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
2023
|
+
searchMembers: {
|
|
2024
|
+
parameters: {
|
|
2025
|
+
query?: never;
|
|
2026
|
+
header?: never;
|
|
2027
|
+
path?: never;
|
|
2028
|
+
cookie?: never;
|
|
2029
|
+
};
|
|
2030
|
+
requestBody: {
|
|
2031
|
+
content: {
|
|
2032
|
+
"application/json": components["schemas"]["MemberSearchQuery"];
|
|
2033
|
+
};
|
|
2034
|
+
};
|
|
2035
|
+
responses: {
|
|
2036
|
+
/** @description The search completed successfully. */
|
|
2037
|
+
200: {
|
|
2038
|
+
headers: {
|
|
2039
|
+
[name: string]: unknown;
|
|
2040
|
+
};
|
|
2041
|
+
content: {
|
|
2042
|
+
"application/json": components["schemas"]["MemberSearchQueryResult"];
|
|
2043
|
+
};
|
|
2044
|
+
};
|
|
2045
|
+
400: components["responses"]["InvalidData"];
|
|
2046
|
+
401: components["responses"]["Unauthorized"];
|
|
2047
|
+
403: components["responses"]["Forbidden"];
|
|
2048
|
+
500: components["responses"]["InternalServerError"];
|
|
2049
|
+
};
|
|
2050
|
+
};
|
|
2051
|
+
createProject: {
|
|
2052
|
+
parameters: {
|
|
2053
|
+
query?: never;
|
|
2054
|
+
header?: never;
|
|
2055
|
+
path?: never;
|
|
2056
|
+
cookie?: never;
|
|
2057
|
+
};
|
|
2058
|
+
requestBody: {
|
|
2059
|
+
content: {
|
|
2060
|
+
"application/json": components["schemas"]["ProjectCreateRequest"];
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
responses: {
|
|
2064
|
+
/** @description The project was created successfully. */
|
|
2065
|
+
200: {
|
|
2066
|
+
headers: {
|
|
2067
|
+
[name: string]: unknown;
|
|
2068
|
+
};
|
|
2069
|
+
content: {
|
|
2070
|
+
"application/json": components["schemas"]["ProjectResult"];
|
|
2071
|
+
};
|
|
2072
|
+
};
|
|
2073
|
+
400: components["responses"]["InvalidData"];
|
|
2074
|
+
401: components["responses"]["Unauthorized"];
|
|
2075
|
+
403: components["responses"]["Forbidden"];
|
|
2076
|
+
500: components["responses"]["InternalServerError"];
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
getProject: {
|
|
2080
|
+
parameters: {
|
|
2081
|
+
query?: never;
|
|
2082
|
+
header?: never;
|
|
2083
|
+
path: {
|
|
2084
|
+
/** @description The unique key identifying the project. */
|
|
2085
|
+
projectKey: components["parameters"]["ProjectKeyPathParam"];
|
|
2086
|
+
};
|
|
2087
|
+
cookie?: never;
|
|
2088
|
+
};
|
|
2089
|
+
requestBody?: never;
|
|
2090
|
+
responses: {
|
|
2091
|
+
/** @description The project was retrieved successfully. */
|
|
2092
|
+
200: {
|
|
2093
|
+
headers: {
|
|
2094
|
+
[name: string]: unknown;
|
|
2095
|
+
};
|
|
2096
|
+
content: {
|
|
2097
|
+
"application/json": components["schemas"]["ProjectDetailResult"];
|
|
2098
|
+
};
|
|
2099
|
+
};
|
|
2100
|
+
401: components["responses"]["Unauthorized"];
|
|
2101
|
+
403: components["responses"]["Forbidden"];
|
|
2102
|
+
404: components["responses"]["NotFound"];
|
|
2103
|
+
500: components["responses"]["InternalServerError"];
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
deleteProject: {
|
|
2107
|
+
parameters: {
|
|
2108
|
+
query?: never;
|
|
2109
|
+
header?: never;
|
|
2110
|
+
path: {
|
|
2111
|
+
/** @description The unique key identifying the project. */
|
|
2112
|
+
projectKey: components["parameters"]["ProjectKeyPathParam"];
|
|
2113
|
+
};
|
|
2114
|
+
cookie?: never;
|
|
2115
|
+
};
|
|
2116
|
+
requestBody?: never;
|
|
2117
|
+
responses: {
|
|
2118
|
+
/** @description The project was deleted successfully. */
|
|
2119
|
+
204: {
|
|
2120
|
+
headers: {
|
|
2121
|
+
[name: string]: unknown;
|
|
2122
|
+
};
|
|
2123
|
+
content?: never;
|
|
2124
|
+
};
|
|
2125
|
+
400: components["responses"]["InvalidData"];
|
|
2126
|
+
401: components["responses"]["Unauthorized"];
|
|
2127
|
+
403: components["responses"]["Forbidden"];
|
|
2128
|
+
404: components["responses"]["NotFound"];
|
|
2129
|
+
500: components["responses"]["InternalServerError"];
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
updateProject: {
|
|
2133
|
+
parameters: {
|
|
2134
|
+
query?: never;
|
|
2135
|
+
header?: never;
|
|
2136
|
+
path: {
|
|
2137
|
+
/** @description The unique key identifying the project. */
|
|
2138
|
+
projectKey: components["parameters"]["ProjectKeyPathParam"];
|
|
2139
|
+
};
|
|
2140
|
+
cookie?: never;
|
|
2141
|
+
};
|
|
2142
|
+
requestBody: {
|
|
2143
|
+
content: {
|
|
2144
|
+
"application/json": components["schemas"]["ProjectUpdateRequest"];
|
|
2145
|
+
};
|
|
2146
|
+
};
|
|
2147
|
+
responses: {
|
|
2148
|
+
/** @description The project was updated successfully. */
|
|
2149
|
+
200: {
|
|
2150
|
+
headers: {
|
|
2151
|
+
[name: string]: unknown;
|
|
2152
|
+
};
|
|
2153
|
+
content: {
|
|
2154
|
+
"application/json": components["schemas"]["ProjectResult"];
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
400: components["responses"]["InvalidData"];
|
|
2158
|
+
401: components["responses"]["Unauthorized"];
|
|
2159
|
+
403: components["responses"]["Forbidden"];
|
|
2160
|
+
404: components["responses"]["NotFound"];
|
|
2161
|
+
500: components["responses"]["InternalServerError"];
|
|
2162
|
+
};
|
|
2163
|
+
};
|
|
2164
|
+
searchProjects: {
|
|
2165
|
+
parameters: {
|
|
2166
|
+
query?: never;
|
|
2167
|
+
header?: never;
|
|
2168
|
+
path?: never;
|
|
2169
|
+
cookie?: never;
|
|
2170
|
+
};
|
|
2171
|
+
requestBody?: {
|
|
2172
|
+
content: {
|
|
2173
|
+
"application/json": components["schemas"]["ProjectSearchQuery"];
|
|
2174
|
+
};
|
|
2175
|
+
};
|
|
2176
|
+
responses: {
|
|
2177
|
+
/** @description The search completed successfully. */
|
|
2178
|
+
200: {
|
|
2179
|
+
headers: {
|
|
2180
|
+
[name: string]: unknown;
|
|
2181
|
+
};
|
|
2182
|
+
content: {
|
|
2183
|
+
"application/json": components["schemas"]["ProjectSearchQueryResult"];
|
|
2184
|
+
};
|
|
2185
|
+
};
|
|
2186
|
+
400: components["responses"]["InvalidData"];
|
|
2187
|
+
401: components["responses"]["Unauthorized"];
|
|
2188
|
+
403: components["responses"]["Forbidden"];
|
|
2189
|
+
500: components["responses"]["InternalServerError"];
|
|
2190
|
+
};
|
|
2191
|
+
};
|
|
2192
|
+
createVersion: {
|
|
2193
|
+
parameters: {
|
|
2194
|
+
query?: never;
|
|
2195
|
+
header?: never;
|
|
2196
|
+
path?: never;
|
|
2197
|
+
cookie?: never;
|
|
2198
|
+
};
|
|
2199
|
+
requestBody: {
|
|
2200
|
+
content: {
|
|
2201
|
+
"application/json": components["schemas"]["VersionCreateRequest"];
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
responses: {
|
|
2205
|
+
/** @description The version was created successfully. */
|
|
2206
|
+
200: {
|
|
2207
|
+
headers: {
|
|
2208
|
+
[name: string]: unknown;
|
|
2209
|
+
};
|
|
2210
|
+
content: {
|
|
2211
|
+
"application/json": components["schemas"]["VersionResult"];
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
400: components["responses"]["InvalidData"];
|
|
2215
|
+
401: components["responses"]["Unauthorized"];
|
|
2216
|
+
403: components["responses"]["Forbidden"];
|
|
2217
|
+
409: components["responses"]["Conflict"];
|
|
2218
|
+
500: components["responses"]["InternalServerError"];
|
|
2219
|
+
};
|
|
2220
|
+
};
|
|
2221
|
+
getVersion: {
|
|
2222
|
+
parameters: {
|
|
2223
|
+
query?: never;
|
|
2224
|
+
header?: never;
|
|
2225
|
+
path: {
|
|
2226
|
+
/** @description The unique key of the version. */
|
|
2227
|
+
versionKey: components["parameters"]["VersionKeyPathParam"];
|
|
2228
|
+
};
|
|
2229
|
+
cookie?: never;
|
|
2230
|
+
};
|
|
2231
|
+
requestBody?: never;
|
|
2232
|
+
responses: {
|
|
2233
|
+
/** @description The version was found. */
|
|
2234
|
+
200: {
|
|
2235
|
+
headers: {
|
|
2236
|
+
[name: string]: unknown;
|
|
2237
|
+
};
|
|
2238
|
+
content: {
|
|
2239
|
+
"application/json": components["schemas"]["VersionDetailResult"];
|
|
2240
|
+
};
|
|
2241
|
+
};
|
|
2242
|
+
401: components["responses"]["Unauthorized"];
|
|
2243
|
+
403: components["responses"]["Forbidden"];
|
|
2244
|
+
404: components["responses"]["NotFound"];
|
|
2245
|
+
500: components["responses"]["InternalServerError"];
|
|
2246
|
+
};
|
|
2247
|
+
};
|
|
2248
|
+
deleteVersion: {
|
|
2249
|
+
parameters: {
|
|
2250
|
+
query?: never;
|
|
2251
|
+
header?: never;
|
|
2252
|
+
path: {
|
|
2253
|
+
/** @description The unique key of the version. */
|
|
2254
|
+
versionKey: components["parameters"]["VersionKeyPathParam"];
|
|
2255
|
+
};
|
|
2256
|
+
cookie?: never;
|
|
2257
|
+
};
|
|
2258
|
+
requestBody?: never;
|
|
2259
|
+
responses: {
|
|
2260
|
+
/** @description The version was deleted successfully. */
|
|
2261
|
+
204: {
|
|
2262
|
+
headers: {
|
|
2263
|
+
[name: string]: unknown;
|
|
2264
|
+
};
|
|
2265
|
+
content?: never;
|
|
2266
|
+
};
|
|
2267
|
+
401: components["responses"]["Unauthorized"];
|
|
2268
|
+
403: components["responses"]["Forbidden"];
|
|
2269
|
+
404: components["responses"]["NotFound"];
|
|
2270
|
+
500: components["responses"]["InternalServerError"];
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
updateVersion: {
|
|
2274
|
+
parameters: {
|
|
2275
|
+
query?: never;
|
|
2276
|
+
header?: never;
|
|
2277
|
+
path: {
|
|
2278
|
+
/** @description The unique key of the version. */
|
|
2279
|
+
versionKey: components["parameters"]["VersionKeyPathParam"];
|
|
2280
|
+
};
|
|
2281
|
+
cookie?: never;
|
|
2282
|
+
};
|
|
2283
|
+
requestBody: {
|
|
2284
|
+
content: {
|
|
2285
|
+
"application/json": components["schemas"]["VersionUpdateRequest"];
|
|
2286
|
+
};
|
|
2287
|
+
};
|
|
2288
|
+
responses: {
|
|
2289
|
+
/** @description The version was updated successfully. */
|
|
2290
|
+
200: {
|
|
2291
|
+
headers: {
|
|
2292
|
+
[name: string]: unknown;
|
|
2293
|
+
};
|
|
2294
|
+
content: {
|
|
2295
|
+
"application/json": components["schemas"]["VersionResult"];
|
|
2296
|
+
};
|
|
2297
|
+
};
|
|
2298
|
+
400: components["responses"]["InvalidData"];
|
|
2299
|
+
401: components["responses"]["Unauthorized"];
|
|
2300
|
+
403: components["responses"]["Forbidden"];
|
|
2301
|
+
404: components["responses"]["NotFound"];
|
|
2302
|
+
409: components["responses"]["Conflict"];
|
|
2303
|
+
500: components["responses"]["InternalServerError"];
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
restoreVersion: {
|
|
2307
|
+
parameters: {
|
|
2308
|
+
query?: never;
|
|
2309
|
+
header?: never;
|
|
2310
|
+
path: {
|
|
2311
|
+
/** @description The unique key of the version. */
|
|
2312
|
+
versionKey: components["parameters"]["VersionKeyPathParam"];
|
|
2313
|
+
};
|
|
2314
|
+
cookie?: never;
|
|
2315
|
+
};
|
|
2316
|
+
requestBody?: {
|
|
2317
|
+
content: {
|
|
2318
|
+
"application/json": components["schemas"]["VersionRestorationRequest"];
|
|
2319
|
+
};
|
|
2320
|
+
};
|
|
2321
|
+
responses: {
|
|
2322
|
+
/** @description The version was restored successfully. Returns the newly created version. */
|
|
2323
|
+
200: {
|
|
2324
|
+
headers: {
|
|
2325
|
+
[name: string]: unknown;
|
|
2326
|
+
};
|
|
2327
|
+
content: {
|
|
2328
|
+
"application/json": components["schemas"]["VersionResult"];
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
400: components["responses"]["InvalidData"];
|
|
2332
|
+
401: components["responses"]["Unauthorized"];
|
|
2333
|
+
403: components["responses"]["Forbidden"];
|
|
2334
|
+
404: components["responses"]["NotFound"];
|
|
2335
|
+
409: components["responses"]["Conflict"];
|
|
2336
|
+
500: components["responses"]["InternalServerError"];
|
|
2337
|
+
};
|
|
2338
|
+
};
|
|
2339
|
+
searchVersions: {
|
|
2340
|
+
parameters: {
|
|
2341
|
+
query?: never;
|
|
2342
|
+
header?: never;
|
|
2343
|
+
path?: never;
|
|
2344
|
+
cookie?: never;
|
|
2345
|
+
};
|
|
2346
|
+
requestBody: {
|
|
2347
|
+
content: {
|
|
2348
|
+
"application/json": components["schemas"]["VersionSearchQuery"];
|
|
2349
|
+
};
|
|
2350
|
+
};
|
|
2351
|
+
responses: {
|
|
2352
|
+
/** @description The search completed successfully. */
|
|
2353
|
+
200: {
|
|
2354
|
+
headers: {
|
|
2355
|
+
[name: string]: unknown;
|
|
2356
|
+
};
|
|
2357
|
+
content: {
|
|
2358
|
+
"application/json": components["schemas"]["VersionSearchQueryResult"];
|
|
2359
|
+
};
|
|
2360
|
+
};
|
|
2361
|
+
400: components["responses"]["InvalidData"];
|
|
2362
|
+
401: components["responses"]["Unauthorized"];
|
|
2363
|
+
403: components["responses"]["Forbidden"];
|
|
2364
|
+
500: components["responses"]["InternalServerError"];
|
|
2365
|
+
};
|
|
2366
|
+
};
|
|
2367
|
+
createWorkspace: {
|
|
2368
|
+
parameters: {
|
|
2369
|
+
query?: never;
|
|
2370
|
+
header?: never;
|
|
2371
|
+
path?: never;
|
|
2372
|
+
cookie?: never;
|
|
2373
|
+
};
|
|
2374
|
+
requestBody: {
|
|
2375
|
+
content: {
|
|
2376
|
+
"application/json": components["schemas"]["WorkspaceCreateRequest"];
|
|
2377
|
+
};
|
|
2378
|
+
};
|
|
2379
|
+
responses: {
|
|
2380
|
+
/** @description The workspace was created successfully. */
|
|
2381
|
+
200: {
|
|
2382
|
+
headers: {
|
|
2383
|
+
[name: string]: unknown;
|
|
2384
|
+
};
|
|
2385
|
+
content: {
|
|
2386
|
+
"application/json": components["schemas"]["WorkspaceResult"];
|
|
2387
|
+
};
|
|
2388
|
+
};
|
|
2389
|
+
400: components["responses"]["InvalidData"];
|
|
2390
|
+
401: components["responses"]["Unauthorized"];
|
|
2391
|
+
403: components["responses"]["Forbidden"];
|
|
2392
|
+
500: components["responses"]["InternalServerError"];
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
getWorkspace: {
|
|
2396
|
+
parameters: {
|
|
2397
|
+
query?: never;
|
|
2398
|
+
header?: never;
|
|
2399
|
+
path: {
|
|
2400
|
+
/** @description The unique key identifying the workspace. */
|
|
2401
|
+
workspaceKey: components["parameters"]["WorkspaceKeyPathParam"];
|
|
2402
|
+
};
|
|
2403
|
+
cookie?: never;
|
|
2404
|
+
};
|
|
2405
|
+
requestBody?: never;
|
|
2406
|
+
responses: {
|
|
2407
|
+
/** @description The workspace was retrieved successfully. */
|
|
2408
|
+
200: {
|
|
2409
|
+
headers: {
|
|
2410
|
+
[name: string]: unknown;
|
|
2411
|
+
};
|
|
2412
|
+
content: {
|
|
2413
|
+
"application/json": components["schemas"]["WorkspaceDetailResult"];
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
401: components["responses"]["Unauthorized"];
|
|
2417
|
+
403: components["responses"]["Forbidden"];
|
|
2418
|
+
404: components["responses"]["NotFound"];
|
|
2419
|
+
500: components["responses"]["InternalServerError"];
|
|
2420
|
+
};
|
|
2421
|
+
};
|
|
2422
|
+
deleteWorkspace: {
|
|
2423
|
+
parameters: {
|
|
2424
|
+
query?: never;
|
|
2425
|
+
header?: never;
|
|
2426
|
+
path: {
|
|
2427
|
+
/** @description The unique key identifying the workspace. */
|
|
2428
|
+
workspaceKey: components["parameters"]["WorkspaceKeyPathParam"];
|
|
2429
|
+
};
|
|
2430
|
+
cookie?: never;
|
|
2431
|
+
};
|
|
2432
|
+
requestBody?: never;
|
|
2433
|
+
responses: {
|
|
2434
|
+
/** @description The workspace was deleted successfully. */
|
|
2435
|
+
204: {
|
|
2436
|
+
headers: {
|
|
2437
|
+
[name: string]: unknown;
|
|
2438
|
+
};
|
|
2439
|
+
content?: never;
|
|
2440
|
+
};
|
|
2441
|
+
400: components["responses"]["InvalidData"];
|
|
2442
|
+
401: components["responses"]["Unauthorized"];
|
|
2443
|
+
403: components["responses"]["Forbidden"];
|
|
2444
|
+
404: components["responses"]["NotFound"];
|
|
2445
|
+
500: components["responses"]["InternalServerError"];
|
|
2446
|
+
};
|
|
2447
|
+
};
|
|
2448
|
+
updateWorkspace: {
|
|
2449
|
+
parameters: {
|
|
2450
|
+
query?: never;
|
|
2451
|
+
header?: never;
|
|
2452
|
+
path: {
|
|
2453
|
+
/** @description The unique key identifying the workspace. */
|
|
2454
|
+
workspaceKey: components["parameters"]["WorkspaceKeyPathParam"];
|
|
2455
|
+
};
|
|
2456
|
+
cookie?: never;
|
|
2457
|
+
};
|
|
2458
|
+
requestBody: {
|
|
2459
|
+
content: {
|
|
2460
|
+
"application/json": components["schemas"]["WorkspaceUpdateRequest"];
|
|
2461
|
+
};
|
|
2462
|
+
};
|
|
2463
|
+
responses: {
|
|
2464
|
+
/** @description The workspace was updated successfully. */
|
|
2465
|
+
200: {
|
|
2466
|
+
headers: {
|
|
2467
|
+
[name: string]: unknown;
|
|
2468
|
+
};
|
|
2469
|
+
content: {
|
|
2470
|
+
"application/json": components["schemas"]["WorkspaceResult"];
|
|
2471
|
+
};
|
|
2472
|
+
};
|
|
2473
|
+
400: components["responses"]["InvalidData"];
|
|
2474
|
+
401: components["responses"]["Unauthorized"];
|
|
2475
|
+
403: components["responses"]["Forbidden"];
|
|
2476
|
+
404: components["responses"]["NotFound"];
|
|
2477
|
+
500: components["responses"]["InternalServerError"];
|
|
2478
|
+
};
|
|
2479
|
+
};
|
|
2480
|
+
addMember: {
|
|
2481
|
+
parameters: {
|
|
2482
|
+
query?: never;
|
|
2483
|
+
header?: never;
|
|
2484
|
+
path: {
|
|
2485
|
+
/** @description The unique key identifying the workspace. */
|
|
2486
|
+
workspaceKey: components["parameters"]["WorkspaceKeyPathParam"];
|
|
2487
|
+
};
|
|
2488
|
+
cookie?: never;
|
|
2489
|
+
};
|
|
2490
|
+
requestBody: {
|
|
2491
|
+
content: {
|
|
2492
|
+
"application/json": components["schemas"]["MemberCreateRequest"];
|
|
2493
|
+
};
|
|
2494
|
+
};
|
|
2495
|
+
responses: {
|
|
2496
|
+
/** @description The member was added or updated successfully. */
|
|
2497
|
+
200: {
|
|
2498
|
+
headers: {
|
|
2499
|
+
[name: string]: unknown;
|
|
2500
|
+
};
|
|
2501
|
+
content: {
|
|
2502
|
+
"application/json": components["schemas"]["MemberResult"];
|
|
2503
|
+
};
|
|
2504
|
+
};
|
|
2505
|
+
400: components["responses"]["InvalidData"];
|
|
2506
|
+
401: components["responses"]["Unauthorized"];
|
|
2507
|
+
403: components["responses"]["Forbidden"];
|
|
2508
|
+
404: components["responses"]["NotFound"];
|
|
2509
|
+
500: components["responses"]["InternalServerError"];
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
removeMember: {
|
|
2513
|
+
parameters: {
|
|
2514
|
+
query?: never;
|
|
2515
|
+
header?: never;
|
|
2516
|
+
path: {
|
|
2517
|
+
/** @description The email address of the member. */
|
|
2518
|
+
email: components["parameters"]["MemberEmailPathParam"];
|
|
2519
|
+
/** @description The unique key identifying the workspace. */
|
|
2520
|
+
workspaceKey: components["parameters"]["WorkspaceKeyPathParam"];
|
|
2521
|
+
};
|
|
2522
|
+
cookie?: never;
|
|
2523
|
+
};
|
|
2524
|
+
requestBody?: never;
|
|
2525
|
+
responses: {
|
|
2526
|
+
/** @description The member was removed successfully. */
|
|
2527
|
+
204: {
|
|
2528
|
+
headers: {
|
|
2529
|
+
[name: string]: unknown;
|
|
2530
|
+
};
|
|
2531
|
+
content?: never;
|
|
2532
|
+
};
|
|
2533
|
+
401: components["responses"]["Unauthorized"];
|
|
2534
|
+
403: components["responses"]["Forbidden"];
|
|
2535
|
+
404: components["responses"]["NotFound"];
|
|
2536
|
+
500: components["responses"]["InternalServerError"];
|
|
2537
|
+
};
|
|
2538
|
+
};
|
|
2539
|
+
searchWorkspaces: {
|
|
2540
|
+
parameters: {
|
|
2541
|
+
query?: never;
|
|
2542
|
+
header?: never;
|
|
2543
|
+
path?: never;
|
|
2544
|
+
cookie?: never;
|
|
2545
|
+
};
|
|
2546
|
+
requestBody?: {
|
|
2547
|
+
content: {
|
|
2548
|
+
"application/json": components["schemas"]["WorkspaceSearchQuery"];
|
|
2549
|
+
};
|
|
2550
|
+
};
|
|
2551
|
+
responses: {
|
|
2552
|
+
/** @description The search completed successfully. */
|
|
2553
|
+
200: {
|
|
2554
|
+
headers: {
|
|
2555
|
+
[name: string]: unknown;
|
|
2556
|
+
};
|
|
2557
|
+
content: {
|
|
2558
|
+
"application/json": components["schemas"]["WorkspaceSearchQueryResult"];
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
400: components["responses"]["InvalidData"];
|
|
2562
|
+
401: components["responses"]["Unauthorized"];
|
|
2563
|
+
403: components["responses"]["Forbidden"];
|
|
2564
|
+
500: components["responses"]["InternalServerError"];
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
}
|
|
2568
|
+
//# sourceMappingURL=schema.d.ts.map
|