@meginhufr/brua-cli 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 +55 -0
- package/openapi.json +3459 -0
- package/package.json +39 -0
- package/src/api.ts +153 -0
- package/src/args.ts +70 -0
- package/src/brua.ts +168 -0
- package/src/openapi.d.ts +2618 -0
- package/src/pull.ts +122 -0
- package/src/push.ts +194 -0
package/src/openapi.d.ts
ADDED
|
@@ -0,0 +1,2618 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/v1/projects/{project}/api-keys": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/** The project's keys with when each was last used; secrets are never shown again. */
|
|
15
|
+
get: operations["ApiKeys.List"];
|
|
16
|
+
put?: never;
|
|
17
|
+
/** Creates a key for a system. The full key is in this response only (SPEC.md 13.2). */
|
|
18
|
+
post: operations["ApiKeys.Create"];
|
|
19
|
+
delete?: never;
|
|
20
|
+
options?: never;
|
|
21
|
+
head?: never;
|
|
22
|
+
patch?: never;
|
|
23
|
+
trace?: never;
|
|
24
|
+
};
|
|
25
|
+
"/v1/projects/{project}/api-keys/{id}": {
|
|
26
|
+
parameters: {
|
|
27
|
+
query?: never;
|
|
28
|
+
header?: never;
|
|
29
|
+
path?: never;
|
|
30
|
+
cookie?: never;
|
|
31
|
+
};
|
|
32
|
+
get?: never;
|
|
33
|
+
put?: never;
|
|
34
|
+
post?: never;
|
|
35
|
+
/** Revokes a key; requests with it fail from the next one. */
|
|
36
|
+
delete: operations["ApiKeys.Revoke"];
|
|
37
|
+
options?: never;
|
|
38
|
+
head?: never;
|
|
39
|
+
patch?: never;
|
|
40
|
+
trace?: never;
|
|
41
|
+
};
|
|
42
|
+
"/v1/projects/{project}/assets": {
|
|
43
|
+
parameters: {
|
|
44
|
+
query?: never;
|
|
45
|
+
header?: never;
|
|
46
|
+
path?: never;
|
|
47
|
+
cookie?: never;
|
|
48
|
+
};
|
|
49
|
+
/** Every asset in the project, newest first, with thumbnails of its newest processed version. */
|
|
50
|
+
get: operations["Assets.List"];
|
|
51
|
+
put?: never;
|
|
52
|
+
/** Creates an asset with a first draft version. */
|
|
53
|
+
post: operations["Assets.Create"];
|
|
54
|
+
delete?: never;
|
|
55
|
+
options?: never;
|
|
56
|
+
head?: never;
|
|
57
|
+
patch?: never;
|
|
58
|
+
trace?: never;
|
|
59
|
+
};
|
|
60
|
+
"/v1/projects/{project}/assets/{id}/versions": {
|
|
61
|
+
parameters: {
|
|
62
|
+
query?: never;
|
|
63
|
+
header?: never;
|
|
64
|
+
path?: never;
|
|
65
|
+
cookie?: never;
|
|
66
|
+
};
|
|
67
|
+
/** The asset's versions, newest first, with alt text, variant types and thumbnails. */
|
|
68
|
+
get: operations["Assets.Versions"];
|
|
69
|
+
put?: never;
|
|
70
|
+
/** Starts the next draft version of an existing asset. */
|
|
71
|
+
post: operations["Assets.CreateVersion"];
|
|
72
|
+
delete?: never;
|
|
73
|
+
options?: never;
|
|
74
|
+
head?: never;
|
|
75
|
+
patch?: never;
|
|
76
|
+
trace?: never;
|
|
77
|
+
};
|
|
78
|
+
"/v1/projects/{project}/assets/{id}": {
|
|
79
|
+
parameters: {
|
|
80
|
+
query?: never;
|
|
81
|
+
header?: never;
|
|
82
|
+
path?: never;
|
|
83
|
+
cookie?: never;
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* The delivery API: the asset's version in the current release as an AssetResponse, a snapshot to embed (SPEC.md 5.2).
|
|
87
|
+
* @description `not_found` when there is no such asset, `not_released` when none of its versions is live. Apps and pages that hold the id read the same object from the edge instead, at `/assets/{org}/{id}.json`, with no key.
|
|
88
|
+
*/
|
|
89
|
+
get: operations["Assets.Get"];
|
|
90
|
+
put?: never;
|
|
91
|
+
post?: never;
|
|
92
|
+
/**
|
|
93
|
+
* Deletes an asset that isn't in prod: its versions, files and entries in every release and change set go, so no rollback brings it back, and a merged change set that held nothing else goes with it (SPEC.md 10).
|
|
94
|
+
* @description `asset_live` while it is in prod: take it out in a change set first. `asset_in_review` while a submitted or approved change set holds it, with that change set's name as the id: send it back first.
|
|
95
|
+
*/
|
|
96
|
+
delete: operations["Assets.Delete"];
|
|
97
|
+
options?: never;
|
|
98
|
+
head?: never;
|
|
99
|
+
patch?: never;
|
|
100
|
+
trace?: never;
|
|
101
|
+
};
|
|
102
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}": {
|
|
103
|
+
parameters: {
|
|
104
|
+
query?: never;
|
|
105
|
+
header?: never;
|
|
106
|
+
path?: never;
|
|
107
|
+
cookie?: never;
|
|
108
|
+
};
|
|
109
|
+
/** The version's slots: which source files its preset needs, and which are uploaded (SPEC.md 9.1). Poll it after completing an upload until the status is "Ready" or "Failed". */
|
|
110
|
+
get: operations["Assets.GetVersion"];
|
|
111
|
+
put?: never;
|
|
112
|
+
post?: never;
|
|
113
|
+
/**
|
|
114
|
+
* Deletes a version that isn't in prod: its files and entries in every release and change set go, and its number is never given out again (SPEC.md 10).
|
|
115
|
+
* @description `version_live` while it is in prod. `version_in_review` while a submitted or approved change set holds it, with that change set's name as the id. `only_version` for an asset's last version: delete the asset instead.
|
|
116
|
+
*/
|
|
117
|
+
delete: operations["Assets.DeleteVersion"];
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
patch?: never;
|
|
121
|
+
trace?: never;
|
|
122
|
+
};
|
|
123
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}/slots/{slot}/upload-url": {
|
|
124
|
+
parameters: {
|
|
125
|
+
query?: never;
|
|
126
|
+
header?: never;
|
|
127
|
+
path?: never;
|
|
128
|
+
cookie?: never;
|
|
129
|
+
};
|
|
130
|
+
get?: never;
|
|
131
|
+
put?: never;
|
|
132
|
+
/**
|
|
133
|
+
* Returns a presigned URL to PUT one slot's source file to.
|
|
134
|
+
* @description Slots are named like `dark.still.source` or `nb.light.still.source` (SPEC.md 9.1). The slot must be one the preset has (`slot_not_in_preset`) and the version still a draft (`version_not_draft`). PUT the bytes to the URL with the file's Content-Type, then complete the slot.
|
|
135
|
+
*/
|
|
136
|
+
post: operations["Assets.RequestSlotUpload"];
|
|
137
|
+
delete?: never;
|
|
138
|
+
options?: never;
|
|
139
|
+
head?: never;
|
|
140
|
+
patch?: never;
|
|
141
|
+
trace?: never;
|
|
142
|
+
};
|
|
143
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}/slots/{slot}/complete": {
|
|
144
|
+
parameters: {
|
|
145
|
+
query?: never;
|
|
146
|
+
header?: never;
|
|
147
|
+
path?: never;
|
|
148
|
+
cookie?: never;
|
|
149
|
+
};
|
|
150
|
+
get?: never;
|
|
151
|
+
put?: never;
|
|
152
|
+
/**
|
|
153
|
+
* Confirms a slot's file is uploaded. Processing starts when every required slot is.
|
|
154
|
+
* @description `upload_not_requested` when no upload URL was asked for, `source_missing` when nothing was PUT to it.
|
|
155
|
+
*/
|
|
156
|
+
post: operations["Assets.CompleteSlotUpload"];
|
|
157
|
+
delete?: never;
|
|
158
|
+
options?: never;
|
|
159
|
+
head?: never;
|
|
160
|
+
patch?: never;
|
|
161
|
+
trace?: never;
|
|
162
|
+
};
|
|
163
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}/source/upload-url": {
|
|
164
|
+
parameters: {
|
|
165
|
+
query?: never;
|
|
166
|
+
header?: never;
|
|
167
|
+
path?: never;
|
|
168
|
+
cookie?: never;
|
|
169
|
+
};
|
|
170
|
+
get?: never;
|
|
171
|
+
put?: never;
|
|
172
|
+
/** Shorthand for the single slot of a flexible asset, any.still.source. */
|
|
173
|
+
post: operations["Assets.RequestSourceUpload"];
|
|
174
|
+
delete?: never;
|
|
175
|
+
options?: never;
|
|
176
|
+
head?: never;
|
|
177
|
+
patch?: never;
|
|
178
|
+
trace?: never;
|
|
179
|
+
};
|
|
180
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}/source/complete": {
|
|
181
|
+
parameters: {
|
|
182
|
+
query?: never;
|
|
183
|
+
header?: never;
|
|
184
|
+
path?: never;
|
|
185
|
+
cookie?: never;
|
|
186
|
+
};
|
|
187
|
+
get?: never;
|
|
188
|
+
put?: never;
|
|
189
|
+
/** Shorthand for completing the single slot of a flexible asset. */
|
|
190
|
+
post: operations["Assets.CompleteSourceUpload"];
|
|
191
|
+
delete?: never;
|
|
192
|
+
options?: never;
|
|
193
|
+
head?: never;
|
|
194
|
+
patch?: never;
|
|
195
|
+
trace?: never;
|
|
196
|
+
};
|
|
197
|
+
"/v1/projects/{project}/assets/{id}/versions/{version}/submit": {
|
|
198
|
+
parameters: {
|
|
199
|
+
query?: never;
|
|
200
|
+
header?: never;
|
|
201
|
+
path?: never;
|
|
202
|
+
cookie?: never;
|
|
203
|
+
};
|
|
204
|
+
get?: never;
|
|
205
|
+
put?: never;
|
|
206
|
+
/**
|
|
207
|
+
* Adds a processed version to a change set, or to a new one with just this change (SPEC.md 21.1).
|
|
208
|
+
* @description `version_not_ready` until processing has finished.
|
|
209
|
+
*/
|
|
210
|
+
post: operations["Assets.SubmitVersion"];
|
|
211
|
+
delete?: never;
|
|
212
|
+
options?: never;
|
|
213
|
+
head?: never;
|
|
214
|
+
patch?: never;
|
|
215
|
+
trace?: never;
|
|
216
|
+
};
|
|
217
|
+
"/v1/projects/{project}/change-sets": {
|
|
218
|
+
parameters: {
|
|
219
|
+
query?: never;
|
|
220
|
+
header?: never;
|
|
221
|
+
path?: never;
|
|
222
|
+
cookie?: never;
|
|
223
|
+
};
|
|
224
|
+
/** The project's change sets, newest first, merged ones included. */
|
|
225
|
+
get: operations["ChangeSets.List"];
|
|
226
|
+
put?: never;
|
|
227
|
+
/** Opens an empty change set to add changes to. */
|
|
228
|
+
post: operations["ChangeSets.Create"];
|
|
229
|
+
delete?: never;
|
|
230
|
+
options?: never;
|
|
231
|
+
head?: never;
|
|
232
|
+
patch?: never;
|
|
233
|
+
trace?: never;
|
|
234
|
+
};
|
|
235
|
+
"/v1/projects/{project}/change-sets/{id}": {
|
|
236
|
+
parameters: {
|
|
237
|
+
query?: never;
|
|
238
|
+
header?: never;
|
|
239
|
+
path?: never;
|
|
240
|
+
cookie?: never;
|
|
241
|
+
};
|
|
242
|
+
/** The change set with its diff against prod, including conflicts. */
|
|
243
|
+
get: operations["ChangeSets.Get"];
|
|
244
|
+
put?: never;
|
|
245
|
+
post?: never;
|
|
246
|
+
/**
|
|
247
|
+
* Deletes a change set that hasn't merged. The versions in it stay with their assets.
|
|
248
|
+
* @description `change_set_merged` once it has merged: a merged change set is part of the release history.
|
|
249
|
+
*/
|
|
250
|
+
delete: operations["ChangeSets.Delete"];
|
|
251
|
+
options?: never;
|
|
252
|
+
head?: never;
|
|
253
|
+
patch?: never;
|
|
254
|
+
trace?: never;
|
|
255
|
+
};
|
|
256
|
+
"/v1/projects/{project}/change-sets/{id}/changes": {
|
|
257
|
+
parameters: {
|
|
258
|
+
query?: never;
|
|
259
|
+
header?: never;
|
|
260
|
+
path?: never;
|
|
261
|
+
cookie?: never;
|
|
262
|
+
};
|
|
263
|
+
get?: never;
|
|
264
|
+
put?: never;
|
|
265
|
+
/**
|
|
266
|
+
* Points an asset at a version, or takes it out of the release when version is null.
|
|
267
|
+
* @description Only while the change set is open (`change_set_not_open`) and the version is processed (`version_not_ready`).
|
|
268
|
+
*/
|
|
269
|
+
post: operations["ChangeSets.AddChange"];
|
|
270
|
+
delete?: never;
|
|
271
|
+
options?: never;
|
|
272
|
+
head?: never;
|
|
273
|
+
patch?: never;
|
|
274
|
+
trace?: never;
|
|
275
|
+
};
|
|
276
|
+
"/v1/projects/{project}/change-sets/{id}/submit": {
|
|
277
|
+
parameters: {
|
|
278
|
+
query?: never;
|
|
279
|
+
header?: never;
|
|
280
|
+
path?: never;
|
|
281
|
+
cookie?: never;
|
|
282
|
+
};
|
|
283
|
+
get?: never;
|
|
284
|
+
put?: never;
|
|
285
|
+
/**
|
|
286
|
+
* Sends the change set for review.
|
|
287
|
+
* @description `change_set_empty` when it has no changes.
|
|
288
|
+
*/
|
|
289
|
+
post: operations["ChangeSets.Submit"];
|
|
290
|
+
delete?: never;
|
|
291
|
+
options?: never;
|
|
292
|
+
head?: never;
|
|
293
|
+
patch?: never;
|
|
294
|
+
trace?: never;
|
|
295
|
+
};
|
|
296
|
+
"/v1/projects/{project}/change-sets/{id}/approve": {
|
|
297
|
+
parameters: {
|
|
298
|
+
query?: never;
|
|
299
|
+
header?: never;
|
|
300
|
+
path?: never;
|
|
301
|
+
cookie?: never;
|
|
302
|
+
};
|
|
303
|
+
get?: never;
|
|
304
|
+
put?: never;
|
|
305
|
+
/**
|
|
306
|
+
* Approves a submitted change set, by a person other than its author.
|
|
307
|
+
* @description `own_change_set` when the author tries, unless the project's review policy allows self-approval.
|
|
308
|
+
*/
|
|
309
|
+
post: operations["ChangeSets.Approve"];
|
|
310
|
+
delete?: never;
|
|
311
|
+
options?: never;
|
|
312
|
+
head?: never;
|
|
313
|
+
patch?: never;
|
|
314
|
+
trace?: never;
|
|
315
|
+
};
|
|
316
|
+
"/v1/projects/{project}/change-sets/{id}/merge": {
|
|
317
|
+
parameters: {
|
|
318
|
+
query?: never;
|
|
319
|
+
header?: never;
|
|
320
|
+
path?: never;
|
|
321
|
+
cookie?: never;
|
|
322
|
+
};
|
|
323
|
+
get?: never;
|
|
324
|
+
put?: never;
|
|
325
|
+
/**
|
|
326
|
+
* Merges an approved change set into a new release now, or at a scheduled time.
|
|
327
|
+
* @description Refused while an asset is in conflict (`conflicts`, with the asset ids) and when another merge got there first (`concurrent_release`). Merging is done by a person: keys cannot approve or merge.
|
|
328
|
+
*/
|
|
329
|
+
post: operations["ChangeSets.Merge"];
|
|
330
|
+
delete?: never;
|
|
331
|
+
options?: never;
|
|
332
|
+
head?: never;
|
|
333
|
+
patch?: never;
|
|
334
|
+
trace?: never;
|
|
335
|
+
};
|
|
336
|
+
"/v1/projects/{project}/change-sets/{id}/withdraw": {
|
|
337
|
+
parameters: {
|
|
338
|
+
query?: never;
|
|
339
|
+
header?: never;
|
|
340
|
+
path?: never;
|
|
341
|
+
cookie?: never;
|
|
342
|
+
};
|
|
343
|
+
get?: never;
|
|
344
|
+
put?: never;
|
|
345
|
+
/**
|
|
346
|
+
* Takes a submitted or approved change set back to open, so editors can change it again; a scheduled merge is cancelled.
|
|
347
|
+
* @description `change_set_merged` once it has merged, `change_set_open` when there is nothing to withdraw.
|
|
348
|
+
*/
|
|
349
|
+
post: operations["ChangeSets.Withdraw"];
|
|
350
|
+
delete?: never;
|
|
351
|
+
options?: never;
|
|
352
|
+
head?: never;
|
|
353
|
+
patch?: never;
|
|
354
|
+
trace?: never;
|
|
355
|
+
};
|
|
356
|
+
"/v1/projects/{project}/change-sets/{id}/resolve": {
|
|
357
|
+
parameters: {
|
|
358
|
+
query?: never;
|
|
359
|
+
header?: never;
|
|
360
|
+
path?: never;
|
|
361
|
+
cookie?: never;
|
|
362
|
+
};
|
|
363
|
+
get?: never;
|
|
364
|
+
put?: never;
|
|
365
|
+
/** Settles a conflict for one asset: keep "mine" (this change set's version) or "prod". */
|
|
366
|
+
post: operations["ChangeSets.Resolve"];
|
|
367
|
+
delete?: never;
|
|
368
|
+
options?: never;
|
|
369
|
+
head?: never;
|
|
370
|
+
patch?: never;
|
|
371
|
+
trace?: never;
|
|
372
|
+
};
|
|
373
|
+
"/v1/projects/{project}": {
|
|
374
|
+
parameters: {
|
|
375
|
+
query?: never;
|
|
376
|
+
header?: never;
|
|
377
|
+
path?: never;
|
|
378
|
+
cookie?: never;
|
|
379
|
+
};
|
|
380
|
+
/** The project's name and languages, for clients such as the Figma plugin and pipelines that need to know which languages alt text takes. */
|
|
381
|
+
get: operations["Projects.Get"];
|
|
382
|
+
put?: never;
|
|
383
|
+
post?: never;
|
|
384
|
+
delete?: never;
|
|
385
|
+
options?: never;
|
|
386
|
+
head?: never;
|
|
387
|
+
patch?: never;
|
|
388
|
+
trace?: never;
|
|
389
|
+
};
|
|
390
|
+
"/v1/projects/{project}/releases": {
|
|
391
|
+
parameters: {
|
|
392
|
+
query?: never;
|
|
393
|
+
header?: never;
|
|
394
|
+
path?: never;
|
|
395
|
+
cookie?: never;
|
|
396
|
+
};
|
|
397
|
+
/** Release history, newest (prod) first. */
|
|
398
|
+
get: operations["Releases.List"];
|
|
399
|
+
put?: never;
|
|
400
|
+
post?: never;
|
|
401
|
+
delete?: never;
|
|
402
|
+
options?: never;
|
|
403
|
+
head?: never;
|
|
404
|
+
patch?: never;
|
|
405
|
+
trace?: never;
|
|
406
|
+
};
|
|
407
|
+
"/v1/projects/{project}/releases/{number}/restore": {
|
|
408
|
+
parameters: {
|
|
409
|
+
query?: never;
|
|
410
|
+
header?: never;
|
|
411
|
+
path?: never;
|
|
412
|
+
cookie?: never;
|
|
413
|
+
};
|
|
414
|
+
get?: never;
|
|
415
|
+
put?: never;
|
|
416
|
+
/** Rolls prod back to release `number`'s contents, as a new release (SPEC.md 21.5). */
|
|
417
|
+
post: operations["Releases.Restore"];
|
|
418
|
+
delete?: never;
|
|
419
|
+
options?: never;
|
|
420
|
+
head?: never;
|
|
421
|
+
patch?: never;
|
|
422
|
+
trace?: never;
|
|
423
|
+
};
|
|
424
|
+
}
|
|
425
|
+
export type webhooks = Record<string, never>;
|
|
426
|
+
export interface components {
|
|
427
|
+
schemas: {
|
|
428
|
+
/** @description Points an asset at a version, or takes it out of the release when Brua.Shared.DTOs.AddChangeRequest.Version is null. */
|
|
429
|
+
AddChangeRequest: {
|
|
430
|
+
/** @description The asset's id. */
|
|
431
|
+
asset: string;
|
|
432
|
+
/**
|
|
433
|
+
* Format: int32
|
|
434
|
+
* @description A processed version, or null to remove the asset from the release.
|
|
435
|
+
*/
|
|
436
|
+
version?: number | null;
|
|
437
|
+
};
|
|
438
|
+
/** @description A key as listed for admins: the secret is never shown again, only its prefix (SPEC.md 13.2). */
|
|
439
|
+
ApiKeyDto: {
|
|
440
|
+
/** @description The key's id, for revoking it. */
|
|
441
|
+
id: string;
|
|
442
|
+
/** @description The system it is for. */
|
|
443
|
+
name: string;
|
|
444
|
+
/** @description The part of the key that identifies it, brua_{prefix}. */
|
|
445
|
+
prefix: string;
|
|
446
|
+
/** @description What it may do. */
|
|
447
|
+
scopes: string[];
|
|
448
|
+
/**
|
|
449
|
+
* Format: date-time
|
|
450
|
+
* @description When it was created.
|
|
451
|
+
*/
|
|
452
|
+
createdAt: string;
|
|
453
|
+
/**
|
|
454
|
+
* Format: date-time
|
|
455
|
+
* @description When a request last used it.
|
|
456
|
+
*/
|
|
457
|
+
lastUsedAt?: string | null;
|
|
458
|
+
/**
|
|
459
|
+
* Format: date-time
|
|
460
|
+
* @description When it was revoked, if it was.
|
|
461
|
+
*/
|
|
462
|
+
revokedAt?: string | null;
|
|
463
|
+
};
|
|
464
|
+
/** @description An asset and all its versions, newest first, for the back office. The asset itself is an id and a
|
|
465
|
+
* Brua.Shared.DTOs.AssetDetailDto.Sizing; each version says which conditions have their own files. Brua.Shared.DTOs.AssetDetailDto.Library names the
|
|
466
|
+
* shared library the asset lives in when it isn't the project's own; it is changed there (SPEC.md 22.4). */
|
|
467
|
+
AssetDetailDto: {
|
|
468
|
+
/** @description The asset's id. */
|
|
469
|
+
id: string;
|
|
470
|
+
/** @description "flexible" (a width ladder) or "fixed" (a designed size at @1x–@3x); every version keeps it. */
|
|
471
|
+
sizing: string;
|
|
472
|
+
/**
|
|
473
|
+
* Format: int32
|
|
474
|
+
* @description The version in prod; left out when none is released.
|
|
475
|
+
*/
|
|
476
|
+
liveVersion?: number | null;
|
|
477
|
+
/**
|
|
478
|
+
* Format: date-time
|
|
479
|
+
* @description When the asset was created.
|
|
480
|
+
*/
|
|
481
|
+
createdAt: string;
|
|
482
|
+
/** @description Every version, newest first. */
|
|
483
|
+
versions: components["schemas"]["VersionDetailDto"][];
|
|
484
|
+
/** @description The shared library the asset lives in, when it isn't the project's own. */
|
|
485
|
+
library?: string | null;
|
|
486
|
+
};
|
|
487
|
+
/** @description The asset contract from SPEC.md section 5: the HTML picture model as JSON.
|
|
488
|
+
* Optional fields are null and left out of the JSON. */
|
|
489
|
+
AssetResponse: {
|
|
490
|
+
/** @description The asset's id, unique in the organization. */
|
|
491
|
+
id: string;
|
|
492
|
+
/**
|
|
493
|
+
* Format: int32
|
|
494
|
+
* @description The version the response describes: the one in the current release, unless a version was asked for.
|
|
495
|
+
*/
|
|
496
|
+
version: number;
|
|
497
|
+
/** @description The single URL: the edge negotiates format, density, color scheme and language from the request. */
|
|
498
|
+
url: string;
|
|
499
|
+
/**
|
|
500
|
+
* Format: int32
|
|
501
|
+
* @description The width in CSS pixels at 1x.
|
|
502
|
+
*/
|
|
503
|
+
width: number;
|
|
504
|
+
/**
|
|
505
|
+
* Format: int32
|
|
506
|
+
* @description The height in CSS pixels at 1x.
|
|
507
|
+
*/
|
|
508
|
+
height: number;
|
|
509
|
+
/** @description The alt text in the resolved language; empty for a decorative asset. */
|
|
510
|
+
alt: string;
|
|
511
|
+
/** @description The alt text's language, when the asset has one. */
|
|
512
|
+
lang?: string | null;
|
|
513
|
+
/** @description Every file of the version for the resolved language, each with the conditions it is for. */
|
|
514
|
+
variants: components["schemas"]["AssetVariantDto"][];
|
|
515
|
+
};
|
|
516
|
+
/** @description One asset in the back office's list, with its newest version and the version in prod. Brua.Shared.DTOs.AssetSummaryDto.Library names
|
|
517
|
+
* the shared library the asset lives in when it isn't the project's own (SPEC.md 22). Brua.Shared.DTOs.AssetSummaryDto.LiveUrl is the
|
|
518
|
+
* single URL of the version in prod. */
|
|
519
|
+
AssetSummaryDto: {
|
|
520
|
+
/** @description The asset's id. */
|
|
521
|
+
id: string;
|
|
522
|
+
/** @description "flexible", "fixed" or "animated". */
|
|
523
|
+
preset: string;
|
|
524
|
+
/**
|
|
525
|
+
* Format: int32
|
|
526
|
+
* @description The newest version's number.
|
|
527
|
+
*/
|
|
528
|
+
latestVersion: number;
|
|
529
|
+
/** @description The newest version's status: "Draft", "Processing", "Ready" or "Failed". */
|
|
530
|
+
latestStatus: string;
|
|
531
|
+
/**
|
|
532
|
+
* Format: int32
|
|
533
|
+
* @description The version in prod; left out when none is released.
|
|
534
|
+
*/
|
|
535
|
+
liveVersion?: number | null;
|
|
536
|
+
/**
|
|
537
|
+
* Format: int32
|
|
538
|
+
* @description The newest processed version's width in CSS pixels.
|
|
539
|
+
*/
|
|
540
|
+
width?: number | null;
|
|
541
|
+
/**
|
|
542
|
+
* Format: int32
|
|
543
|
+
* @description The newest processed version's height in CSS pixels.
|
|
544
|
+
*/
|
|
545
|
+
height?: number | null;
|
|
546
|
+
/** @description The newest version's alt text in the project's first language. */
|
|
547
|
+
alt?: string | null;
|
|
548
|
+
/** @description Whether the asset is decorative. */
|
|
549
|
+
decorative: boolean;
|
|
550
|
+
/** @description Thumbnails of the newest processed version. */
|
|
551
|
+
previews: components["schemas"]["PreviewDto"][];
|
|
552
|
+
/** @description The shared library the asset lives in, when it isn't the project's own. */
|
|
553
|
+
library?: string | null;
|
|
554
|
+
/** @description The single URL of the version in prod. */
|
|
555
|
+
liveUrl?: string | null;
|
|
556
|
+
};
|
|
557
|
+
/** @description One file of a version. Value fields are strings, not closed enums, so new values never break a client (SPEC.md 14). */
|
|
558
|
+
AssetVariantDto: {
|
|
559
|
+
/** @description The file's media type. */
|
|
560
|
+
type: string;
|
|
561
|
+
/** @description The file's URL on the edge, immutable. */
|
|
562
|
+
url: string;
|
|
563
|
+
/** @description "light" or "dark" when the file is for one scheme; left out when it serves both. */
|
|
564
|
+
prefersColorScheme?: string | null;
|
|
565
|
+
/** @description "reduce" on the still of an animation. */
|
|
566
|
+
prefersReducedMotion?: string | null;
|
|
567
|
+
/** @description The language the file is for; left out for language-neutral files. */
|
|
568
|
+
lang?: string | null;
|
|
569
|
+
/**
|
|
570
|
+
* Format: int32
|
|
571
|
+
* @description The density of a fixed-size file: 1, 2 or 3.
|
|
572
|
+
*/
|
|
573
|
+
scale?: number | null;
|
|
574
|
+
/**
|
|
575
|
+
* Format: int32
|
|
576
|
+
* @description The width of a flexible file in pixels.
|
|
577
|
+
*/
|
|
578
|
+
pixelWidth?: number | null;
|
|
579
|
+
};
|
|
580
|
+
/** @description A version while it is made: its slots, and whether processing has finished (SPEC.md 9). */
|
|
581
|
+
AssetVersionDto: {
|
|
582
|
+
/** @description The asset's id. */
|
|
583
|
+
id: string;
|
|
584
|
+
/**
|
|
585
|
+
* Format: int32
|
|
586
|
+
* @description The version number, from 1.
|
|
587
|
+
*/
|
|
588
|
+
version: number;
|
|
589
|
+
/** @description "Draft" until every required slot is uploaded, "Processing", then "Ready" or "Failed". */
|
|
590
|
+
status: string;
|
|
591
|
+
/** @description The source files the preset needs and which are uploaded. */
|
|
592
|
+
slots?: components["schemas"]["SlotDto"][] | null;
|
|
593
|
+
/** @description Why processing failed, such as "wrong_proportions" (SPEC.md 9.2). */
|
|
594
|
+
failureCode?: string | null;
|
|
595
|
+
/** @description The failure in words. */
|
|
596
|
+
failureDetail?: string | null;
|
|
597
|
+
};
|
|
598
|
+
/** @description One asset in a change set's diff: from its prod version to the change set's (SPEC.md 21.3).
|
|
599
|
+
* Brua.Shared.DTOs.ChangeDto.ProportionChange is set when the new version has another shape than the one in prod, and
|
|
600
|
+
* Brua.Shared.DTOs.ChangeDto.CoverageChange when other conditions have their own files (appearances, languages, an animation). */
|
|
601
|
+
ChangeDto: {
|
|
602
|
+
/** @description The asset's id. */
|
|
603
|
+
asset: string;
|
|
604
|
+
/** @description "set" (a version goes live) or "remove" (the asset leaves the release). */
|
|
605
|
+
kind: string;
|
|
606
|
+
/**
|
|
607
|
+
* Format: int32
|
|
608
|
+
* @description The version in prod; left out when the asset isn't released yet.
|
|
609
|
+
*/
|
|
610
|
+
fromVersion?: number | null;
|
|
611
|
+
/**
|
|
612
|
+
* Format: int32
|
|
613
|
+
* @description The version the change set carries; left out for a removal.
|
|
614
|
+
*/
|
|
615
|
+
toVersion?: number | null;
|
|
616
|
+
/** @description True when prod changed after the change was added; resolve it before merging. */
|
|
617
|
+
conflict: boolean;
|
|
618
|
+
proportionChange?: components["schemas"]["ProportionChangeDto"];
|
|
619
|
+
coverageChange?: components["schemas"]["CoverageChangeDto"];
|
|
620
|
+
};
|
|
621
|
+
/** @description A change set: versions that go live together once reviewed (SPEC.md 21). */
|
|
622
|
+
ChangeSetDto: {
|
|
623
|
+
/** @description The change set's id. */
|
|
624
|
+
id: string;
|
|
625
|
+
/** @description What it is for, such as "Spring campaign". */
|
|
626
|
+
name: string;
|
|
627
|
+
/** @description "open", "inreview", "approved" or "merged". */
|
|
628
|
+
status: string;
|
|
629
|
+
/**
|
|
630
|
+
* Format: date-time
|
|
631
|
+
* @description When it was opened.
|
|
632
|
+
*/
|
|
633
|
+
createdAt: string;
|
|
634
|
+
/** @description Who opened it: an email, or "key:{name}" for a system. */
|
|
635
|
+
createdBy?: string | null;
|
|
636
|
+
/** @description Who approved it. */
|
|
637
|
+
approvedBy?: string | null;
|
|
638
|
+
/**
|
|
639
|
+
* Format: date-time
|
|
640
|
+
* @description When a scheduled merge happens.
|
|
641
|
+
*/
|
|
642
|
+
mergeAt?: string | null;
|
|
643
|
+
/**
|
|
644
|
+
* Format: int32
|
|
645
|
+
* @description The release it became.
|
|
646
|
+
*/
|
|
647
|
+
mergedRelease?: number | null;
|
|
648
|
+
/** @description Its diff against prod, one entry per asset. */
|
|
649
|
+
changes: components["schemas"]["ChangeDto"][];
|
|
650
|
+
/**
|
|
651
|
+
* Format: int32
|
|
652
|
+
* @description For a library: how many projects a merge reaches. Left out for a project.
|
|
653
|
+
*/
|
|
654
|
+
readBy?: number | null;
|
|
655
|
+
};
|
|
656
|
+
/** @description Which conditions have their own files before and after a change, when that differs: a dark-mode user gets the one
|
|
657
|
+
* design where there was a dark file, every language gets the same image, a still plays where an animation did, or
|
|
658
|
+
* the other way round. */
|
|
659
|
+
CoverageChangeDto: {
|
|
660
|
+
/** @description The preset in prod. */
|
|
661
|
+
fromPreset: string;
|
|
662
|
+
/** @description The new preset. */
|
|
663
|
+
toPreset: string;
|
|
664
|
+
/** @description The color schemes in prod: "any", "any-dark" or "both". */
|
|
665
|
+
fromColorSchemes: string;
|
|
666
|
+
/** @description The new color schemes. */
|
|
667
|
+
toColorSchemes: string;
|
|
668
|
+
/** @description The languages in prod: "none", "optional" or "required". */
|
|
669
|
+
fromLanguages: string;
|
|
670
|
+
/** @description The new languages. */
|
|
671
|
+
toLanguages: string;
|
|
672
|
+
};
|
|
673
|
+
/** @description Body of `POST …/api-keys`. */
|
|
674
|
+
CreateApiKeyRequest: {
|
|
675
|
+
/** @description The system the key is for, such as "gift-service"; shown wherever the key's actions are. */
|
|
676
|
+
name: string;
|
|
677
|
+
/** @description "delivery:read" (reading assets) and "assets:write" (creating assets, uploading, change sets); "admin" for keys and settings. */
|
|
678
|
+
scopes: string[];
|
|
679
|
+
};
|
|
680
|
+
/** @description Body of `POST /v1/projects/{project}/assets`. Brua.Shared.DTOs.CreateAssetRequest.StillFit is "match" (default: stills must have the
|
|
681
|
+
* designed proportions) or "fill" (stills are scaled and center-cropped to the designed size). Brua.Shared.DTOs.CreateAssetRequest.Languages
|
|
682
|
+
* is "none" (default), "optional" (some languages have their own files, slots `{lang}.{scheme}.{motion}.source`)
|
|
683
|
+
* or "required" (every project language has its own). Brua.Shared.DTOs.CreateAssetRequest.ColorSchemes is "any", "any-dark" (a default plus a dark
|
|
684
|
+
* override) or "both". Brua.Shared.DTOs.CreateAssetRequest.Scales is "single" (default: one still source) or "individual" (fixed sizing: a still per
|
|
685
|
+
* scale in slots such as `light.still@2x`, @2x and @3x required, @1x made from @2x when left out). */
|
|
686
|
+
CreateAssetRequest: {
|
|
687
|
+
/** @description The asset's id: lowercase letters, digits and dashes, unique in the organization, and the contract with every consumer. */
|
|
688
|
+
id: string;
|
|
689
|
+
/** @description "flexible", "fixed" or "animated" (SPEC.md 4). */
|
|
690
|
+
preset: string;
|
|
691
|
+
/** @description Alt text per project language; required in every language unless the asset is decorative. */
|
|
692
|
+
alt?: {
|
|
693
|
+
[key: string]: string;
|
|
694
|
+
} | null;
|
|
695
|
+
/** @description True for an asset that carries no meaning, which screen readers then skip. */
|
|
696
|
+
decorative: boolean;
|
|
697
|
+
/**
|
|
698
|
+
* Format: int32
|
|
699
|
+
* @description The designed width in CSS pixels, for fixed and animated assets.
|
|
700
|
+
*/
|
|
701
|
+
width?: number | null;
|
|
702
|
+
/**
|
|
703
|
+
* Format: int32
|
|
704
|
+
* @description The designed height in CSS pixels, for fixed and animated assets.
|
|
705
|
+
*/
|
|
706
|
+
height?: number | null;
|
|
707
|
+
/** @description "any", "any-dark" or "both". */
|
|
708
|
+
colorSchemes?: string | null;
|
|
709
|
+
/** @description "match" or "fill". */
|
|
710
|
+
stillFit?: string | null;
|
|
711
|
+
/** @description "none", "optional" or "required". */
|
|
712
|
+
languages?: string | null;
|
|
713
|
+
/** @description "single" or "individual". */
|
|
714
|
+
scales?: string | null;
|
|
715
|
+
};
|
|
716
|
+
/** @description Body of `POST …/change-sets`. */
|
|
717
|
+
CreateChangeSetRequest: {
|
|
718
|
+
/** @description What the change set is for. */
|
|
719
|
+
name: string;
|
|
720
|
+
};
|
|
721
|
+
/** @description Body of `POST …/assets/{id}/versions`. A version decides which conditions have their own files: its preset,
|
|
722
|
+
* color schemes, languages, scales and designed size can all differ from the version before, both ways (one file where
|
|
723
|
+
* there were eight, or dark and languages added). Only the sizing stays: a flexible asset's versions are flexible, a
|
|
724
|
+
* fixed one's fixed or animated. Everything left out, the alt text and Brua.Shared.DTOs.CreateVersionRequest.StillFit included, is copied from
|
|
725
|
+
* the newest version. */
|
|
726
|
+
CreateVersionRequest: {
|
|
727
|
+
/** @description New alt text per project language. */
|
|
728
|
+
alt?: {
|
|
729
|
+
[key: string]: string;
|
|
730
|
+
} | null;
|
|
731
|
+
/** @description Whether the asset is decorative from this version on. */
|
|
732
|
+
decorative?: boolean | null;
|
|
733
|
+
/** @description "match" or "fill". */
|
|
734
|
+
stillFit?: string | null;
|
|
735
|
+
/** @description "flexible", "fixed" or "animated", of the asset's sizing. */
|
|
736
|
+
preset?: string | null;
|
|
737
|
+
/**
|
|
738
|
+
* Format: int32
|
|
739
|
+
* @description The designed width in CSS pixels, for fixed and animated versions.
|
|
740
|
+
*/
|
|
741
|
+
width?: number | null;
|
|
742
|
+
/**
|
|
743
|
+
* Format: int32
|
|
744
|
+
* @description The designed height in CSS pixels, for fixed and animated versions.
|
|
745
|
+
*/
|
|
746
|
+
height?: number | null;
|
|
747
|
+
/** @description "any", "any-dark" or "both". */
|
|
748
|
+
colorSchemes?: string | null;
|
|
749
|
+
/** @description "none", "optional" or "required". */
|
|
750
|
+
languages?: string | null;
|
|
751
|
+
/** @description "single" or "individual". */
|
|
752
|
+
scales?: string | null;
|
|
753
|
+
};
|
|
754
|
+
/** @description The full key is returned only here, once. */
|
|
755
|
+
CreatedApiKeyDto: {
|
|
756
|
+
/** @description The key's id, for revoking it. */
|
|
757
|
+
id: string;
|
|
758
|
+
/** @description The system it is for. */
|
|
759
|
+
name: string;
|
|
760
|
+
/** @description The key, `brua_{prefix}_{secret}`: send it as `X-Api-Key`. Store it now; it is never shown again. */
|
|
761
|
+
key: string;
|
|
762
|
+
/** @description What it may do. */
|
|
763
|
+
scopes: string[];
|
|
764
|
+
};
|
|
765
|
+
/** @description Every error, on every endpoint (SPEC.md 5.2). */
|
|
766
|
+
ErrorDto: {
|
|
767
|
+
/** @description A code to act on, such as "not_found", "not_released", "validation_failed" or "conflicts". */
|
|
768
|
+
error: string;
|
|
769
|
+
/** @description What the error is about, such as the asset id or the change set. */
|
|
770
|
+
id?: string | null;
|
|
771
|
+
/** @description For "validation_failed": the messages per field. */
|
|
772
|
+
errors?: {
|
|
773
|
+
[key: string]: string[];
|
|
774
|
+
} | null;
|
|
775
|
+
};
|
|
776
|
+
/** @description Body of `POST …/change-sets/{id}/merge`. */
|
|
777
|
+
MergeRequest: {
|
|
778
|
+
/**
|
|
779
|
+
* Format: date-time
|
|
780
|
+
* @description When to merge; left out, now.
|
|
781
|
+
*/
|
|
782
|
+
at?: string | null;
|
|
783
|
+
};
|
|
784
|
+
/** @description A small still of a version for thumbnails; Brua.Shared.DTOs.PreviewDto.ColorScheme is null when it serves both and
|
|
785
|
+
* Brua.Shared.DTOs.PreviewDto.Lang is null for language-neutral files. Brua.Shared.DTOs.PreviewDto.Transparent is set when the still has an alpha channel. */
|
|
786
|
+
PreviewDto: {
|
|
787
|
+
/** @description "light" or "dark"; left out when the still serves both. */
|
|
788
|
+
colorScheme?: string | null;
|
|
789
|
+
/** @description The thumbnail's URL on the edge. */
|
|
790
|
+
url: string;
|
|
791
|
+
/** @description Whether the still has an alpha channel, so it is shown on a checkerboard. */
|
|
792
|
+
transparent: boolean;
|
|
793
|
+
/** @description The language the still is for; left out for language-neutral files. */
|
|
794
|
+
lang?: string | null;
|
|
795
|
+
};
|
|
796
|
+
/** @description A project's settings that clients need, such as the languages alt text is required in. */
|
|
797
|
+
ProjectDto: {
|
|
798
|
+
/** @description The project's id in URLs. */
|
|
799
|
+
slug: string;
|
|
800
|
+
/** @description The project's name. */
|
|
801
|
+
name: string;
|
|
802
|
+
/** @description The project's languages as BCP 47 tags, first one the default; alt text is required in each. */
|
|
803
|
+
languages: string[];
|
|
804
|
+
/** @description Whether authors may approve their own change sets, from the review policy (SPEC.md 6.2). */
|
|
805
|
+
allowSelfApproval: boolean;
|
|
806
|
+
};
|
|
807
|
+
/** @description The sizes a change moves an asset between, when their proportions differ: what a layout built for the old shape gets. */
|
|
808
|
+
ProportionChangeDto: {
|
|
809
|
+
/**
|
|
810
|
+
* Format: int32
|
|
811
|
+
* @description The width in prod.
|
|
812
|
+
*/
|
|
813
|
+
fromWidth: number;
|
|
814
|
+
/**
|
|
815
|
+
* Format: int32
|
|
816
|
+
* @description The height in prod.
|
|
817
|
+
*/
|
|
818
|
+
fromHeight: number;
|
|
819
|
+
/**
|
|
820
|
+
* Format: int32
|
|
821
|
+
* @description The new width.
|
|
822
|
+
*/
|
|
823
|
+
toWidth: number;
|
|
824
|
+
/**
|
|
825
|
+
* Format: int32
|
|
826
|
+
* @description The new height.
|
|
827
|
+
*/
|
|
828
|
+
toHeight: number;
|
|
829
|
+
};
|
|
830
|
+
/** @description One release: what prod served from this number on (SPEC.md 21.4). */
|
|
831
|
+
ReleaseDto: {
|
|
832
|
+
/**
|
|
833
|
+
* Format: int32
|
|
834
|
+
* @description The release number, counting up; the highest is prod.
|
|
835
|
+
*/
|
|
836
|
+
number: number;
|
|
837
|
+
/**
|
|
838
|
+
* Format: date-time
|
|
839
|
+
* @description When it went live.
|
|
840
|
+
*/
|
|
841
|
+
createdAt: string;
|
|
842
|
+
/** @description What made it, such as the merged change set or a restore. */
|
|
843
|
+
note: string;
|
|
844
|
+
/** @description The change set it merged, if any. */
|
|
845
|
+
changeSetId?: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* Format: int32
|
|
848
|
+
* @description How many assets it serves.
|
|
849
|
+
*/
|
|
850
|
+
assetCount: number;
|
|
851
|
+
};
|
|
852
|
+
/** @description Brua.Shared.DTOs.ResolveConflictRequest.Keep is "mine" (the change set's version) or "prod". */
|
|
853
|
+
ResolveConflictRequest: {
|
|
854
|
+
/** @description The asset in conflict. */
|
|
855
|
+
asset: string;
|
|
856
|
+
/** @description "mine" or "prod". */
|
|
857
|
+
keep: string;
|
|
858
|
+
};
|
|
859
|
+
/** @description One source file of a version and whether it's uploaded (SPEC.md 9.1); optional slots are per-language extras. */
|
|
860
|
+
SlotDto: {
|
|
861
|
+
/** @description The slot, such as `any.still.source`, `dark.still.source` or `nb.light.still.source`. */
|
|
862
|
+
name: string;
|
|
863
|
+
/** @description "empty" or "uploaded". */
|
|
864
|
+
status: string;
|
|
865
|
+
/** @description The uploaded file's media type. */
|
|
866
|
+
contentType?: string | null;
|
|
867
|
+
/** @description Whether processing waits for this slot. */
|
|
868
|
+
required: boolean;
|
|
869
|
+
};
|
|
870
|
+
/** @description Where to upload a version's source file, with a presigned PUT URL. */
|
|
871
|
+
SourceUploadDto: {
|
|
872
|
+
/** @description PUT the file's bytes here, with its Content-Type; no Brua key is needed. */
|
|
873
|
+
uploadUrl: string;
|
|
874
|
+
/** @description "PUT". */
|
|
875
|
+
method: string;
|
|
876
|
+
/**
|
|
877
|
+
* Format: date-time
|
|
878
|
+
* @description When the URL stops working; ask for a new one after that.
|
|
879
|
+
*/
|
|
880
|
+
expiresAt: string;
|
|
881
|
+
};
|
|
882
|
+
/** @description Body of `POST …/versions/{version}/submit`. */
|
|
883
|
+
SubmitVersionRequest: {
|
|
884
|
+
/** @description The open change set to add the version to; left out, a new one is opened for it. */
|
|
885
|
+
changeSet?: string | null;
|
|
886
|
+
};
|
|
887
|
+
/** @description One version with its alt text, thumbnails and every generated file (Brua.Shared.DTOs.VersionDetailDto.Variants, with delivery URLs).
|
|
888
|
+
* Brua.Shared.DTOs.VersionDetailDto.Preset, Brua.Shared.DTOs.VersionDetailDto.ColorSchemes, Brua.Shared.DTOs.VersionDetailDto.Languages, Brua.Shared.DTOs.VersionDetailDto.Scales and the designed
|
|
889
|
+
* size are the version's own: the next version may change them. Brua.Shared.DTOs.VersionDetailDto.Url is the version's single URL, which
|
|
890
|
+
* the edge negotiates (SPEC.md 5.3). */
|
|
891
|
+
VersionDetailDto: {
|
|
892
|
+
/**
|
|
893
|
+
* Format: int32
|
|
894
|
+
* @description The version number.
|
|
895
|
+
*/
|
|
896
|
+
version: number;
|
|
897
|
+
/** @description "Draft", "Processing", "Ready" or "Failed". */
|
|
898
|
+
status: string;
|
|
899
|
+
/** @description Why processing failed, such as "wrong_proportions". */
|
|
900
|
+
failureCode?: string | null;
|
|
901
|
+
/** @description The failure in words. */
|
|
902
|
+
failureDetail?: string | null;
|
|
903
|
+
/**
|
|
904
|
+
* Format: int32
|
|
905
|
+
* @description The width in CSS pixels, once processed.
|
|
906
|
+
*/
|
|
907
|
+
width?: number | null;
|
|
908
|
+
/**
|
|
909
|
+
* Format: int32
|
|
910
|
+
* @description The height in CSS pixels, once processed.
|
|
911
|
+
*/
|
|
912
|
+
height?: number | null;
|
|
913
|
+
/** @description Whether the version is decorative. */
|
|
914
|
+
decorative: boolean;
|
|
915
|
+
/** @description "match" or "fill". */
|
|
916
|
+
stillFit: string;
|
|
917
|
+
/** @description "flexible", "fixed" or "animated". */
|
|
918
|
+
preset: string;
|
|
919
|
+
/** @description "any", "any-dark" or "both". */
|
|
920
|
+
colorSchemes: string;
|
|
921
|
+
/** @description "none", "optional" or "required". */
|
|
922
|
+
languages: string;
|
|
923
|
+
/** @description "single" or "individual". */
|
|
924
|
+
scales: string;
|
|
925
|
+
/**
|
|
926
|
+
* Format: int32
|
|
927
|
+
* @description The designed width of a fixed or animated version.
|
|
928
|
+
*/
|
|
929
|
+
designWidth?: number | null;
|
|
930
|
+
/**
|
|
931
|
+
* Format: int32
|
|
932
|
+
* @description The designed height of a fixed or animated version.
|
|
933
|
+
*/
|
|
934
|
+
designHeight?: number | null;
|
|
935
|
+
/** @description Alt text per language. */
|
|
936
|
+
alt: {
|
|
937
|
+
[key: string]: string;
|
|
938
|
+
};
|
|
939
|
+
/** @description The media types the version has files in. */
|
|
940
|
+
types: string[];
|
|
941
|
+
/**
|
|
942
|
+
* Format: int32
|
|
943
|
+
* @description How many files were generated.
|
|
944
|
+
*/
|
|
945
|
+
variantCount: number;
|
|
946
|
+
/** @description Thumbnails per scheme and language. */
|
|
947
|
+
previews: components["schemas"]["PreviewDto"][];
|
|
948
|
+
/** @description Every generated file with the conditions it is for. */
|
|
949
|
+
variants: components["schemas"]["AssetVariantDto"][];
|
|
950
|
+
/** @description The version's single URL. */
|
|
951
|
+
url: string;
|
|
952
|
+
};
|
|
953
|
+
};
|
|
954
|
+
responses: never;
|
|
955
|
+
parameters: never;
|
|
956
|
+
requestBodies: never;
|
|
957
|
+
headers: never;
|
|
958
|
+
pathItems: never;
|
|
959
|
+
}
|
|
960
|
+
export type $defs = Record<string, never>;
|
|
961
|
+
export interface operations {
|
|
962
|
+
"ApiKeys.List": {
|
|
963
|
+
parameters: {
|
|
964
|
+
query?: never;
|
|
965
|
+
header?: never;
|
|
966
|
+
path: {
|
|
967
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
968
|
+
project: string;
|
|
969
|
+
};
|
|
970
|
+
cookie?: never;
|
|
971
|
+
};
|
|
972
|
+
requestBody?: never;
|
|
973
|
+
responses: {
|
|
974
|
+
/** @description OK */
|
|
975
|
+
200: {
|
|
976
|
+
headers: {
|
|
977
|
+
[name: string]: unknown;
|
|
978
|
+
};
|
|
979
|
+
content: {
|
|
980
|
+
"application/json": components["schemas"]["ApiKeyDto"][];
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
984
|
+
401: {
|
|
985
|
+
headers: {
|
|
986
|
+
[name: string]: unknown;
|
|
987
|
+
};
|
|
988
|
+
content?: never;
|
|
989
|
+
};
|
|
990
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
991
|
+
403: {
|
|
992
|
+
headers: {
|
|
993
|
+
[name: string]: unknown;
|
|
994
|
+
};
|
|
995
|
+
content: {
|
|
996
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
};
|
|
1001
|
+
"ApiKeys.Create": {
|
|
1002
|
+
parameters: {
|
|
1003
|
+
query?: never;
|
|
1004
|
+
header?: never;
|
|
1005
|
+
path: {
|
|
1006
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1007
|
+
project: string;
|
|
1008
|
+
};
|
|
1009
|
+
cookie?: never;
|
|
1010
|
+
};
|
|
1011
|
+
requestBody?: {
|
|
1012
|
+
content: {
|
|
1013
|
+
"application/json": components["schemas"]["CreateApiKeyRequest"];
|
|
1014
|
+
"text/json": components["schemas"]["CreateApiKeyRequest"];
|
|
1015
|
+
"application/*+json": components["schemas"]["CreateApiKeyRequest"];
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
responses: {
|
|
1019
|
+
/** @description Created */
|
|
1020
|
+
201: {
|
|
1021
|
+
headers: {
|
|
1022
|
+
[name: string]: unknown;
|
|
1023
|
+
};
|
|
1024
|
+
content: {
|
|
1025
|
+
"application/json": components["schemas"]["CreatedApiKeyDto"];
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
1029
|
+
400: {
|
|
1030
|
+
headers: {
|
|
1031
|
+
[name: string]: unknown;
|
|
1032
|
+
};
|
|
1033
|
+
content: {
|
|
1034
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1038
|
+
401: {
|
|
1039
|
+
headers: {
|
|
1040
|
+
[name: string]: unknown;
|
|
1041
|
+
};
|
|
1042
|
+
content?: never;
|
|
1043
|
+
};
|
|
1044
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1045
|
+
403: {
|
|
1046
|
+
headers: {
|
|
1047
|
+
[name: string]: unknown;
|
|
1048
|
+
};
|
|
1049
|
+
content: {
|
|
1050
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
};
|
|
1054
|
+
};
|
|
1055
|
+
"ApiKeys.Revoke": {
|
|
1056
|
+
parameters: {
|
|
1057
|
+
query?: never;
|
|
1058
|
+
header?: never;
|
|
1059
|
+
path: {
|
|
1060
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1061
|
+
project: string;
|
|
1062
|
+
/** @description The key's id. */
|
|
1063
|
+
id: string;
|
|
1064
|
+
};
|
|
1065
|
+
cookie?: never;
|
|
1066
|
+
};
|
|
1067
|
+
requestBody?: never;
|
|
1068
|
+
responses: {
|
|
1069
|
+
/** @description No Content */
|
|
1070
|
+
204: {
|
|
1071
|
+
headers: {
|
|
1072
|
+
[name: string]: unknown;
|
|
1073
|
+
};
|
|
1074
|
+
content?: never;
|
|
1075
|
+
};
|
|
1076
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1077
|
+
401: {
|
|
1078
|
+
headers: {
|
|
1079
|
+
[name: string]: unknown;
|
|
1080
|
+
};
|
|
1081
|
+
content?: never;
|
|
1082
|
+
};
|
|
1083
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1084
|
+
403: {
|
|
1085
|
+
headers: {
|
|
1086
|
+
[name: string]: unknown;
|
|
1087
|
+
};
|
|
1088
|
+
content: {
|
|
1089
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1090
|
+
};
|
|
1091
|
+
};
|
|
1092
|
+
/** @description Not Found */
|
|
1093
|
+
404: {
|
|
1094
|
+
headers: {
|
|
1095
|
+
[name: string]: unknown;
|
|
1096
|
+
};
|
|
1097
|
+
content: {
|
|
1098
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1099
|
+
};
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
};
|
|
1103
|
+
"Assets.List": {
|
|
1104
|
+
parameters: {
|
|
1105
|
+
query?: never;
|
|
1106
|
+
header?: never;
|
|
1107
|
+
path: {
|
|
1108
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1109
|
+
project: string;
|
|
1110
|
+
};
|
|
1111
|
+
cookie?: never;
|
|
1112
|
+
};
|
|
1113
|
+
requestBody?: never;
|
|
1114
|
+
responses: {
|
|
1115
|
+
/** @description OK */
|
|
1116
|
+
200: {
|
|
1117
|
+
headers: {
|
|
1118
|
+
[name: string]: unknown;
|
|
1119
|
+
};
|
|
1120
|
+
content: {
|
|
1121
|
+
"application/json": components["schemas"]["AssetSummaryDto"][];
|
|
1122
|
+
};
|
|
1123
|
+
};
|
|
1124
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1125
|
+
401: {
|
|
1126
|
+
headers: {
|
|
1127
|
+
[name: string]: unknown;
|
|
1128
|
+
};
|
|
1129
|
+
content?: never;
|
|
1130
|
+
};
|
|
1131
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1132
|
+
403: {
|
|
1133
|
+
headers: {
|
|
1134
|
+
[name: string]: unknown;
|
|
1135
|
+
};
|
|
1136
|
+
content: {
|
|
1137
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1138
|
+
};
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
"Assets.Create": {
|
|
1143
|
+
parameters: {
|
|
1144
|
+
query?: never;
|
|
1145
|
+
header?: never;
|
|
1146
|
+
path: {
|
|
1147
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1148
|
+
project: string;
|
|
1149
|
+
};
|
|
1150
|
+
cookie?: never;
|
|
1151
|
+
};
|
|
1152
|
+
requestBody?: {
|
|
1153
|
+
content: {
|
|
1154
|
+
"application/json": components["schemas"]["CreateAssetRequest"];
|
|
1155
|
+
"text/json": components["schemas"]["CreateAssetRequest"];
|
|
1156
|
+
"application/*+json": components["schemas"]["CreateAssetRequest"];
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
responses: {
|
|
1160
|
+
/** @description Created */
|
|
1161
|
+
201: {
|
|
1162
|
+
headers: {
|
|
1163
|
+
[name: string]: unknown;
|
|
1164
|
+
};
|
|
1165
|
+
content: {
|
|
1166
|
+
"application/json": components["schemas"]["AssetVersionDto"];
|
|
1167
|
+
};
|
|
1168
|
+
};
|
|
1169
|
+
/** @description Bad Request */
|
|
1170
|
+
400: {
|
|
1171
|
+
headers: {
|
|
1172
|
+
[name: string]: unknown;
|
|
1173
|
+
};
|
|
1174
|
+
content: {
|
|
1175
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1179
|
+
401: {
|
|
1180
|
+
headers: {
|
|
1181
|
+
[name: string]: unknown;
|
|
1182
|
+
};
|
|
1183
|
+
content?: never;
|
|
1184
|
+
};
|
|
1185
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1186
|
+
403: {
|
|
1187
|
+
headers: {
|
|
1188
|
+
[name: string]: unknown;
|
|
1189
|
+
};
|
|
1190
|
+
content: {
|
|
1191
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
/** @description Conflict */
|
|
1195
|
+
409: {
|
|
1196
|
+
headers: {
|
|
1197
|
+
[name: string]: unknown;
|
|
1198
|
+
};
|
|
1199
|
+
content: {
|
|
1200
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
};
|
|
1204
|
+
};
|
|
1205
|
+
"Assets.Versions": {
|
|
1206
|
+
parameters: {
|
|
1207
|
+
query?: never;
|
|
1208
|
+
header?: never;
|
|
1209
|
+
path: {
|
|
1210
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1211
|
+
project: string;
|
|
1212
|
+
/** @description The asset's id. */
|
|
1213
|
+
id: string;
|
|
1214
|
+
};
|
|
1215
|
+
cookie?: never;
|
|
1216
|
+
};
|
|
1217
|
+
requestBody?: never;
|
|
1218
|
+
responses: {
|
|
1219
|
+
/** @description OK */
|
|
1220
|
+
200: {
|
|
1221
|
+
headers: {
|
|
1222
|
+
[name: string]: unknown;
|
|
1223
|
+
};
|
|
1224
|
+
content: {
|
|
1225
|
+
"application/json": components["schemas"]["AssetDetailDto"];
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1229
|
+
401: {
|
|
1230
|
+
headers: {
|
|
1231
|
+
[name: string]: unknown;
|
|
1232
|
+
};
|
|
1233
|
+
content?: never;
|
|
1234
|
+
};
|
|
1235
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1236
|
+
403: {
|
|
1237
|
+
headers: {
|
|
1238
|
+
[name: string]: unknown;
|
|
1239
|
+
};
|
|
1240
|
+
content: {
|
|
1241
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1242
|
+
};
|
|
1243
|
+
};
|
|
1244
|
+
/** @description Not Found */
|
|
1245
|
+
404: {
|
|
1246
|
+
headers: {
|
|
1247
|
+
[name: string]: unknown;
|
|
1248
|
+
};
|
|
1249
|
+
content: {
|
|
1250
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1251
|
+
};
|
|
1252
|
+
};
|
|
1253
|
+
};
|
|
1254
|
+
};
|
|
1255
|
+
"Assets.CreateVersion": {
|
|
1256
|
+
parameters: {
|
|
1257
|
+
query?: never;
|
|
1258
|
+
header?: never;
|
|
1259
|
+
path: {
|
|
1260
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1261
|
+
project: string;
|
|
1262
|
+
/** @description The asset's id. */
|
|
1263
|
+
id: string;
|
|
1264
|
+
};
|
|
1265
|
+
cookie?: never;
|
|
1266
|
+
};
|
|
1267
|
+
requestBody?: {
|
|
1268
|
+
content: {
|
|
1269
|
+
"application/json": components["schemas"]["CreateVersionRequest"];
|
|
1270
|
+
"text/json": components["schemas"]["CreateVersionRequest"];
|
|
1271
|
+
"application/*+json": components["schemas"]["CreateVersionRequest"];
|
|
1272
|
+
};
|
|
1273
|
+
};
|
|
1274
|
+
responses: {
|
|
1275
|
+
/** @description Created */
|
|
1276
|
+
201: {
|
|
1277
|
+
headers: {
|
|
1278
|
+
[name: string]: unknown;
|
|
1279
|
+
};
|
|
1280
|
+
content: {
|
|
1281
|
+
"application/json": components["schemas"]["AssetVersionDto"];
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
1285
|
+
400: {
|
|
1286
|
+
headers: {
|
|
1287
|
+
[name: string]: unknown;
|
|
1288
|
+
};
|
|
1289
|
+
content: {
|
|
1290
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1291
|
+
};
|
|
1292
|
+
};
|
|
1293
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1294
|
+
401: {
|
|
1295
|
+
headers: {
|
|
1296
|
+
[name: string]: unknown;
|
|
1297
|
+
};
|
|
1298
|
+
content?: never;
|
|
1299
|
+
};
|
|
1300
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1301
|
+
403: {
|
|
1302
|
+
headers: {
|
|
1303
|
+
[name: string]: unknown;
|
|
1304
|
+
};
|
|
1305
|
+
content: {
|
|
1306
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
/** @description Not Found */
|
|
1310
|
+
404: {
|
|
1311
|
+
headers: {
|
|
1312
|
+
[name: string]: unknown;
|
|
1313
|
+
};
|
|
1314
|
+
content: {
|
|
1315
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1316
|
+
};
|
|
1317
|
+
};
|
|
1318
|
+
/** @description Conflict */
|
|
1319
|
+
409: {
|
|
1320
|
+
headers: {
|
|
1321
|
+
[name: string]: unknown;
|
|
1322
|
+
};
|
|
1323
|
+
content: {
|
|
1324
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1325
|
+
};
|
|
1326
|
+
};
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1329
|
+
"Assets.Get": {
|
|
1330
|
+
parameters: {
|
|
1331
|
+
query?: never;
|
|
1332
|
+
header?: {
|
|
1333
|
+
/** @description The languages wanted, in order; the alt text and language-specific files follow the first one the project has (SPEC.md 5.5). */
|
|
1334
|
+
"Accept-Language"?: string;
|
|
1335
|
+
/** @description An open change set's id: the response is the current release with it applied, for previews (SPEC.md 21.3). */
|
|
1336
|
+
"Asset-Change-Set"?: string;
|
|
1337
|
+
};
|
|
1338
|
+
path: {
|
|
1339
|
+
/** @description The project, or one that reads the asset's library. */
|
|
1340
|
+
project: string;
|
|
1341
|
+
/** @description The asset's id. */
|
|
1342
|
+
id: string;
|
|
1343
|
+
};
|
|
1344
|
+
cookie?: never;
|
|
1345
|
+
};
|
|
1346
|
+
requestBody?: never;
|
|
1347
|
+
responses: {
|
|
1348
|
+
/** @description OK */
|
|
1349
|
+
200: {
|
|
1350
|
+
headers: {
|
|
1351
|
+
/** @description The release that answered, such as 12, or shared@3 for a library's asset. */
|
|
1352
|
+
"Asset-Release"?: string;
|
|
1353
|
+
/** @description The language the alt text and files are in. */
|
|
1354
|
+
"Content-Language"?: string;
|
|
1355
|
+
/** @description The request headers the response depends on; cache by them. */
|
|
1356
|
+
Vary?: string;
|
|
1357
|
+
[name: string]: unknown;
|
|
1358
|
+
};
|
|
1359
|
+
content: {
|
|
1360
|
+
"application/json": components["schemas"]["AssetResponse"];
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1364
|
+
401: {
|
|
1365
|
+
headers: {
|
|
1366
|
+
[name: string]: unknown;
|
|
1367
|
+
};
|
|
1368
|
+
content?: never;
|
|
1369
|
+
};
|
|
1370
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1371
|
+
403: {
|
|
1372
|
+
headers: {
|
|
1373
|
+
[name: string]: unknown;
|
|
1374
|
+
};
|
|
1375
|
+
content: {
|
|
1376
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
/** @description Not Found */
|
|
1380
|
+
404: {
|
|
1381
|
+
headers: {
|
|
1382
|
+
[name: string]: unknown;
|
|
1383
|
+
};
|
|
1384
|
+
content: {
|
|
1385
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1386
|
+
};
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
};
|
|
1390
|
+
"Assets.Delete": {
|
|
1391
|
+
parameters: {
|
|
1392
|
+
query?: never;
|
|
1393
|
+
header?: never;
|
|
1394
|
+
path: {
|
|
1395
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1396
|
+
project: string;
|
|
1397
|
+
/** @description The asset's id. */
|
|
1398
|
+
id: string;
|
|
1399
|
+
};
|
|
1400
|
+
cookie?: never;
|
|
1401
|
+
};
|
|
1402
|
+
requestBody?: never;
|
|
1403
|
+
responses: {
|
|
1404
|
+
/** @description No Content */
|
|
1405
|
+
204: {
|
|
1406
|
+
headers: {
|
|
1407
|
+
[name: string]: unknown;
|
|
1408
|
+
};
|
|
1409
|
+
content?: never;
|
|
1410
|
+
};
|
|
1411
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1412
|
+
401: {
|
|
1413
|
+
headers: {
|
|
1414
|
+
[name: string]: unknown;
|
|
1415
|
+
};
|
|
1416
|
+
content?: never;
|
|
1417
|
+
};
|
|
1418
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1419
|
+
403: {
|
|
1420
|
+
headers: {
|
|
1421
|
+
[name: string]: unknown;
|
|
1422
|
+
};
|
|
1423
|
+
content: {
|
|
1424
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1425
|
+
};
|
|
1426
|
+
};
|
|
1427
|
+
/** @description Not Found */
|
|
1428
|
+
404: {
|
|
1429
|
+
headers: {
|
|
1430
|
+
[name: string]: unknown;
|
|
1431
|
+
};
|
|
1432
|
+
content: {
|
|
1433
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
/** @description Conflict */
|
|
1437
|
+
409: {
|
|
1438
|
+
headers: {
|
|
1439
|
+
[name: string]: unknown;
|
|
1440
|
+
};
|
|
1441
|
+
content: {
|
|
1442
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1443
|
+
};
|
|
1444
|
+
};
|
|
1445
|
+
};
|
|
1446
|
+
};
|
|
1447
|
+
"Assets.GetVersion": {
|
|
1448
|
+
parameters: {
|
|
1449
|
+
query?: never;
|
|
1450
|
+
header?: never;
|
|
1451
|
+
path: {
|
|
1452
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1453
|
+
project: string;
|
|
1454
|
+
/** @description The asset's id. */
|
|
1455
|
+
id: string;
|
|
1456
|
+
/** @description The version number, from 1. */
|
|
1457
|
+
version: number;
|
|
1458
|
+
};
|
|
1459
|
+
cookie?: never;
|
|
1460
|
+
};
|
|
1461
|
+
requestBody?: never;
|
|
1462
|
+
responses: {
|
|
1463
|
+
/** @description OK */
|
|
1464
|
+
200: {
|
|
1465
|
+
headers: {
|
|
1466
|
+
[name: string]: unknown;
|
|
1467
|
+
};
|
|
1468
|
+
content: {
|
|
1469
|
+
"application/json": components["schemas"]["AssetVersionDto"];
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1473
|
+
401: {
|
|
1474
|
+
headers: {
|
|
1475
|
+
[name: string]: unknown;
|
|
1476
|
+
};
|
|
1477
|
+
content?: never;
|
|
1478
|
+
};
|
|
1479
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1480
|
+
403: {
|
|
1481
|
+
headers: {
|
|
1482
|
+
[name: string]: unknown;
|
|
1483
|
+
};
|
|
1484
|
+
content: {
|
|
1485
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1486
|
+
};
|
|
1487
|
+
};
|
|
1488
|
+
/** @description Not Found */
|
|
1489
|
+
404: {
|
|
1490
|
+
headers: {
|
|
1491
|
+
[name: string]: unknown;
|
|
1492
|
+
};
|
|
1493
|
+
content: {
|
|
1494
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
};
|
|
1499
|
+
"Assets.DeleteVersion": {
|
|
1500
|
+
parameters: {
|
|
1501
|
+
query?: never;
|
|
1502
|
+
header?: never;
|
|
1503
|
+
path: {
|
|
1504
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1505
|
+
project: string;
|
|
1506
|
+
/** @description The asset's id. */
|
|
1507
|
+
id: string;
|
|
1508
|
+
/** @description The version number, from 1. */
|
|
1509
|
+
version: number;
|
|
1510
|
+
};
|
|
1511
|
+
cookie?: never;
|
|
1512
|
+
};
|
|
1513
|
+
requestBody?: never;
|
|
1514
|
+
responses: {
|
|
1515
|
+
/** @description No Content */
|
|
1516
|
+
204: {
|
|
1517
|
+
headers: {
|
|
1518
|
+
[name: string]: unknown;
|
|
1519
|
+
};
|
|
1520
|
+
content?: never;
|
|
1521
|
+
};
|
|
1522
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1523
|
+
401: {
|
|
1524
|
+
headers: {
|
|
1525
|
+
[name: string]: unknown;
|
|
1526
|
+
};
|
|
1527
|
+
content?: never;
|
|
1528
|
+
};
|
|
1529
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1530
|
+
403: {
|
|
1531
|
+
headers: {
|
|
1532
|
+
[name: string]: unknown;
|
|
1533
|
+
};
|
|
1534
|
+
content: {
|
|
1535
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
/** @description Not Found */
|
|
1539
|
+
404: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1547
|
+
/** @description Conflict */
|
|
1548
|
+
409: {
|
|
1549
|
+
headers: {
|
|
1550
|
+
[name: string]: unknown;
|
|
1551
|
+
};
|
|
1552
|
+
content: {
|
|
1553
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1554
|
+
};
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
};
|
|
1558
|
+
"Assets.RequestSlotUpload": {
|
|
1559
|
+
parameters: {
|
|
1560
|
+
query?: never;
|
|
1561
|
+
header?: never;
|
|
1562
|
+
path: {
|
|
1563
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1564
|
+
project: string;
|
|
1565
|
+
/** @description The asset's id. */
|
|
1566
|
+
id: string;
|
|
1567
|
+
/** @description The version number, from 1. */
|
|
1568
|
+
version: number;
|
|
1569
|
+
/** @description The slot, such as any.still.source, dark.still.source or nb.light.still.source (SPEC.md 9.1). */
|
|
1570
|
+
slot: string;
|
|
1571
|
+
};
|
|
1572
|
+
cookie?: never;
|
|
1573
|
+
};
|
|
1574
|
+
requestBody?: never;
|
|
1575
|
+
responses: {
|
|
1576
|
+
/** @description OK */
|
|
1577
|
+
200: {
|
|
1578
|
+
headers: {
|
|
1579
|
+
[name: string]: unknown;
|
|
1580
|
+
};
|
|
1581
|
+
content: {
|
|
1582
|
+
"application/json": components["schemas"]["SourceUploadDto"];
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1586
|
+
401: {
|
|
1587
|
+
headers: {
|
|
1588
|
+
[name: string]: unknown;
|
|
1589
|
+
};
|
|
1590
|
+
content?: never;
|
|
1591
|
+
};
|
|
1592
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1593
|
+
403: {
|
|
1594
|
+
headers: {
|
|
1595
|
+
[name: string]: unknown;
|
|
1596
|
+
};
|
|
1597
|
+
content: {
|
|
1598
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1599
|
+
};
|
|
1600
|
+
};
|
|
1601
|
+
/** @description Not Found */
|
|
1602
|
+
404: {
|
|
1603
|
+
headers: {
|
|
1604
|
+
[name: string]: unknown;
|
|
1605
|
+
};
|
|
1606
|
+
content: {
|
|
1607
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1608
|
+
};
|
|
1609
|
+
};
|
|
1610
|
+
/** @description Conflict */
|
|
1611
|
+
409: {
|
|
1612
|
+
headers: {
|
|
1613
|
+
[name: string]: unknown;
|
|
1614
|
+
};
|
|
1615
|
+
content: {
|
|
1616
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
};
|
|
1621
|
+
"Assets.CompleteSlotUpload": {
|
|
1622
|
+
parameters: {
|
|
1623
|
+
query?: never;
|
|
1624
|
+
header?: never;
|
|
1625
|
+
path: {
|
|
1626
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1627
|
+
project: string;
|
|
1628
|
+
/** @description The asset's id. */
|
|
1629
|
+
id: string;
|
|
1630
|
+
/** @description The version number, from 1. */
|
|
1631
|
+
version: number;
|
|
1632
|
+
/** @description The slot, such as any.still.source, dark.still.source or nb.light.still.source (SPEC.md 9.1). */
|
|
1633
|
+
slot: string;
|
|
1634
|
+
};
|
|
1635
|
+
cookie?: never;
|
|
1636
|
+
};
|
|
1637
|
+
requestBody?: never;
|
|
1638
|
+
responses: {
|
|
1639
|
+
/** @description Accepted */
|
|
1640
|
+
202: {
|
|
1641
|
+
headers: {
|
|
1642
|
+
[name: string]: unknown;
|
|
1643
|
+
};
|
|
1644
|
+
content: {
|
|
1645
|
+
"application/json": components["schemas"]["AssetVersionDto"];
|
|
1646
|
+
};
|
|
1647
|
+
};
|
|
1648
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1649
|
+
401: {
|
|
1650
|
+
headers: {
|
|
1651
|
+
[name: string]: unknown;
|
|
1652
|
+
};
|
|
1653
|
+
content?: never;
|
|
1654
|
+
};
|
|
1655
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1656
|
+
403: {
|
|
1657
|
+
headers: {
|
|
1658
|
+
[name: string]: unknown;
|
|
1659
|
+
};
|
|
1660
|
+
content: {
|
|
1661
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1662
|
+
};
|
|
1663
|
+
};
|
|
1664
|
+
/** @description Not Found */
|
|
1665
|
+
404: {
|
|
1666
|
+
headers: {
|
|
1667
|
+
[name: string]: unknown;
|
|
1668
|
+
};
|
|
1669
|
+
content: {
|
|
1670
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
/** @description Conflict */
|
|
1674
|
+
409: {
|
|
1675
|
+
headers: {
|
|
1676
|
+
[name: string]: unknown;
|
|
1677
|
+
};
|
|
1678
|
+
content: {
|
|
1679
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1680
|
+
};
|
|
1681
|
+
};
|
|
1682
|
+
};
|
|
1683
|
+
};
|
|
1684
|
+
"Assets.RequestSourceUpload": {
|
|
1685
|
+
parameters: {
|
|
1686
|
+
query?: never;
|
|
1687
|
+
header?: never;
|
|
1688
|
+
path: {
|
|
1689
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1690
|
+
project: string;
|
|
1691
|
+
/** @description The asset's id. */
|
|
1692
|
+
id: string;
|
|
1693
|
+
/** @description The version number, from 1. */
|
|
1694
|
+
version: number;
|
|
1695
|
+
};
|
|
1696
|
+
cookie?: never;
|
|
1697
|
+
};
|
|
1698
|
+
requestBody?: never;
|
|
1699
|
+
responses: {
|
|
1700
|
+
/** @description OK */
|
|
1701
|
+
200: {
|
|
1702
|
+
headers: {
|
|
1703
|
+
[name: string]: unknown;
|
|
1704
|
+
};
|
|
1705
|
+
content: {
|
|
1706
|
+
"application/json": components["schemas"]["SourceUploadDto"];
|
|
1707
|
+
};
|
|
1708
|
+
};
|
|
1709
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1710
|
+
401: {
|
|
1711
|
+
headers: {
|
|
1712
|
+
[name: string]: unknown;
|
|
1713
|
+
};
|
|
1714
|
+
content?: never;
|
|
1715
|
+
};
|
|
1716
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1717
|
+
403: {
|
|
1718
|
+
headers: {
|
|
1719
|
+
[name: string]: unknown;
|
|
1720
|
+
};
|
|
1721
|
+
content: {
|
|
1722
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1723
|
+
};
|
|
1724
|
+
};
|
|
1725
|
+
/** @description Not Found */
|
|
1726
|
+
404: {
|
|
1727
|
+
headers: {
|
|
1728
|
+
[name: string]: unknown;
|
|
1729
|
+
};
|
|
1730
|
+
content: {
|
|
1731
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1732
|
+
};
|
|
1733
|
+
};
|
|
1734
|
+
/** @description Conflict */
|
|
1735
|
+
409: {
|
|
1736
|
+
headers: {
|
|
1737
|
+
[name: string]: unknown;
|
|
1738
|
+
};
|
|
1739
|
+
content: {
|
|
1740
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1741
|
+
};
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
};
|
|
1745
|
+
"Assets.CompleteSourceUpload": {
|
|
1746
|
+
parameters: {
|
|
1747
|
+
query?: never;
|
|
1748
|
+
header?: never;
|
|
1749
|
+
path: {
|
|
1750
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1751
|
+
project: string;
|
|
1752
|
+
/** @description The asset's id. */
|
|
1753
|
+
id: string;
|
|
1754
|
+
/** @description The version number, from 1. */
|
|
1755
|
+
version: number;
|
|
1756
|
+
};
|
|
1757
|
+
cookie?: never;
|
|
1758
|
+
};
|
|
1759
|
+
requestBody?: never;
|
|
1760
|
+
responses: {
|
|
1761
|
+
/** @description Accepted */
|
|
1762
|
+
202: {
|
|
1763
|
+
headers: {
|
|
1764
|
+
[name: string]: unknown;
|
|
1765
|
+
};
|
|
1766
|
+
content: {
|
|
1767
|
+
"application/json": components["schemas"]["AssetVersionDto"];
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1771
|
+
401: {
|
|
1772
|
+
headers: {
|
|
1773
|
+
[name: string]: unknown;
|
|
1774
|
+
};
|
|
1775
|
+
content?: never;
|
|
1776
|
+
};
|
|
1777
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1778
|
+
403: {
|
|
1779
|
+
headers: {
|
|
1780
|
+
[name: string]: unknown;
|
|
1781
|
+
};
|
|
1782
|
+
content: {
|
|
1783
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1784
|
+
};
|
|
1785
|
+
};
|
|
1786
|
+
/** @description Not Found */
|
|
1787
|
+
404: {
|
|
1788
|
+
headers: {
|
|
1789
|
+
[name: string]: unknown;
|
|
1790
|
+
};
|
|
1791
|
+
content: {
|
|
1792
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1793
|
+
};
|
|
1794
|
+
};
|
|
1795
|
+
/** @description Conflict */
|
|
1796
|
+
409: {
|
|
1797
|
+
headers: {
|
|
1798
|
+
[name: string]: unknown;
|
|
1799
|
+
};
|
|
1800
|
+
content: {
|
|
1801
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1802
|
+
};
|
|
1803
|
+
};
|
|
1804
|
+
};
|
|
1805
|
+
};
|
|
1806
|
+
"Assets.SubmitVersion": {
|
|
1807
|
+
parameters: {
|
|
1808
|
+
query?: never;
|
|
1809
|
+
header?: never;
|
|
1810
|
+
path: {
|
|
1811
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1812
|
+
project: string;
|
|
1813
|
+
/** @description The asset's id. */
|
|
1814
|
+
id: string;
|
|
1815
|
+
/** @description The version number, from 1. */
|
|
1816
|
+
version: number;
|
|
1817
|
+
};
|
|
1818
|
+
cookie?: never;
|
|
1819
|
+
};
|
|
1820
|
+
requestBody?: {
|
|
1821
|
+
content: {
|
|
1822
|
+
"application/json": components["schemas"]["SubmitVersionRequest"];
|
|
1823
|
+
"text/json": components["schemas"]["SubmitVersionRequest"];
|
|
1824
|
+
"application/*+json": components["schemas"]["SubmitVersionRequest"];
|
|
1825
|
+
};
|
|
1826
|
+
};
|
|
1827
|
+
responses: {
|
|
1828
|
+
/** @description OK */
|
|
1829
|
+
200: {
|
|
1830
|
+
headers: {
|
|
1831
|
+
[name: string]: unknown;
|
|
1832
|
+
};
|
|
1833
|
+
content: {
|
|
1834
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
1835
|
+
};
|
|
1836
|
+
};
|
|
1837
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
1838
|
+
400: {
|
|
1839
|
+
headers: {
|
|
1840
|
+
[name: string]: unknown;
|
|
1841
|
+
};
|
|
1842
|
+
content: {
|
|
1843
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1844
|
+
};
|
|
1845
|
+
};
|
|
1846
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1847
|
+
401: {
|
|
1848
|
+
headers: {
|
|
1849
|
+
[name: string]: unknown;
|
|
1850
|
+
};
|
|
1851
|
+
content?: never;
|
|
1852
|
+
};
|
|
1853
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1854
|
+
403: {
|
|
1855
|
+
headers: {
|
|
1856
|
+
[name: string]: unknown;
|
|
1857
|
+
};
|
|
1858
|
+
content: {
|
|
1859
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
/** @description Not Found */
|
|
1863
|
+
404: {
|
|
1864
|
+
headers: {
|
|
1865
|
+
[name: string]: unknown;
|
|
1866
|
+
};
|
|
1867
|
+
content: {
|
|
1868
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
/** @description Conflict */
|
|
1872
|
+
409: {
|
|
1873
|
+
headers: {
|
|
1874
|
+
[name: string]: unknown;
|
|
1875
|
+
};
|
|
1876
|
+
content: {
|
|
1877
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1878
|
+
};
|
|
1879
|
+
};
|
|
1880
|
+
};
|
|
1881
|
+
};
|
|
1882
|
+
"ChangeSets.List": {
|
|
1883
|
+
parameters: {
|
|
1884
|
+
query?: never;
|
|
1885
|
+
header?: never;
|
|
1886
|
+
path: {
|
|
1887
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1888
|
+
project: string;
|
|
1889
|
+
};
|
|
1890
|
+
cookie?: never;
|
|
1891
|
+
};
|
|
1892
|
+
requestBody?: never;
|
|
1893
|
+
responses: {
|
|
1894
|
+
/** @description OK */
|
|
1895
|
+
200: {
|
|
1896
|
+
headers: {
|
|
1897
|
+
[name: string]: unknown;
|
|
1898
|
+
};
|
|
1899
|
+
content: {
|
|
1900
|
+
"application/json": components["schemas"]["ChangeSetDto"][];
|
|
1901
|
+
};
|
|
1902
|
+
};
|
|
1903
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1904
|
+
401: {
|
|
1905
|
+
headers: {
|
|
1906
|
+
[name: string]: unknown;
|
|
1907
|
+
};
|
|
1908
|
+
content?: never;
|
|
1909
|
+
};
|
|
1910
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1911
|
+
403: {
|
|
1912
|
+
headers: {
|
|
1913
|
+
[name: string]: unknown;
|
|
1914
|
+
};
|
|
1915
|
+
content: {
|
|
1916
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1917
|
+
};
|
|
1918
|
+
};
|
|
1919
|
+
};
|
|
1920
|
+
};
|
|
1921
|
+
"ChangeSets.Create": {
|
|
1922
|
+
parameters: {
|
|
1923
|
+
query?: never;
|
|
1924
|
+
header?: never;
|
|
1925
|
+
path: {
|
|
1926
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1927
|
+
project: string;
|
|
1928
|
+
};
|
|
1929
|
+
cookie?: never;
|
|
1930
|
+
};
|
|
1931
|
+
requestBody?: {
|
|
1932
|
+
content: {
|
|
1933
|
+
"application/json": components["schemas"]["CreateChangeSetRequest"];
|
|
1934
|
+
"text/json": components["schemas"]["CreateChangeSetRequest"];
|
|
1935
|
+
"application/*+json": components["schemas"]["CreateChangeSetRequest"];
|
|
1936
|
+
};
|
|
1937
|
+
};
|
|
1938
|
+
responses: {
|
|
1939
|
+
/** @description Created */
|
|
1940
|
+
201: {
|
|
1941
|
+
headers: {
|
|
1942
|
+
[name: string]: unknown;
|
|
1943
|
+
};
|
|
1944
|
+
content: {
|
|
1945
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
1946
|
+
};
|
|
1947
|
+
};
|
|
1948
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
1949
|
+
400: {
|
|
1950
|
+
headers: {
|
|
1951
|
+
[name: string]: unknown;
|
|
1952
|
+
};
|
|
1953
|
+
content: {
|
|
1954
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1955
|
+
};
|
|
1956
|
+
};
|
|
1957
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1958
|
+
401: {
|
|
1959
|
+
headers: {
|
|
1960
|
+
[name: string]: unknown;
|
|
1961
|
+
};
|
|
1962
|
+
content?: never;
|
|
1963
|
+
};
|
|
1964
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
1965
|
+
403: {
|
|
1966
|
+
headers: {
|
|
1967
|
+
[name: string]: unknown;
|
|
1968
|
+
};
|
|
1969
|
+
content: {
|
|
1970
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
1971
|
+
};
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
"ChangeSets.Get": {
|
|
1976
|
+
parameters: {
|
|
1977
|
+
query?: never;
|
|
1978
|
+
header?: never;
|
|
1979
|
+
path: {
|
|
1980
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
1981
|
+
project: string;
|
|
1982
|
+
/** @description The change set's id. */
|
|
1983
|
+
id: string;
|
|
1984
|
+
};
|
|
1985
|
+
cookie?: never;
|
|
1986
|
+
};
|
|
1987
|
+
requestBody?: never;
|
|
1988
|
+
responses: {
|
|
1989
|
+
/** @description OK */
|
|
1990
|
+
200: {
|
|
1991
|
+
headers: {
|
|
1992
|
+
[name: string]: unknown;
|
|
1993
|
+
};
|
|
1994
|
+
content: {
|
|
1995
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
1999
|
+
401: {
|
|
2000
|
+
headers: {
|
|
2001
|
+
[name: string]: unknown;
|
|
2002
|
+
};
|
|
2003
|
+
content?: never;
|
|
2004
|
+
};
|
|
2005
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2006
|
+
403: {
|
|
2007
|
+
headers: {
|
|
2008
|
+
[name: string]: unknown;
|
|
2009
|
+
};
|
|
2010
|
+
content: {
|
|
2011
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2012
|
+
};
|
|
2013
|
+
};
|
|
2014
|
+
/** @description Not Found */
|
|
2015
|
+
404: {
|
|
2016
|
+
headers: {
|
|
2017
|
+
[name: string]: unknown;
|
|
2018
|
+
};
|
|
2019
|
+
content: {
|
|
2020
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
"ChangeSets.Delete": {
|
|
2026
|
+
parameters: {
|
|
2027
|
+
query?: never;
|
|
2028
|
+
header?: never;
|
|
2029
|
+
path: {
|
|
2030
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2031
|
+
project: string;
|
|
2032
|
+
/** @description The change set's id. */
|
|
2033
|
+
id: string;
|
|
2034
|
+
};
|
|
2035
|
+
cookie?: never;
|
|
2036
|
+
};
|
|
2037
|
+
requestBody?: never;
|
|
2038
|
+
responses: {
|
|
2039
|
+
/** @description No Content */
|
|
2040
|
+
204: {
|
|
2041
|
+
headers: {
|
|
2042
|
+
[name: string]: unknown;
|
|
2043
|
+
};
|
|
2044
|
+
content?: never;
|
|
2045
|
+
};
|
|
2046
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2047
|
+
401: {
|
|
2048
|
+
headers: {
|
|
2049
|
+
[name: string]: unknown;
|
|
2050
|
+
};
|
|
2051
|
+
content?: never;
|
|
2052
|
+
};
|
|
2053
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2054
|
+
403: {
|
|
2055
|
+
headers: {
|
|
2056
|
+
[name: string]: unknown;
|
|
2057
|
+
};
|
|
2058
|
+
content: {
|
|
2059
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2060
|
+
};
|
|
2061
|
+
};
|
|
2062
|
+
/** @description Not Found */
|
|
2063
|
+
404: {
|
|
2064
|
+
headers: {
|
|
2065
|
+
[name: string]: unknown;
|
|
2066
|
+
};
|
|
2067
|
+
content: {
|
|
2068
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2069
|
+
};
|
|
2070
|
+
};
|
|
2071
|
+
/** @description Conflict */
|
|
2072
|
+
409: {
|
|
2073
|
+
headers: {
|
|
2074
|
+
[name: string]: unknown;
|
|
2075
|
+
};
|
|
2076
|
+
content: {
|
|
2077
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2078
|
+
};
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
2081
|
+
};
|
|
2082
|
+
"ChangeSets.AddChange": {
|
|
2083
|
+
parameters: {
|
|
2084
|
+
query?: never;
|
|
2085
|
+
header?: never;
|
|
2086
|
+
path: {
|
|
2087
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2088
|
+
project: string;
|
|
2089
|
+
/** @description The change set's id. */
|
|
2090
|
+
id: string;
|
|
2091
|
+
};
|
|
2092
|
+
cookie?: never;
|
|
2093
|
+
};
|
|
2094
|
+
requestBody?: {
|
|
2095
|
+
content: {
|
|
2096
|
+
"application/json": components["schemas"]["AddChangeRequest"];
|
|
2097
|
+
"text/json": components["schemas"]["AddChangeRequest"];
|
|
2098
|
+
"application/*+json": components["schemas"]["AddChangeRequest"];
|
|
2099
|
+
};
|
|
2100
|
+
};
|
|
2101
|
+
responses: {
|
|
2102
|
+
/** @description OK */
|
|
2103
|
+
200: {
|
|
2104
|
+
headers: {
|
|
2105
|
+
[name: string]: unknown;
|
|
2106
|
+
};
|
|
2107
|
+
content: {
|
|
2108
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2109
|
+
};
|
|
2110
|
+
};
|
|
2111
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
2112
|
+
400: {
|
|
2113
|
+
headers: {
|
|
2114
|
+
[name: string]: unknown;
|
|
2115
|
+
};
|
|
2116
|
+
content: {
|
|
2117
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2118
|
+
};
|
|
2119
|
+
};
|
|
2120
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2121
|
+
401: {
|
|
2122
|
+
headers: {
|
|
2123
|
+
[name: string]: unknown;
|
|
2124
|
+
};
|
|
2125
|
+
content?: never;
|
|
2126
|
+
};
|
|
2127
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2128
|
+
403: {
|
|
2129
|
+
headers: {
|
|
2130
|
+
[name: string]: unknown;
|
|
2131
|
+
};
|
|
2132
|
+
content: {
|
|
2133
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2134
|
+
};
|
|
2135
|
+
};
|
|
2136
|
+
/** @description Not Found */
|
|
2137
|
+
404: {
|
|
2138
|
+
headers: {
|
|
2139
|
+
[name: string]: unknown;
|
|
2140
|
+
};
|
|
2141
|
+
content: {
|
|
2142
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2143
|
+
};
|
|
2144
|
+
};
|
|
2145
|
+
/** @description Conflict */
|
|
2146
|
+
409: {
|
|
2147
|
+
headers: {
|
|
2148
|
+
[name: string]: unknown;
|
|
2149
|
+
};
|
|
2150
|
+
content: {
|
|
2151
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2152
|
+
};
|
|
2153
|
+
};
|
|
2154
|
+
};
|
|
2155
|
+
};
|
|
2156
|
+
"ChangeSets.Submit": {
|
|
2157
|
+
parameters: {
|
|
2158
|
+
query?: never;
|
|
2159
|
+
header?: never;
|
|
2160
|
+
path: {
|
|
2161
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2162
|
+
project: string;
|
|
2163
|
+
/** @description The change set's id. */
|
|
2164
|
+
id: string;
|
|
2165
|
+
};
|
|
2166
|
+
cookie?: never;
|
|
2167
|
+
};
|
|
2168
|
+
requestBody?: never;
|
|
2169
|
+
responses: {
|
|
2170
|
+
/** @description OK */
|
|
2171
|
+
200: {
|
|
2172
|
+
headers: {
|
|
2173
|
+
[name: string]: unknown;
|
|
2174
|
+
};
|
|
2175
|
+
content: {
|
|
2176
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2180
|
+
401: {
|
|
2181
|
+
headers: {
|
|
2182
|
+
[name: string]: unknown;
|
|
2183
|
+
};
|
|
2184
|
+
content?: never;
|
|
2185
|
+
};
|
|
2186
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2187
|
+
403: {
|
|
2188
|
+
headers: {
|
|
2189
|
+
[name: string]: unknown;
|
|
2190
|
+
};
|
|
2191
|
+
content: {
|
|
2192
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2193
|
+
};
|
|
2194
|
+
};
|
|
2195
|
+
/** @description Not Found */
|
|
2196
|
+
404: {
|
|
2197
|
+
headers: {
|
|
2198
|
+
[name: string]: unknown;
|
|
2199
|
+
};
|
|
2200
|
+
content: {
|
|
2201
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
/** @description Conflict */
|
|
2205
|
+
409: {
|
|
2206
|
+
headers: {
|
|
2207
|
+
[name: string]: unknown;
|
|
2208
|
+
};
|
|
2209
|
+
content: {
|
|
2210
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2211
|
+
};
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
};
|
|
2215
|
+
"ChangeSets.Approve": {
|
|
2216
|
+
parameters: {
|
|
2217
|
+
query?: never;
|
|
2218
|
+
header?: never;
|
|
2219
|
+
path: {
|
|
2220
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2221
|
+
project: string;
|
|
2222
|
+
/** @description The change set's id. */
|
|
2223
|
+
id: string;
|
|
2224
|
+
};
|
|
2225
|
+
cookie?: never;
|
|
2226
|
+
};
|
|
2227
|
+
requestBody?: never;
|
|
2228
|
+
responses: {
|
|
2229
|
+
/** @description OK */
|
|
2230
|
+
200: {
|
|
2231
|
+
headers: {
|
|
2232
|
+
[name: string]: unknown;
|
|
2233
|
+
};
|
|
2234
|
+
content: {
|
|
2235
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2236
|
+
};
|
|
2237
|
+
};
|
|
2238
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2239
|
+
401: {
|
|
2240
|
+
headers: {
|
|
2241
|
+
[name: string]: unknown;
|
|
2242
|
+
};
|
|
2243
|
+
content?: never;
|
|
2244
|
+
};
|
|
2245
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2246
|
+
403: {
|
|
2247
|
+
headers: {
|
|
2248
|
+
[name: string]: unknown;
|
|
2249
|
+
};
|
|
2250
|
+
content: {
|
|
2251
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2252
|
+
};
|
|
2253
|
+
};
|
|
2254
|
+
/** @description Not Found */
|
|
2255
|
+
404: {
|
|
2256
|
+
headers: {
|
|
2257
|
+
[name: string]: unknown;
|
|
2258
|
+
};
|
|
2259
|
+
content: {
|
|
2260
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2261
|
+
};
|
|
2262
|
+
};
|
|
2263
|
+
/** @description Conflict */
|
|
2264
|
+
409: {
|
|
2265
|
+
headers: {
|
|
2266
|
+
[name: string]: unknown;
|
|
2267
|
+
};
|
|
2268
|
+
content: {
|
|
2269
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
};
|
|
2274
|
+
"ChangeSets.Merge": {
|
|
2275
|
+
parameters: {
|
|
2276
|
+
query?: never;
|
|
2277
|
+
header?: never;
|
|
2278
|
+
path: {
|
|
2279
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2280
|
+
project: string;
|
|
2281
|
+
/** @description The change set's id. */
|
|
2282
|
+
id: string;
|
|
2283
|
+
};
|
|
2284
|
+
cookie?: never;
|
|
2285
|
+
};
|
|
2286
|
+
requestBody?: {
|
|
2287
|
+
content: {
|
|
2288
|
+
"application/json": components["schemas"]["MergeRequest"];
|
|
2289
|
+
"text/json": components["schemas"]["MergeRequest"];
|
|
2290
|
+
"application/*+json": components["schemas"]["MergeRequest"];
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
2293
|
+
responses: {
|
|
2294
|
+
/** @description OK */
|
|
2295
|
+
200: {
|
|
2296
|
+
headers: {
|
|
2297
|
+
[name: string]: unknown;
|
|
2298
|
+
};
|
|
2299
|
+
content: {
|
|
2300
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
2304
|
+
400: {
|
|
2305
|
+
headers: {
|
|
2306
|
+
[name: string]: unknown;
|
|
2307
|
+
};
|
|
2308
|
+
content: {
|
|
2309
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2313
|
+
401: {
|
|
2314
|
+
headers: {
|
|
2315
|
+
[name: string]: unknown;
|
|
2316
|
+
};
|
|
2317
|
+
content?: never;
|
|
2318
|
+
};
|
|
2319
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2320
|
+
403: {
|
|
2321
|
+
headers: {
|
|
2322
|
+
[name: string]: unknown;
|
|
2323
|
+
};
|
|
2324
|
+
content: {
|
|
2325
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2326
|
+
};
|
|
2327
|
+
};
|
|
2328
|
+
/** @description Not Found */
|
|
2329
|
+
404: {
|
|
2330
|
+
headers: {
|
|
2331
|
+
[name: string]: unknown;
|
|
2332
|
+
};
|
|
2333
|
+
content: {
|
|
2334
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2335
|
+
};
|
|
2336
|
+
};
|
|
2337
|
+
/** @description Conflict */
|
|
2338
|
+
409: {
|
|
2339
|
+
headers: {
|
|
2340
|
+
[name: string]: unknown;
|
|
2341
|
+
};
|
|
2342
|
+
content: {
|
|
2343
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2344
|
+
};
|
|
2345
|
+
};
|
|
2346
|
+
};
|
|
2347
|
+
};
|
|
2348
|
+
"ChangeSets.Withdraw": {
|
|
2349
|
+
parameters: {
|
|
2350
|
+
query?: never;
|
|
2351
|
+
header?: never;
|
|
2352
|
+
path: {
|
|
2353
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2354
|
+
project: string;
|
|
2355
|
+
/** @description The change set's id. */
|
|
2356
|
+
id: string;
|
|
2357
|
+
};
|
|
2358
|
+
cookie?: never;
|
|
2359
|
+
};
|
|
2360
|
+
requestBody?: never;
|
|
2361
|
+
responses: {
|
|
2362
|
+
/** @description OK */
|
|
2363
|
+
200: {
|
|
2364
|
+
headers: {
|
|
2365
|
+
[name: string]: unknown;
|
|
2366
|
+
};
|
|
2367
|
+
content: {
|
|
2368
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2369
|
+
};
|
|
2370
|
+
};
|
|
2371
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2372
|
+
401: {
|
|
2373
|
+
headers: {
|
|
2374
|
+
[name: string]: unknown;
|
|
2375
|
+
};
|
|
2376
|
+
content?: never;
|
|
2377
|
+
};
|
|
2378
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2379
|
+
403: {
|
|
2380
|
+
headers: {
|
|
2381
|
+
[name: string]: unknown;
|
|
2382
|
+
};
|
|
2383
|
+
content: {
|
|
2384
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2385
|
+
};
|
|
2386
|
+
};
|
|
2387
|
+
/** @description Not Found */
|
|
2388
|
+
404: {
|
|
2389
|
+
headers: {
|
|
2390
|
+
[name: string]: unknown;
|
|
2391
|
+
};
|
|
2392
|
+
content: {
|
|
2393
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2396
|
+
/** @description Conflict */
|
|
2397
|
+
409: {
|
|
2398
|
+
headers: {
|
|
2399
|
+
[name: string]: unknown;
|
|
2400
|
+
};
|
|
2401
|
+
content: {
|
|
2402
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2403
|
+
};
|
|
2404
|
+
};
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
"ChangeSets.Resolve": {
|
|
2408
|
+
parameters: {
|
|
2409
|
+
query?: never;
|
|
2410
|
+
header?: never;
|
|
2411
|
+
path: {
|
|
2412
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2413
|
+
project: string;
|
|
2414
|
+
/** @description The change set's id. */
|
|
2415
|
+
id: string;
|
|
2416
|
+
};
|
|
2417
|
+
cookie?: never;
|
|
2418
|
+
};
|
|
2419
|
+
requestBody?: {
|
|
2420
|
+
content: {
|
|
2421
|
+
"application/json": components["schemas"]["ResolveConflictRequest"];
|
|
2422
|
+
"text/json": components["schemas"]["ResolveConflictRequest"];
|
|
2423
|
+
"application/*+json": components["schemas"]["ResolveConflictRequest"];
|
|
2424
|
+
};
|
|
2425
|
+
};
|
|
2426
|
+
responses: {
|
|
2427
|
+
/** @description OK */
|
|
2428
|
+
200: {
|
|
2429
|
+
headers: {
|
|
2430
|
+
[name: string]: unknown;
|
|
2431
|
+
};
|
|
2432
|
+
content: {
|
|
2433
|
+
"application/json": components["schemas"]["ChangeSetDto"];
|
|
2434
|
+
};
|
|
2435
|
+
};
|
|
2436
|
+
/** @description The body is invalid: `validation_failed`, with the messages per field in `errors`. */
|
|
2437
|
+
400: {
|
|
2438
|
+
headers: {
|
|
2439
|
+
[name: string]: unknown;
|
|
2440
|
+
};
|
|
2441
|
+
content: {
|
|
2442
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2443
|
+
};
|
|
2444
|
+
};
|
|
2445
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2446
|
+
401: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content?: never;
|
|
2451
|
+
};
|
|
2452
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2453
|
+
403: {
|
|
2454
|
+
headers: {
|
|
2455
|
+
[name: string]: unknown;
|
|
2456
|
+
};
|
|
2457
|
+
content: {
|
|
2458
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2459
|
+
};
|
|
2460
|
+
};
|
|
2461
|
+
/** @description Not Found */
|
|
2462
|
+
404: {
|
|
2463
|
+
headers: {
|
|
2464
|
+
[name: string]: unknown;
|
|
2465
|
+
};
|
|
2466
|
+
content: {
|
|
2467
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2468
|
+
};
|
|
2469
|
+
};
|
|
2470
|
+
/** @description Conflict */
|
|
2471
|
+
409: {
|
|
2472
|
+
headers: {
|
|
2473
|
+
[name: string]: unknown;
|
|
2474
|
+
};
|
|
2475
|
+
content: {
|
|
2476
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2477
|
+
};
|
|
2478
|
+
};
|
|
2479
|
+
};
|
|
2480
|
+
};
|
|
2481
|
+
"Projects.Get": {
|
|
2482
|
+
parameters: {
|
|
2483
|
+
query?: never;
|
|
2484
|
+
header?: never;
|
|
2485
|
+
path: {
|
|
2486
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2487
|
+
project: string;
|
|
2488
|
+
};
|
|
2489
|
+
cookie?: never;
|
|
2490
|
+
};
|
|
2491
|
+
requestBody?: never;
|
|
2492
|
+
responses: {
|
|
2493
|
+
/** @description OK */
|
|
2494
|
+
200: {
|
|
2495
|
+
headers: {
|
|
2496
|
+
[name: string]: unknown;
|
|
2497
|
+
};
|
|
2498
|
+
content: {
|
|
2499
|
+
"application/json": components["schemas"]["ProjectDto"];
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2503
|
+
401: {
|
|
2504
|
+
headers: {
|
|
2505
|
+
[name: string]: unknown;
|
|
2506
|
+
};
|
|
2507
|
+
content?: never;
|
|
2508
|
+
};
|
|
2509
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2510
|
+
403: {
|
|
2511
|
+
headers: {
|
|
2512
|
+
[name: string]: unknown;
|
|
2513
|
+
};
|
|
2514
|
+
content: {
|
|
2515
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2516
|
+
};
|
|
2517
|
+
};
|
|
2518
|
+
/** @description Not Found */
|
|
2519
|
+
404: {
|
|
2520
|
+
headers: {
|
|
2521
|
+
[name: string]: unknown;
|
|
2522
|
+
};
|
|
2523
|
+
content: {
|
|
2524
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2525
|
+
};
|
|
2526
|
+
};
|
|
2527
|
+
};
|
|
2528
|
+
};
|
|
2529
|
+
"Releases.List": {
|
|
2530
|
+
parameters: {
|
|
2531
|
+
query?: never;
|
|
2532
|
+
header?: never;
|
|
2533
|
+
path: {
|
|
2534
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2535
|
+
project: string;
|
|
2536
|
+
};
|
|
2537
|
+
cookie?: never;
|
|
2538
|
+
};
|
|
2539
|
+
requestBody?: never;
|
|
2540
|
+
responses: {
|
|
2541
|
+
/** @description OK */
|
|
2542
|
+
200: {
|
|
2543
|
+
headers: {
|
|
2544
|
+
[name: string]: unknown;
|
|
2545
|
+
};
|
|
2546
|
+
content: {
|
|
2547
|
+
"application/json": components["schemas"]["ReleaseDto"][];
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2551
|
+
401: {
|
|
2552
|
+
headers: {
|
|
2553
|
+
[name: string]: unknown;
|
|
2554
|
+
};
|
|
2555
|
+
content?: never;
|
|
2556
|
+
};
|
|
2557
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2558
|
+
403: {
|
|
2559
|
+
headers: {
|
|
2560
|
+
[name: string]: unknown;
|
|
2561
|
+
};
|
|
2562
|
+
content: {
|
|
2563
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2564
|
+
};
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
};
|
|
2568
|
+
"Releases.Restore": {
|
|
2569
|
+
parameters: {
|
|
2570
|
+
query?: never;
|
|
2571
|
+
header?: never;
|
|
2572
|
+
path: {
|
|
2573
|
+
/** @description The project's id, as in its URLs in the back office; a project also reads its organization's libraries through its own id. */
|
|
2574
|
+
project: string;
|
|
2575
|
+
/** @description The release number. */
|
|
2576
|
+
number: number;
|
|
2577
|
+
};
|
|
2578
|
+
cookie?: never;
|
|
2579
|
+
};
|
|
2580
|
+
requestBody?: never;
|
|
2581
|
+
responses: {
|
|
2582
|
+
/** @description OK */
|
|
2583
|
+
200: {
|
|
2584
|
+
headers: {
|
|
2585
|
+
[name: string]: unknown;
|
|
2586
|
+
};
|
|
2587
|
+
content: {
|
|
2588
|
+
"application/json": components["schemas"]["ReleaseDto"];
|
|
2589
|
+
};
|
|
2590
|
+
};
|
|
2591
|
+
/** @description No key or token, or an invalid or revoked one. */
|
|
2592
|
+
401: {
|
|
2593
|
+
headers: {
|
|
2594
|
+
[name: string]: unknown;
|
|
2595
|
+
};
|
|
2596
|
+
content?: never;
|
|
2597
|
+
};
|
|
2598
|
+
/** @description The key lacks the scope, or the person has no role in the project that allows this; with a body when a rule refused it, such as `owners_only`. */
|
|
2599
|
+
403: {
|
|
2600
|
+
headers: {
|
|
2601
|
+
[name: string]: unknown;
|
|
2602
|
+
};
|
|
2603
|
+
content: {
|
|
2604
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2605
|
+
};
|
|
2606
|
+
};
|
|
2607
|
+
/** @description Not Found */
|
|
2608
|
+
404: {
|
|
2609
|
+
headers: {
|
|
2610
|
+
[name: string]: unknown;
|
|
2611
|
+
};
|
|
2612
|
+
content: {
|
|
2613
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
};
|
|
2617
|
+
};
|
|
2618
|
+
}
|