@uniformdev/assets 20.75.1-alpha.16 → 20.76.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +396 -396
- package/dist/index.d.ts +396 -396
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
|
@@ -3,26 +3,26 @@ import { XOR } from 'ts-xor';
|
|
|
3
3
|
|
|
4
4
|
interface components$1 {
|
|
5
5
|
schemas: {
|
|
6
|
-
/**
|
|
6
|
+
/** Public ID (used in code). Do not change after creation */
|
|
7
7
|
PublicIdProperty: string;
|
|
8
|
-
/**
|
|
8
|
+
/** The definition of a component parameter */
|
|
9
9
|
ComponentDefinitionParameter: {
|
|
10
10
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
11
|
-
/**
|
|
11
|
+
/** Friendly name of the parameter */
|
|
12
12
|
name: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Appears next to the parameter in the Composition editor */
|
|
14
14
|
helpText?: string;
|
|
15
|
-
/**
|
|
15
|
+
/** Context provided to AI when generating content for this parameter. May also be shown to humans. */
|
|
16
16
|
guidance?: string;
|
|
17
|
-
/**
|
|
17
|
+
/** Type name of the parameter (provided by a Uniform integration) */
|
|
18
18
|
type: string;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* If true, this property can have locale-specific values. If false or not defined,
|
|
21
21
|
* this property will have a single value that is shared for all locales
|
|
22
22
|
*/
|
|
23
23
|
localizable?: boolean;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* When `localizable` is true, this property controls the default localizability of the property.
|
|
26
26
|
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
27
27
|
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
28
28
|
*
|
|
@@ -30,242 +30,242 @@ interface components$1 {
|
|
|
30
30
|
*/
|
|
31
31
|
notLocalizedByDefault?: boolean;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
34
34
|
* When combined with a localized value, each locale has independent conditional values.
|
|
35
35
|
*
|
|
36
36
|
* When not defined, conditional values are not allowed.
|
|
37
37
|
*/
|
|
38
38
|
allowConditionalValues?: boolean;
|
|
39
|
-
/**
|
|
39
|
+
/** The configuration object for the type (type-specific) */
|
|
40
40
|
typeConfig?: unknown;
|
|
41
41
|
};
|
|
42
|
-
/**
|
|
42
|
+
/** The definition of a named component slot that can contain other components */
|
|
43
43
|
ComponentDefinitionSlot: {
|
|
44
44
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
45
|
-
/**
|
|
45
|
+
/** Friendly name of the slot */
|
|
46
46
|
name: string;
|
|
47
|
-
/**
|
|
47
|
+
/** A list of component definition public IDs that are allowed in this named slot */
|
|
48
48
|
allowedComponents: string[];
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
51
51
|
* If `allowAllComponents` is true, this value is ignored
|
|
52
|
-
* @
|
|
52
|
+
* @defaultValue false
|
|
53
53
|
*/
|
|
54
54
|
inheritAllowedComponents: boolean;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* When false or not defined, only components in `allowedComponents` may be added to this slot - and if `allowedComponents` is empty, nothing can be added.
|
|
57
57
|
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
58
58
|
*/
|
|
59
59
|
allowAllComponents?: boolean;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
62
62
|
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
63
63
|
*/
|
|
64
64
|
patternsInAllowedComponents?: boolean;
|
|
65
|
-
/**
|
|
65
|
+
/** Minimum valid number of components in this slot */
|
|
66
66
|
minComponents?: number;
|
|
67
|
-
/**
|
|
67
|
+
/** Maximum valid number of components in this slot */
|
|
68
68
|
maxComponents?: number;
|
|
69
69
|
};
|
|
70
|
-
/**
|
|
70
|
+
/** The definition of a composition's slug settings */
|
|
71
71
|
ComponentDefinitionSlugSettings: {
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Whether the slug is required
|
|
74
74
|
* no: slug is optional
|
|
75
75
|
* yes: slug is required
|
|
76
76
|
* disabled: slug is disabled and will not be shown in the editor
|
|
77
|
-
* @
|
|
78
|
-
|
|
77
|
+
* @defaultValue no
|
|
78
|
+
|
|
79
79
|
*/
|
|
80
80
|
required?: "no" | "yes" | "disabled";
|
|
81
81
|
/**
|
|
82
|
-
*
|
|
82
|
+
* Slug uniqueness configuration.
|
|
83
83
|
* no = no unique constraint
|
|
84
84
|
* local = must be unique within this component type
|
|
85
85
|
* global = must be unique across all component types
|
|
86
|
-
|
|
86
|
+
|
|
87
87
|
*/
|
|
88
88
|
unique?: "no" | "local" | "global";
|
|
89
|
-
/**
|
|
89
|
+
/** Regular expression slugs must match */
|
|
90
90
|
regularExpression?: string;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* Custom error message when regular expression validation fails.
|
|
93
93
|
* Has no effect if `regularExpression` is not set
|
|
94
94
|
*/
|
|
95
95
|
regularExpressionMessage?: string;
|
|
96
96
|
};
|
|
97
|
-
/**
|
|
97
|
+
/** The definition of a component variant */
|
|
98
98
|
ComponentDefinitionVariant: {
|
|
99
99
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
100
|
-
/**
|
|
100
|
+
/** Friendly name of the variant */
|
|
101
101
|
name: string;
|
|
102
102
|
};
|
|
103
|
-
/**
|
|
103
|
+
/** Permission set for a component definition */
|
|
104
104
|
ComponentDefinitionPermission: {
|
|
105
105
|
roleId: components$1["schemas"]["PublicIdProperty"];
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* Permission type for this permission ComponentDefinition:
|
|
108
108
|
* read | write | create | delete
|
|
109
|
-
|
|
109
|
+
|
|
110
110
|
*/
|
|
111
111
|
permission: "read" | "write" | "create" | "delete";
|
|
112
|
-
/**
|
|
112
|
+
/** State of the component that this permission applies to */
|
|
113
113
|
state: number;
|
|
114
114
|
};
|
|
115
|
-
/**
|
|
115
|
+
/** Defines a component type that can live on a Composition */
|
|
116
116
|
ComponentDefinition: {
|
|
117
117
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
118
|
-
/**
|
|
118
|
+
/** Friendly name of the component definition */
|
|
119
119
|
name: string;
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
122
|
-
* @
|
|
121
|
+
* Icon name for the component definition (e.g. 'screen')
|
|
122
|
+
* @defaultValue screen
|
|
123
123
|
*/
|
|
124
124
|
icon?: string;
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
126
|
+
* The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
127
127
|
* The parameter type must support being used as a title parameter for this to work
|
|
128
|
-
* @
|
|
128
|
+
* @defaultValue null
|
|
129
129
|
*/
|
|
130
130
|
titleParameter?: string | null;
|
|
131
131
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @
|
|
132
|
+
* The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
133
|
+
* @defaultValue null
|
|
134
134
|
*/
|
|
135
135
|
thumbnailParameter?: string | null;
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @
|
|
137
|
+
* Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
138
|
+
* @defaultValue false
|
|
139
139
|
*/
|
|
140
140
|
canBeComposition?: boolean;
|
|
141
|
-
/**
|
|
141
|
+
/** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
142
142
|
parameters?: components$1["schemas"]["ComponentDefinitionParameter"][];
|
|
143
143
|
/**
|
|
144
144
|
* Format: uuid
|
|
145
|
-
*
|
|
146
|
-
* @
|
|
145
|
+
* Reference to the category this component definition belongs to
|
|
146
|
+
* @defaultValue null
|
|
147
147
|
*/
|
|
148
148
|
categoryId?: string | null;
|
|
149
|
-
/**
|
|
149
|
+
/** Description of the component definition */
|
|
150
150
|
description?: string;
|
|
151
|
-
/**
|
|
151
|
+
/** Preview image URL for the component definition (shown in the UI) */
|
|
152
152
|
previewImageUrl?: string;
|
|
153
153
|
/**
|
|
154
|
-
*
|
|
155
|
-
* @
|
|
154
|
+
* if this component uses team permissions or custom permissions
|
|
155
|
+
* @defaultValue true
|
|
156
156
|
*/
|
|
157
157
|
useTeamPermissions?: boolean;
|
|
158
|
-
/**
|
|
158
|
+
/** Custom role permissions for this component definition */
|
|
159
159
|
permissions?: components$1["schemas"]["ComponentDefinitionPermission"][];
|
|
160
|
-
/**
|
|
160
|
+
/** The named slots for this component; placement areas where arrays of other components can be added */
|
|
161
161
|
slots?: components$1["schemas"]["ComponentDefinitionSlot"][];
|
|
162
162
|
slugSettings?: components$1["schemas"]["ComponentDefinitionSlugSettings"];
|
|
163
|
-
/**
|
|
163
|
+
/** Default component instance value */
|
|
164
164
|
defaults?: components$1["schemas"]["ComponentInstance"] | null;
|
|
165
|
-
/**
|
|
165
|
+
/** Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
166
166
|
variants?: components$1["schemas"]["ComponentDefinitionVariant"][];
|
|
167
|
-
/**
|
|
167
|
+
/** Created date string for this definition (ignored for writes) */
|
|
168
168
|
created?: string;
|
|
169
|
-
/**
|
|
169
|
+
/** Last modified date string for this definition (ignored for writes) */
|
|
170
170
|
updated?: string;
|
|
171
171
|
/**
|
|
172
172
|
* Format: uuid
|
|
173
|
-
*
|
|
173
|
+
* ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
174
174
|
*/
|
|
175
175
|
workflowId?: string;
|
|
176
176
|
};
|
|
177
|
-
/**
|
|
177
|
+
/** Defines a content type */
|
|
178
178
|
ContentType: {
|
|
179
179
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
180
|
-
/**
|
|
180
|
+
/** Friendly name of the content type */
|
|
181
181
|
name: string;
|
|
182
182
|
/**
|
|
183
|
-
*
|
|
183
|
+
* The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
184
184
|
* The field type must support being used as an entry name for this to work
|
|
185
185
|
*/
|
|
186
186
|
entryName?: string | null;
|
|
187
187
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @
|
|
188
|
+
* The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
189
|
+
* @defaultValue null
|
|
190
190
|
*/
|
|
191
191
|
thumbnailField?: string | null;
|
|
192
|
-
/**
|
|
192
|
+
/** The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
193
193
|
fields?: components$1["schemas"]["ComponentDefinitionParameter"][];
|
|
194
|
-
/**
|
|
194
|
+
/** Description of the content type */
|
|
195
195
|
description?: string;
|
|
196
196
|
/**
|
|
197
|
-
*
|
|
198
|
-
* @
|
|
197
|
+
* Icon name for the content type (e.g. 'screen')
|
|
198
|
+
* @defaultValue file-document
|
|
199
199
|
*/
|
|
200
200
|
icon?: string;
|
|
201
|
-
/**
|
|
201
|
+
/** Created date string for this content type (ignored for writes) */
|
|
202
202
|
created?: string;
|
|
203
|
-
/**
|
|
203
|
+
/** Last modified date string for this content type (ignored for writes) */
|
|
204
204
|
updated?: string;
|
|
205
205
|
slugSettings?: components$1["schemas"]["ComponentDefinitionSlugSettings"];
|
|
206
206
|
/**
|
|
207
|
-
*
|
|
208
|
-
* @
|
|
209
|
-
|
|
207
|
+
* The definition type of this content type (block or content type)
|
|
208
|
+
* @defaultValue contentType
|
|
209
|
+
|
|
210
210
|
*/
|
|
211
211
|
type?: "contentType" | "block";
|
|
212
212
|
/**
|
|
213
|
-
*
|
|
214
|
-
* @
|
|
213
|
+
* if this content type uses team permissions or custom permissions
|
|
214
|
+
* @defaultValue true
|
|
215
215
|
*/
|
|
216
216
|
useTeamPermissions?: boolean;
|
|
217
|
-
/**
|
|
217
|
+
/** Custom role permissions for this content type */
|
|
218
218
|
permissions?: components$1["schemas"]["ComponentDefinitionPermission"][];
|
|
219
219
|
/**
|
|
220
220
|
* Format: uuid
|
|
221
|
-
*
|
|
221
|
+
* ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
222
222
|
*/
|
|
223
223
|
workflowId?: string;
|
|
224
|
-
/**
|
|
224
|
+
/** Configurations for previewing an entry on a consuming pattern or composition. */
|
|
225
225
|
previewConfigurations?: components$1["schemas"]["ContentTypePreviewConfiguration"][];
|
|
226
226
|
};
|
|
227
|
-
/**
|
|
227
|
+
/** Defines a configuration for previewing an entry on a consuming pattern or composition. */
|
|
228
228
|
ContentTypePreviewConfiguration: {
|
|
229
229
|
/**
|
|
230
|
-
*
|
|
231
|
-
|
|
230
|
+
* The type of preview configuration
|
|
231
|
+
|
|
232
232
|
*/
|
|
233
233
|
type: "pattern" | "project-map";
|
|
234
|
-
/**
|
|
234
|
+
/** Display label for the preview configuration */
|
|
235
235
|
label: string;
|
|
236
236
|
/**
|
|
237
237
|
* Format: uuid
|
|
238
|
-
*
|
|
238
|
+
* Target preview entity ID (project map node ID or pattern ID)
|
|
239
239
|
*/
|
|
240
240
|
id: string;
|
|
241
|
-
/**
|
|
241
|
+
/** Optional mapping of dynamic input names to their values */
|
|
242
242
|
dynamicInputs?: {
|
|
243
243
|
[key: string]: string;
|
|
244
244
|
};
|
|
245
245
|
};
|
|
246
|
-
/**
|
|
246
|
+
/** Defines an editable parameter on a component */
|
|
247
247
|
ComponentParameter: {
|
|
248
|
-
/**
|
|
248
|
+
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
249
249
|
value?: unknown;
|
|
250
|
-
/**
|
|
250
|
+
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
251
251
|
type: string;
|
|
252
252
|
/** @deprecated */
|
|
253
253
|
connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
|
|
254
254
|
/**
|
|
255
|
-
*
|
|
255
|
+
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
256
256
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
257
257
|
*/
|
|
258
258
|
locales?: {
|
|
259
259
|
[key: string]: unknown;
|
|
260
260
|
};
|
|
261
261
|
conditions?: components$1["schemas"]["ComponentParameterConditions"];
|
|
262
|
-
/**
|
|
262
|
+
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
263
263
|
localesConditions?: {
|
|
264
264
|
[key: string]: components$1["schemas"]["ComponentParameterConditions"];
|
|
265
265
|
};
|
|
266
266
|
};
|
|
267
267
|
/**
|
|
268
|
-
*
|
|
268
|
+
* Array of alternate values which are based on conditions.
|
|
269
269
|
*
|
|
270
270
|
* When requested with an explicit locale parameter, or via the route API:
|
|
271
271
|
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
@@ -275,60 +275,60 @@ interface components$1 {
|
|
|
275
275
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
276
276
|
*/
|
|
277
277
|
ComponentParameterConditions: components$1["schemas"]["ComponentParameterConditionalValue"][];
|
|
278
|
-
/**
|
|
278
|
+
/** Defines a conditional value for a component parameter */
|
|
279
279
|
ComponentParameterConditionalValue: {
|
|
280
280
|
when: components$1["schemas"]["VisibilityCriteriaGroup"];
|
|
281
281
|
/**
|
|
282
|
-
*
|
|
282
|
+
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
283
283
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
284
284
|
*/
|
|
285
285
|
value: unknown;
|
|
286
286
|
/**
|
|
287
|
-
*
|
|
287
|
+
* Unique sequence identifier of the conditional value within the component parameter.
|
|
288
288
|
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
289
289
|
*/
|
|
290
290
|
id: number;
|
|
291
291
|
};
|
|
292
292
|
/**
|
|
293
293
|
* @deprecated
|
|
294
|
-
*
|
|
294
|
+
* beta functionality subject to change
|
|
295
295
|
*/
|
|
296
296
|
VisibilityCriteriaGroup: {
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
299
|
-
|
|
298
|
+
* The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
299
|
+
|
|
300
300
|
*/
|
|
301
301
|
op?: "&" | "|";
|
|
302
302
|
clauses: (components$1["schemas"]["VisibilityCriteria"] | components$1["schemas"]["VisibilityCriteriaGroup"])[];
|
|
303
303
|
};
|
|
304
304
|
/**
|
|
305
305
|
* @deprecated
|
|
306
|
-
*
|
|
306
|
+
* beta functionality subject to change
|
|
307
307
|
*/
|
|
308
308
|
VisibilityCriteria: {
|
|
309
|
-
/**
|
|
309
|
+
/** The rule type to execute */
|
|
310
310
|
rule: string;
|
|
311
311
|
/**
|
|
312
|
-
*
|
|
312
|
+
* The source value of the rule.
|
|
313
313
|
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
314
314
|
*/
|
|
315
315
|
source?: string;
|
|
316
|
-
/**
|
|
316
|
+
/** The rule-definition-specific operator to test against */
|
|
317
317
|
op: string;
|
|
318
|
-
/**
|
|
318
|
+
/** The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
319
319
|
value: string | string[];
|
|
320
320
|
};
|
|
321
|
-
/**
|
|
321
|
+
/** Defines a connection to a dynamic token on a data resource */
|
|
322
322
|
DataElementConnectionDefinition: {
|
|
323
|
-
/**
|
|
323
|
+
/** A JSON Pointer expression that defines the data resource dynamic token value */
|
|
324
324
|
pointer: string;
|
|
325
325
|
/**
|
|
326
|
-
*
|
|
327
|
-
|
|
326
|
+
* The syntax used to select the dynamic token to bind to
|
|
327
|
+
|
|
328
328
|
*/
|
|
329
329
|
syntax: "jptr";
|
|
330
330
|
/**
|
|
331
|
-
*
|
|
331
|
+
* The action to take if the dynamic token cannot be resolved
|
|
332
332
|
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
333
333
|
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
334
334
|
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
@@ -338,49 +338,49 @@ interface components$1 {
|
|
|
338
338
|
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
339
339
|
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
340
340
|
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
341
|
-
|
|
341
|
+
|
|
342
342
|
*/
|
|
343
343
|
failureAction?: "t" | "p" | "c" | "a";
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* How to report when the dynamic token cannot be resolved
|
|
346
346
|
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
347
347
|
* - w: WARNING: Report a warning message [default]
|
|
348
348
|
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
349
|
-
|
|
349
|
+
|
|
350
350
|
*/
|
|
351
351
|
failureLogLevel?: "e" | "w" | "i";
|
|
352
352
|
/**
|
|
353
|
-
*
|
|
353
|
+
* The default value to use if the dynamic token cannot be resolved.
|
|
354
354
|
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
355
355
|
*/
|
|
356
356
|
failureDefault?: string;
|
|
357
357
|
};
|
|
358
|
-
/**
|
|
358
|
+
/** Defines the shape of a component instance served by the composition API */
|
|
359
359
|
ComponentInstance: {
|
|
360
|
-
/**
|
|
360
|
+
/** Type of the component instance (public_id of its definition) */
|
|
361
361
|
type: string;
|
|
362
|
-
/**
|
|
362
|
+
/** Component parameter values for the component instance */
|
|
363
363
|
parameters?: {
|
|
364
364
|
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
365
365
|
};
|
|
366
|
-
/**
|
|
366
|
+
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
367
367
|
variant?: string;
|
|
368
|
-
/**
|
|
368
|
+
/** Slots containing any child components */
|
|
369
369
|
slots?: {
|
|
370
370
|
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
371
371
|
};
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* Unique identifier of the component within the composition.
|
|
374
374
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
375
375
|
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
376
376
|
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
377
377
|
*/
|
|
378
378
|
_id?: string;
|
|
379
|
-
/**
|
|
379
|
+
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
380
380
|
_pattern?: string;
|
|
381
381
|
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
382
382
|
/**
|
|
383
|
-
*
|
|
383
|
+
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
384
384
|
* Means nothing for PUTs; it will be ignored
|
|
385
385
|
*/
|
|
386
386
|
_patternDataResources?: {
|
|
@@ -388,7 +388,7 @@ interface components$1 {
|
|
|
388
388
|
};
|
|
389
389
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
390
390
|
/**
|
|
391
|
-
*
|
|
391
|
+
* Defines patch overrides to component IDs that live in the composition.
|
|
392
392
|
* This can be used to override parameters that are defined on patterns,
|
|
393
393
|
* including nested patterns, with values that are specific to this composition.
|
|
394
394
|
* The keys in this object are component IDs.
|
|
@@ -403,57 +403,57 @@ interface components$1 {
|
|
|
403
403
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
404
404
|
};
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
407
407
|
* Means nothing for PUTs; it will be ignored
|
|
408
408
|
*/
|
|
409
409
|
_patternOverrides?: {
|
|
410
410
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
411
411
|
};
|
|
412
412
|
/**
|
|
413
|
-
*
|
|
413
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
414
414
|
* by consumers of the pattern.
|
|
415
415
|
*
|
|
416
416
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
417
417
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
418
418
|
*/
|
|
419
419
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
420
|
-
/**
|
|
420
|
+
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
421
421
|
_locales?: string[];
|
|
422
422
|
};
|
|
423
|
-
/**
|
|
423
|
+
/** Defines the shape of the root component in a composition */
|
|
424
424
|
RootComponentInstance: {
|
|
425
|
-
/**
|
|
425
|
+
/** Type of the component instance (public_id of its definition) */
|
|
426
426
|
type: string;
|
|
427
|
-
/**
|
|
427
|
+
/** Component parameter values for the component instance */
|
|
428
428
|
parameters?: {
|
|
429
429
|
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
430
430
|
};
|
|
431
|
-
/**
|
|
431
|
+
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
432
432
|
variant?: string;
|
|
433
|
-
/**
|
|
433
|
+
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
434
434
|
projectMapNodes?: components$1["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
435
|
-
/**
|
|
435
|
+
/** Slots containing any child components */
|
|
436
436
|
slots?: {
|
|
437
437
|
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
438
438
|
};
|
|
439
|
-
/**
|
|
439
|
+
/** The ID of the composition */
|
|
440
440
|
_id: string;
|
|
441
|
-
/**
|
|
441
|
+
/** Slug pattern of this component */
|
|
442
442
|
_slug?: string | null;
|
|
443
|
-
/**
|
|
443
|
+
/** Friendly name of this component */
|
|
444
444
|
_name: string;
|
|
445
|
-
/**
|
|
445
|
+
/** Name of the author of the most recent change */
|
|
446
446
|
_author?: string;
|
|
447
|
-
/**
|
|
447
|
+
/** Identity subject of the author of the most recent change */
|
|
448
448
|
_authorSubject?: string;
|
|
449
|
-
/**
|
|
449
|
+
/** Name of the original creator */
|
|
450
450
|
_creator?: string;
|
|
451
|
-
/**
|
|
451
|
+
/** Identity subject of the original creator */
|
|
452
452
|
_creatorSubject?: string;
|
|
453
|
-
/**
|
|
453
|
+
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
454
454
|
_pattern?: string;
|
|
455
455
|
/**
|
|
456
|
-
*
|
|
456
|
+
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
457
457
|
* Means nothing for PUTs; it will be ignored
|
|
458
458
|
*/
|
|
459
459
|
_patternDataResources?: {
|
|
@@ -462,7 +462,7 @@ interface components$1 {
|
|
|
462
462
|
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
463
463
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
464
464
|
/**
|
|
465
|
-
*
|
|
465
|
+
* Defines patch overrides to component IDs that live in the composition.
|
|
466
466
|
* This can be used to override parameters that are defined on patterns,
|
|
467
467
|
* including nested patterns, with values that are specific to this composition.
|
|
468
468
|
* The keys in this object are component IDs.
|
|
@@ -477,25 +477,25 @@ interface components$1 {
|
|
|
477
477
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
478
478
|
};
|
|
479
479
|
/**
|
|
480
|
-
*
|
|
480
|
+
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
481
481
|
* Means nothing for PUTs; it will be ignored
|
|
482
482
|
*/
|
|
483
483
|
_patternOverrides?: {
|
|
484
484
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
485
485
|
};
|
|
486
486
|
/**
|
|
487
|
-
*
|
|
487
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
488
488
|
* by consumers of the pattern.
|
|
489
489
|
*
|
|
490
490
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
491
491
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
492
492
|
*/
|
|
493
493
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
494
|
-
/**
|
|
494
|
+
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
495
495
|
_locales?: string[];
|
|
496
496
|
};
|
|
497
497
|
/**
|
|
498
|
-
*
|
|
498
|
+
* Defines how to override a specific component.
|
|
499
499
|
*
|
|
500
500
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
501
501
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
@@ -509,7 +509,7 @@ interface components$1 {
|
|
|
509
509
|
};
|
|
510
510
|
variant?: string;
|
|
511
511
|
/**
|
|
512
|
-
*
|
|
512
|
+
* Overrides data resource definitions for a pattern component.
|
|
513
513
|
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
514
514
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
515
515
|
*/
|
|
@@ -518,371 +518,371 @@ interface components$1 {
|
|
|
518
518
|
};
|
|
519
519
|
};
|
|
520
520
|
/**
|
|
521
|
-
*
|
|
521
|
+
* Defines how a component on a pattern may have its values overridden.
|
|
522
522
|
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
523
523
|
*
|
|
524
524
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
525
525
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
526
526
|
*/
|
|
527
527
|
ComponentOverridability: {
|
|
528
|
-
/**
|
|
528
|
+
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
529
529
|
parameters?: {
|
|
530
530
|
[key: string]: components$1["schemas"]["OverrideOptions"];
|
|
531
531
|
};
|
|
532
|
-
/**
|
|
532
|
+
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
533
533
|
variants?: boolean;
|
|
534
534
|
/**
|
|
535
|
-
*
|
|
535
|
+
* If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
536
536
|
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
537
537
|
* If not set, the default is false
|
|
538
538
|
*/
|
|
539
539
|
hideLockedParameters?: boolean;
|
|
540
540
|
};
|
|
541
541
|
/**
|
|
542
|
-
*
|
|
542
|
+
* Whether a parameter is overridable
|
|
543
543
|
*
|
|
544
544
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
545
545
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
546
|
-
|
|
546
|
+
|
|
547
547
|
*/
|
|
548
548
|
OverrideOptions: "yes" | "no";
|
|
549
|
-
/**
|
|
549
|
+
/** Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
|
|
550
550
|
AlternativeDataSourceData: {
|
|
551
|
-
/**
|
|
551
|
+
/** Base resource URL of the data source. No trailing slash */
|
|
552
552
|
baseUrl: string;
|
|
553
|
-
/**
|
|
553
|
+
/** HTTP headers to pass with requests to the data source */
|
|
554
554
|
headers?: {
|
|
555
555
|
key: string;
|
|
556
556
|
value: string;
|
|
557
557
|
omitIfEmpty?: boolean;
|
|
558
558
|
}[];
|
|
559
|
-
/**
|
|
559
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
560
560
|
parameters?: {
|
|
561
561
|
key: string;
|
|
562
562
|
value: string;
|
|
563
563
|
omitIfEmpty?: boolean;
|
|
564
564
|
}[];
|
|
565
|
-
/**
|
|
565
|
+
/** Variables needed to make calls to the data source */
|
|
566
566
|
variables?: {
|
|
567
567
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
568
568
|
};
|
|
569
569
|
};
|
|
570
570
|
/**
|
|
571
|
-
*
|
|
571
|
+
* An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
572
572
|
* These are created in the UI and shared across a whole project.
|
|
573
573
|
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
574
574
|
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
575
575
|
*/
|
|
576
576
|
DataSource: {
|
|
577
|
-
/**
|
|
577
|
+
/** Public ID of the data source */
|
|
578
578
|
id: string;
|
|
579
|
-
/**
|
|
579
|
+
/** Display name of the data source */
|
|
580
580
|
displayName: string;
|
|
581
|
-
/**
|
|
581
|
+
/** The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
|
|
582
582
|
connectorType: string;
|
|
583
|
-
/**
|
|
583
|
+
/** Base resource URL of the data source. No trailing slash */
|
|
584
584
|
baseUrl: string;
|
|
585
|
-
/**
|
|
585
|
+
/** HTTP headers to pass with requests to the data source */
|
|
586
586
|
headers?: {
|
|
587
587
|
key: string;
|
|
588
588
|
value: string;
|
|
589
589
|
}[];
|
|
590
|
-
/**
|
|
590
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
591
591
|
parameters?: {
|
|
592
592
|
key: string;
|
|
593
593
|
value: string;
|
|
594
594
|
}[];
|
|
595
|
-
/**
|
|
595
|
+
/** Variables needed to make calls to the data source */
|
|
596
596
|
variables?: {
|
|
597
597
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
598
598
|
};
|
|
599
599
|
/**
|
|
600
|
-
*
|
|
600
|
+
* Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
601
601
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
602
602
|
*/
|
|
603
603
|
localeMapping?: {
|
|
604
604
|
[key: string]: string;
|
|
605
605
|
};
|
|
606
606
|
/**
|
|
607
|
-
*
|
|
607
|
+
* If true, data source will require additional credentials to access unpublished data.
|
|
608
608
|
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
|
609
609
|
*/
|
|
610
610
|
enableUnpublishedMode?: boolean;
|
|
611
|
-
/**
|
|
611
|
+
/** Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
|
612
612
|
customPublic?: {
|
|
613
613
|
[key: string]: unknown;
|
|
614
614
|
};
|
|
615
|
-
/**
|
|
615
|
+
/** Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
|
|
616
616
|
custom?: {
|
|
617
617
|
[key: string]: unknown;
|
|
618
618
|
};
|
|
619
|
-
/**
|
|
619
|
+
/** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
620
620
|
variants?: {
|
|
621
621
|
unpublished?: components$1["schemas"]["AlternativeDataSourceData"];
|
|
622
622
|
};
|
|
623
|
-
/**
|
|
623
|
+
/** Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
624
624
|
created?: string;
|
|
625
|
-
/**
|
|
625
|
+
/** Last modified date of the data source in ISO 8601 format (ignored for writes) */
|
|
626
626
|
modified?: string;
|
|
627
|
-
/**
|
|
627
|
+
/** User or API key ID that created the data source (ignored for writes) */
|
|
628
628
|
createdBy?: string;
|
|
629
|
-
/**
|
|
629
|
+
/** User or API key ID that last modified the data source (ignored for writes) */
|
|
630
630
|
modifiedBy?: string;
|
|
631
631
|
};
|
|
632
|
-
/**
|
|
632
|
+
/** A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
|
|
633
633
|
DataType: {
|
|
634
|
-
/**
|
|
634
|
+
/** Public ID of the data type */
|
|
635
635
|
id: string;
|
|
636
|
-
/**
|
|
636
|
+
/** Display name of the data type */
|
|
637
637
|
displayName: string;
|
|
638
|
-
/**
|
|
638
|
+
/** Public ID of the associated data source */
|
|
639
639
|
dataSourceId: string;
|
|
640
640
|
/**
|
|
641
|
-
*
|
|
641
|
+
* A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
642
642
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
643
643
|
* no special UI or processing is required
|
|
644
644
|
*/
|
|
645
645
|
archetype?: string;
|
|
646
646
|
allowedOnComponents?: string[];
|
|
647
|
-
/**
|
|
647
|
+
/** Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
648
648
|
path: string;
|
|
649
|
-
/**
|
|
649
|
+
/** Time-to-live (in seconds) for the resource data cache */
|
|
650
650
|
ttl?: number;
|
|
651
|
-
/**
|
|
651
|
+
/** A key for the resource data cache purging */
|
|
652
652
|
purgeKey?: string;
|
|
653
|
-
/**
|
|
653
|
+
/** URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons */
|
|
654
654
|
badgeIconUrl?: string;
|
|
655
|
-
/**
|
|
655
|
+
/** HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
656
656
|
headers?: {
|
|
657
657
|
key: string;
|
|
658
658
|
value: string;
|
|
659
659
|
omitIfEmpty?: boolean;
|
|
660
660
|
}[];
|
|
661
|
-
/**
|
|
661
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
662
662
|
parameters?: {
|
|
663
663
|
key: string;
|
|
664
664
|
value: string;
|
|
665
665
|
omitIfEmpty?: boolean;
|
|
666
666
|
}[];
|
|
667
|
-
/**
|
|
667
|
+
/** Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
668
668
|
body?: string;
|
|
669
669
|
/**
|
|
670
|
-
*
|
|
671
|
-
* @
|
|
672
|
-
|
|
670
|
+
* HTTP method to use with requests to the data type
|
|
671
|
+
* @defaultValue GET
|
|
672
|
+
|
|
673
673
|
*/
|
|
674
674
|
method: "GET" | "POST" | "HEAD";
|
|
675
|
-
/**
|
|
675
|
+
/** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
676
676
|
variables?: {
|
|
677
677
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
678
678
|
};
|
|
679
|
-
/**
|
|
679
|
+
/** Custom configuration specific to the data source being defined */
|
|
680
680
|
custom?: {
|
|
681
681
|
[key: string]: unknown;
|
|
682
682
|
};
|
|
683
|
-
/**
|
|
683
|
+
/** Created date of the data type in ISO 8601 format (ignored for writes) */
|
|
684
684
|
created?: string;
|
|
685
|
-
/**
|
|
685
|
+
/** Last modified date of the data type in ISO 8601 format (ignored for writes) */
|
|
686
686
|
modified?: string;
|
|
687
|
-
/**
|
|
687
|
+
/** User or API key ID that created the data type (ignored for writes) */
|
|
688
688
|
createdBy?: string;
|
|
689
|
-
/**
|
|
689
|
+
/** User or API key ID that last modified the data type (ignored for writes) */
|
|
690
690
|
modifiedBy?: string;
|
|
691
691
|
};
|
|
692
|
-
/**
|
|
692
|
+
/** Defines the shape of a data variable on a Data Source or Data Type */
|
|
693
693
|
DataVariableDefinition: {
|
|
694
|
-
/**
|
|
694
|
+
/** Display name of the data variable */
|
|
695
695
|
displayName?: string;
|
|
696
|
-
/**
|
|
696
|
+
/** Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
697
697
|
helpText?: string;
|
|
698
698
|
/**
|
|
699
|
-
*
|
|
700
|
-
* @
|
|
699
|
+
* Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable
|
|
700
|
+
* @defaultValue text
|
|
701
701
|
*/
|
|
702
702
|
type?: string;
|
|
703
|
-
/**
|
|
703
|
+
/** Default value of the data variable */
|
|
704
704
|
default: string;
|
|
705
|
-
/**
|
|
705
|
+
/** Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
706
706
|
order?: number;
|
|
707
707
|
/**
|
|
708
|
-
*
|
|
708
|
+
* An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
709
709
|
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
710
710
|
*/
|
|
711
711
|
source?: string;
|
|
712
712
|
};
|
|
713
713
|
/**
|
|
714
|
-
*
|
|
714
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
715
715
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
716
716
|
*/
|
|
717
717
|
DataResourceDefinitions: {
|
|
718
718
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
719
719
|
};
|
|
720
|
-
/**
|
|
720
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
721
721
|
DataResourceDefinition: {
|
|
722
|
-
/**
|
|
722
|
+
/** Public ID of the data type that provides this data */
|
|
723
723
|
type: string;
|
|
724
|
-
/**
|
|
724
|
+
/** Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false */
|
|
725
725
|
isPatternParameter?: boolean;
|
|
726
726
|
/**
|
|
727
|
-
*
|
|
727
|
+
* When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
728
728
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
729
729
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
730
730
|
*/
|
|
731
731
|
ignorePatternParameterDefault?: boolean;
|
|
732
732
|
/**
|
|
733
|
-
*
|
|
733
|
+
* When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
734
734
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
735
735
|
*/
|
|
736
736
|
optionalPatternParameter?: boolean;
|
|
737
737
|
variables?: components$1["schemas"]["DataResourceVariables"];
|
|
738
738
|
};
|
|
739
|
-
/**
|
|
739
|
+
/** Variable values for a data resource */
|
|
740
740
|
DataResourceVariables: {
|
|
741
741
|
[key: string]: string;
|
|
742
742
|
};
|
|
743
743
|
/**
|
|
744
|
-
*
|
|
744
|
+
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
745
745
|
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
746
746
|
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
747
747
|
* Means nothing for PUTs; it will be ignored
|
|
748
|
-
|
|
748
|
+
|
|
749
749
|
*/
|
|
750
750
|
PatternError: "NOTFOUND" | "CYCLIC";
|
|
751
751
|
HistoryApiResponse: {
|
|
752
752
|
/**
|
|
753
|
-
*
|
|
753
|
+
* If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
|
|
754
754
|
* If this is undefined then no more results are available
|
|
755
755
|
*/
|
|
756
756
|
cursor?: string;
|
|
757
|
-
/**
|
|
757
|
+
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
758
758
|
truncated?: boolean;
|
|
759
|
-
/**
|
|
759
|
+
/** Version history entries */
|
|
760
760
|
results?: components$1["schemas"]["HistoryEntry"][];
|
|
761
761
|
};
|
|
762
762
|
HistoryEntry: {
|
|
763
|
-
/**
|
|
763
|
+
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
764
764
|
versionId: string;
|
|
765
|
-
/**
|
|
765
|
+
/** The timestamp when the version was created in epoch milliseconds */
|
|
766
766
|
timestamp: number;
|
|
767
|
-
/**
|
|
767
|
+
/** The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
768
768
|
authorName: string;
|
|
769
769
|
authorIsApiKey: boolean;
|
|
770
|
-
/**
|
|
770
|
+
/** The identity who created the version; absent on old history entries. */
|
|
771
771
|
authorSubject?: string;
|
|
772
|
-
/**
|
|
772
|
+
/** The state of the entity when the history entry was made */
|
|
773
773
|
state: number;
|
|
774
774
|
};
|
|
775
|
-
/**
|
|
775
|
+
/** Category for tagging canvas entities */
|
|
776
776
|
Category: {
|
|
777
777
|
/**
|
|
778
778
|
* Format: uuid
|
|
779
|
-
*
|
|
779
|
+
* Unique identifier for the category
|
|
780
780
|
*/
|
|
781
781
|
id: string;
|
|
782
|
-
/**
|
|
782
|
+
/** Display name of the category */
|
|
783
783
|
name: string;
|
|
784
784
|
/**
|
|
785
|
-
*
|
|
786
|
-
* @
|
|
785
|
+
* Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list
|
|
786
|
+
* @defaultValue 0
|
|
787
787
|
*/
|
|
788
788
|
order?: number;
|
|
789
789
|
};
|
|
790
|
-
/**
|
|
790
|
+
/** Project map node information related to a component */
|
|
791
791
|
CompositionProjectMapNodeInfo: {
|
|
792
792
|
/**
|
|
793
793
|
* Format: uuid
|
|
794
|
-
*
|
|
794
|
+
* Unique identifier for the project map node
|
|
795
795
|
*/
|
|
796
796
|
id: string;
|
|
797
797
|
/**
|
|
798
|
-
*
|
|
798
|
+
* Fallback path of the project map node.
|
|
799
799
|
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
800
800
|
*/
|
|
801
801
|
path: string;
|
|
802
802
|
/**
|
|
803
803
|
* Format: uuid
|
|
804
|
-
*
|
|
804
|
+
* Unique identifier for the project map that this node belongs to
|
|
805
805
|
*/
|
|
806
806
|
projectMapId: string;
|
|
807
807
|
data?: components$1["schemas"]["ProjectMapNodeData"];
|
|
808
808
|
/**
|
|
809
|
-
*
|
|
809
|
+
* Locale-specific paths of the project map node.
|
|
810
810
|
* Keys are locale codes
|
|
811
811
|
*/
|
|
812
812
|
locales?: {
|
|
813
813
|
[key: string]: {
|
|
814
|
-
/**
|
|
814
|
+
/** Locale-specific path of the project map node */
|
|
815
815
|
path: string;
|
|
816
|
-
/**
|
|
816
|
+
/** Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
817
817
|
inherited: boolean;
|
|
818
818
|
};
|
|
819
819
|
};
|
|
820
820
|
};
|
|
821
|
-
/**
|
|
821
|
+
/** AI Prompt definition */
|
|
822
822
|
Prompt: {
|
|
823
823
|
/**
|
|
824
824
|
* Format: uuid
|
|
825
|
-
*
|
|
825
|
+
* Unique identifier for the prompt
|
|
826
826
|
*/
|
|
827
827
|
id: string;
|
|
828
|
-
/**
|
|
828
|
+
/** Unique identifier for the integration that this prompt belongs to */
|
|
829
829
|
integrationType: string;
|
|
830
|
-
/**
|
|
830
|
+
/** Name for the prompt */
|
|
831
831
|
name?: string | null;
|
|
832
|
-
/**
|
|
832
|
+
/** Text for the prompt */
|
|
833
833
|
text?: string | null;
|
|
834
|
-
/**
|
|
834
|
+
/** Data for the prompt */
|
|
835
835
|
data?: {
|
|
836
836
|
[key: string]: unknown;
|
|
837
837
|
} | null;
|
|
838
|
-
/**
|
|
838
|
+
/** Turn off/on prompt */
|
|
839
839
|
enabled?: boolean | null;
|
|
840
|
-
/**
|
|
840
|
+
/** Integration default prompt */
|
|
841
841
|
builtIn?: boolean | null;
|
|
842
|
-
/**
|
|
842
|
+
/** Supported parameter types */
|
|
843
843
|
parameterTypes?: string[] | null;
|
|
844
844
|
};
|
|
845
|
-
/**
|
|
845
|
+
/** Definition of a workflow that can be assigned to entities */
|
|
846
846
|
WorkflowDefinition: {
|
|
847
847
|
/**
|
|
848
848
|
* Format: uuid
|
|
849
|
-
*
|
|
849
|
+
* Unique identifier of the workflow definition
|
|
850
850
|
*/
|
|
851
851
|
id: string;
|
|
852
|
-
/**
|
|
852
|
+
/** Workflow name */
|
|
853
853
|
name: string;
|
|
854
854
|
/**
|
|
855
855
|
* Format: uuid
|
|
856
|
-
*
|
|
856
|
+
* The ID of the initial stage in the stages object.
|
|
857
857
|
*/
|
|
858
858
|
initialStage: string;
|
|
859
|
-
/**
|
|
859
|
+
/** All stages of the workflow */
|
|
860
860
|
stages: {
|
|
861
861
|
[key: string]: components$1["schemas"]["WorkflowStage"];
|
|
862
862
|
};
|
|
863
|
-
/**
|
|
863
|
+
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
864
864
|
modified?: string;
|
|
865
|
-
/**
|
|
865
|
+
/** Created ISO date string for this definition (ignored for writes) */
|
|
866
866
|
created?: string;
|
|
867
867
|
/**
|
|
868
|
-
*
|
|
868
|
+
* Name of the original creator of the workflow.
|
|
869
869
|
* If undefined, the user has been removed from the team.
|
|
870
870
|
* Ignored for writes
|
|
871
871
|
*/
|
|
872
872
|
createdBy?: string;
|
|
873
873
|
/**
|
|
874
|
-
*
|
|
874
|
+
* Name of the last modifier of the workflow.
|
|
875
875
|
* If undefined, the user has been removed from the team.
|
|
876
876
|
* Ignored for writes
|
|
877
877
|
*/
|
|
878
878
|
modifiedBy?: string;
|
|
879
879
|
};
|
|
880
|
-
/**
|
|
880
|
+
/** Definition of a stage in a workflow */
|
|
881
881
|
WorkflowStage: {
|
|
882
|
-
/**
|
|
882
|
+
/** Name of the stage */
|
|
883
883
|
name: string;
|
|
884
884
|
/**
|
|
885
|
-
*
|
|
885
|
+
* Defines roles which have permissions to this workflow stage
|
|
886
886
|
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
887
887
|
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
888
888
|
* listed here, the stage is read-only and publishing is disabled
|
|
@@ -891,62 +891,62 @@ interface components$1 {
|
|
|
891
891
|
[key: string]: components$1["schemas"]["WorkflowStagePermission"];
|
|
892
892
|
};
|
|
893
893
|
/**
|
|
894
|
-
*
|
|
894
|
+
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
895
895
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
896
896
|
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
897
897
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
898
898
|
*/
|
|
899
899
|
autoPublish?: boolean;
|
|
900
900
|
/**
|
|
901
|
-
*
|
|
901
|
+
* When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
902
902
|
* If the entity is not valid, the transition will not be allowed.
|
|
903
903
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
904
904
|
*/
|
|
905
905
|
requireValidity?: boolean;
|
|
906
906
|
/**
|
|
907
|
-
*
|
|
907
|
+
* Defines transitions to other stages
|
|
908
908
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
909
909
|
* has a stage that can never be escaped
|
|
910
910
|
*/
|
|
911
911
|
transitions: components$1["schemas"]["WorkflowStageTransition"][];
|
|
912
912
|
/**
|
|
913
|
-
*
|
|
914
|
-
* @
|
|
913
|
+
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
914
|
+
* @defaultValue chevron-double-right-o
|
|
915
915
|
*/
|
|
916
916
|
icon?: string;
|
|
917
|
-
/**
|
|
917
|
+
/** Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
918
918
|
order?: number;
|
|
919
919
|
};
|
|
920
|
-
/**
|
|
920
|
+
/** Definition of a transition from one stage to another in a workflow */
|
|
921
921
|
WorkflowStageTransition: {
|
|
922
922
|
/**
|
|
923
923
|
* Format: uuid
|
|
924
|
-
*
|
|
924
|
+
* The target stage to transition to
|
|
925
925
|
*/
|
|
926
926
|
to: string;
|
|
927
927
|
/**
|
|
928
|
-
*
|
|
928
|
+
* Name shown to the user when they execute this transition.
|
|
929
929
|
* If not provided, a default name will be assigned automatically based on the target stage
|
|
930
930
|
*/
|
|
931
931
|
name: string;
|
|
932
932
|
/**
|
|
933
|
-
*
|
|
933
|
+
* Permissions for the stage transition.
|
|
934
934
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
935
935
|
*/
|
|
936
936
|
permissions: {
|
|
937
937
|
[key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
|
|
938
938
|
};
|
|
939
939
|
};
|
|
940
|
-
/**
|
|
940
|
+
/** Permissions for a workflow stage */
|
|
941
941
|
WorkflowStagePermission: {
|
|
942
|
-
/**
|
|
942
|
+
/** Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
943
943
|
write?: boolean;
|
|
944
|
-
/**
|
|
944
|
+
/** Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
945
945
|
publish?: boolean;
|
|
946
946
|
};
|
|
947
|
-
/**
|
|
947
|
+
/** Permissions for a workflow stage transition */
|
|
948
948
|
WorkflowStageTransitionPermission: {
|
|
949
|
-
/**
|
|
949
|
+
/** Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it */
|
|
950
950
|
execute?: boolean;
|
|
951
951
|
};
|
|
952
952
|
/** @enum {string} */
|
|
@@ -954,34 +954,34 @@ interface components$1 {
|
|
|
954
954
|
/** @enum {string} */
|
|
955
955
|
ReleaseScheduleState: "scheduled" | "unscheduled";
|
|
956
956
|
ProjectMapNodeAllowedQueryString: {
|
|
957
|
-
/**
|
|
957
|
+
/** The name of the query string parameter */
|
|
958
958
|
name: string;
|
|
959
|
-
/**
|
|
959
|
+
/** The default value of the query string if it is not provided by an incoming route path */
|
|
960
960
|
value?: string;
|
|
961
|
-
/**
|
|
961
|
+
/** Help text for authors who might be setting up a preview value for this query string */
|
|
962
962
|
helpText?: string;
|
|
963
|
-
/**
|
|
963
|
+
/** Configuration for providing a list of allowed values for this query string */
|
|
964
964
|
optionsSource?: {
|
|
965
965
|
/**
|
|
966
|
-
*
|
|
967
|
-
|
|
966
|
+
* The source type for the options
|
|
967
|
+
|
|
968
968
|
*/
|
|
969
969
|
source: "static";
|
|
970
970
|
options: {
|
|
971
|
-
/**
|
|
971
|
+
/** Display name for the option */
|
|
972
972
|
name: string;
|
|
973
|
-
/**
|
|
973
|
+
/** The actual value to be used */
|
|
974
974
|
value: string;
|
|
975
975
|
}[];
|
|
976
976
|
};
|
|
977
977
|
};
|
|
978
978
|
ProjectMapNodeData: {
|
|
979
|
-
/**
|
|
979
|
+
/** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
980
980
|
isSearchHit?: boolean;
|
|
981
|
-
/**
|
|
981
|
+
/** Query strings that are allowed to be passed to the node */
|
|
982
982
|
queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
983
983
|
/**
|
|
984
|
-
*
|
|
984
|
+
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
985
985
|
* The preview value is used when editing a connected composition, and is the default
|
|
986
986
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
987
987
|
*/
|
|
@@ -1004,7 +1004,7 @@ interface paths {
|
|
|
1004
1004
|
cookie?: never;
|
|
1005
1005
|
};
|
|
1006
1006
|
/**
|
|
1007
|
-
*
|
|
1007
|
+
* In addition to the named parameters below, this endpoint accepts the
|
|
1008
1008
|
* following query parameter convention which is pattern-validated and
|
|
1009
1009
|
* therefore not declared as named parameters:
|
|
1010
1010
|
*
|
|
@@ -1058,51 +1058,51 @@ interface paths {
|
|
|
1058
1058
|
get: {
|
|
1059
1059
|
parameters: {
|
|
1060
1060
|
query: {
|
|
1061
|
-
/**
|
|
1061
|
+
/** Specify a single asset ID to fetch */
|
|
1062
1062
|
assetId?: components["parameters"]["assetId"];
|
|
1063
|
-
/**
|
|
1063
|
+
/** Specify multiple asset IDs to fetch. Response type will be a list */
|
|
1064
1064
|
assetIDs?: components["parameters"]["assetIDs"];
|
|
1065
|
-
/**
|
|
1065
|
+
/** Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
1066
1066
|
createdBy?: components["parameters"]["createdBy"];
|
|
1067
1067
|
/**
|
|
1068
|
-
*
|
|
1068
|
+
* Matches assets where their name or description contains the specified keyword.
|
|
1069
1069
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
1070
1070
|
*/
|
|
1071
1071
|
keyword?: components["parameters"]["keyword"];
|
|
1072
1072
|
/**
|
|
1073
1073
|
* @deprecated
|
|
1074
|
-
*
|
|
1074
|
+
* BETA: Semantic search using vector similarity to find assets by meaning.
|
|
1075
1075
|
* Use this for "images of mountains" style queries.
|
|
1076
1076
|
* Requires AI credits.
|
|
1077
1077
|
*/
|
|
1078
1078
|
searchSemantic?: components["parameters"]["searchSemantic"];
|
|
1079
|
-
/**
|
|
1079
|
+
/** Max number of records to return */
|
|
1080
1080
|
limit?: components["parameters"]["limit"];
|
|
1081
|
-
/**
|
|
1081
|
+
/** Number of records to skip */
|
|
1082
1082
|
offset?: components["parameters"]["offset"];
|
|
1083
1083
|
/**
|
|
1084
|
-
*
|
|
1084
|
+
* Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1085
1085
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
|
|
1086
1086
|
*/
|
|
1087
1087
|
orderBy?: components["parameters"]["orderBy"];
|
|
1088
1088
|
/**
|
|
1089
1089
|
* @deprecated
|
|
1090
|
-
*
|
|
1090
|
+
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
1091
1091
|
*/
|
|
1092
1092
|
facetBy?: components["parameters"]["facetBy"];
|
|
1093
|
-
/**
|
|
1093
|
+
/** The project the asset/assets are on */
|
|
1094
1094
|
projectId: components["parameters"]["projectId"];
|
|
1095
|
-
/**
|
|
1095
|
+
/** The asset type ID to filter by */
|
|
1096
1096
|
type?: components["parameters"]["type"];
|
|
1097
|
-
/**
|
|
1097
|
+
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1098
1098
|
updatedBy?: components["parameters"]["updatedBy"];
|
|
1099
1099
|
/**
|
|
1100
|
-
*
|
|
1100
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1101
1101
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1102
1102
|
*/
|
|
1103
1103
|
withTotalCount?: components["parameters"]["withTotalCount"];
|
|
1104
1104
|
/**
|
|
1105
|
-
*
|
|
1105
|
+
* The ID of a release to fetch the content for.
|
|
1106
1106
|
*
|
|
1107
1107
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1108
1108
|
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
@@ -1111,19 +1111,19 @@ interface paths {
|
|
|
1111
1111
|
*/
|
|
1112
1112
|
releaseId?: components["parameters"]["releaseId"];
|
|
1113
1113
|
/**
|
|
1114
|
-
*
|
|
1114
|
+
* When true, includes full label entities in the response for UI rendering.
|
|
1115
1115
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1116
1116
|
* This parameter is not supported with uniform.global.
|
|
1117
1117
|
*/
|
|
1118
1118
|
withAssignedLabels?: components["parameters"]["withAssignedLabels"];
|
|
1119
1119
|
/**
|
|
1120
1120
|
* @deprecated
|
|
1121
|
-
*
|
|
1121
|
+
* Returns additional author and creator metadata for the asset.
|
|
1122
1122
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1123
1123
|
*/
|
|
1124
1124
|
withUIStatus?: components["parameters"]["withUIStatus"];
|
|
1125
1125
|
/**
|
|
1126
|
-
*
|
|
1126
|
+
* Controls filtering of trashed items.
|
|
1127
1127
|
*
|
|
1128
1128
|
* exclude: (default) Only return items not in trash.
|
|
1129
1129
|
* only: Only return trashed items (for trash view).
|
|
@@ -1137,7 +1137,7 @@ interface paths {
|
|
|
1137
1137
|
};
|
|
1138
1138
|
requestBody?: never;
|
|
1139
1139
|
responses: {
|
|
1140
|
-
/**
|
|
1140
|
+
/** OK */
|
|
1141
1141
|
200: {
|
|
1142
1142
|
headers: {
|
|
1143
1143
|
[name: string]: unknown;
|
|
@@ -1149,14 +1149,14 @@ interface paths {
|
|
|
1149
1149
|
400: components["responses"]["BadRequestError"];
|
|
1150
1150
|
401: components["responses"]["UnauthorizedError"];
|
|
1151
1151
|
403: components["responses"]["ForbiddenError"];
|
|
1152
|
-
/**
|
|
1152
|
+
/** Asset not found */
|
|
1153
1153
|
404: {
|
|
1154
1154
|
headers: {
|
|
1155
1155
|
[name: string]: unknown;
|
|
1156
1156
|
};
|
|
1157
1157
|
content: {
|
|
1158
1158
|
"application/json": {
|
|
1159
|
-
/**
|
|
1159
|
+
/** The error message */
|
|
1160
1160
|
errorMessage: string;
|
|
1161
1161
|
};
|
|
1162
1162
|
};
|
|
@@ -1166,7 +1166,7 @@ interface paths {
|
|
|
1166
1166
|
};
|
|
1167
1167
|
};
|
|
1168
1168
|
/**
|
|
1169
|
-
*
|
|
1169
|
+
* Creates or updates assets. Submitting the ID of a trashed asset restores it.
|
|
1170
1170
|
* A file-backed asset must include its original file reference when restored.
|
|
1171
1171
|
*/
|
|
1172
1172
|
put: {
|
|
@@ -1181,12 +1181,12 @@ interface paths {
|
|
|
1181
1181
|
"application/json": {
|
|
1182
1182
|
/**
|
|
1183
1183
|
* Format: uuid
|
|
1184
|
-
*
|
|
1184
|
+
* The project ID to upsert the asset to
|
|
1185
1185
|
*/
|
|
1186
1186
|
projectId: string;
|
|
1187
1187
|
/**
|
|
1188
1188
|
* Format: uuid
|
|
1189
|
-
*
|
|
1189
|
+
* The release ID to upsert the asset to. If unspecified the asset belongs to the base
|
|
1190
1190
|
*/
|
|
1191
1191
|
releaseId?: string;
|
|
1192
1192
|
asset?: components["schemas"]["AssetInput"];
|
|
@@ -1195,7 +1195,7 @@ interface paths {
|
|
|
1195
1195
|
};
|
|
1196
1196
|
};
|
|
1197
1197
|
responses: {
|
|
1198
|
-
/**
|
|
1198
|
+
/** OK */
|
|
1199
1199
|
204: {
|
|
1200
1200
|
headers: {
|
|
1201
1201
|
[name: string]: unknown;
|
|
@@ -1211,7 +1211,7 @@ interface paths {
|
|
|
1211
1211
|
};
|
|
1212
1212
|
post?: never;
|
|
1213
1213
|
/**
|
|
1214
|
-
*
|
|
1214
|
+
* Moves an asset to trash. Trashed assets are omitted from default GET results and
|
|
1215
1215
|
* permanently deleted after the configured retention period.
|
|
1216
1216
|
*/
|
|
1217
1217
|
delete: {
|
|
@@ -1226,17 +1226,17 @@ interface paths {
|
|
|
1226
1226
|
"application/json": {
|
|
1227
1227
|
/**
|
|
1228
1228
|
* Format: uuid
|
|
1229
|
-
*
|
|
1229
|
+
* The ID of the asset to move to trash
|
|
1230
1230
|
*/
|
|
1231
1231
|
assetId: string;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* Format: uuid
|
|
1234
|
-
*
|
|
1234
|
+
* The ID of the project the asset belongs to
|
|
1235
1235
|
*/
|
|
1236
1236
|
projectId: string;
|
|
1237
1237
|
/**
|
|
1238
1238
|
* Format: uuid
|
|
1239
|
-
*
|
|
1239
|
+
* The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
|
|
1240
1240
|
* Note: deleting an asset from a release will not delete the asset from the base
|
|
1241
1241
|
*/
|
|
1242
1242
|
releaseId?: string;
|
|
@@ -1244,7 +1244,7 @@ interface paths {
|
|
|
1244
1244
|
};
|
|
1245
1245
|
};
|
|
1246
1246
|
responses: {
|
|
1247
|
-
/**
|
|
1247
|
+
/** OK */
|
|
1248
1248
|
204: {
|
|
1249
1249
|
headers: {
|
|
1250
1250
|
[name: string]: unknown;
|
|
@@ -1258,7 +1258,7 @@ interface paths {
|
|
|
1258
1258
|
500: components["responses"]["InternalServerError"];
|
|
1259
1259
|
};
|
|
1260
1260
|
};
|
|
1261
|
-
/**
|
|
1261
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
1262
1262
|
options: {
|
|
1263
1263
|
parameters: {
|
|
1264
1264
|
query?: never;
|
|
@@ -1268,7 +1268,7 @@ interface paths {
|
|
|
1268
1268
|
};
|
|
1269
1269
|
requestBody?: never;
|
|
1270
1270
|
responses: {
|
|
1271
|
-
/**
|
|
1271
|
+
/** OK */
|
|
1272
1272
|
204: {
|
|
1273
1273
|
headers: {
|
|
1274
1274
|
[name: string]: unknown;
|
|
@@ -1284,24 +1284,24 @@ interface paths {
|
|
|
1284
1284
|
}
|
|
1285
1285
|
interface components {
|
|
1286
1286
|
schemas: {
|
|
1287
|
-
/**
|
|
1287
|
+
/** Defines the shape of the asset */
|
|
1288
1288
|
Asset: {
|
|
1289
|
-
/**
|
|
1289
|
+
/** Asset type of the asset */
|
|
1290
1290
|
type: string;
|
|
1291
1291
|
/**
|
|
1292
1292
|
* Format: uuid
|
|
1293
|
-
*
|
|
1293
|
+
* The public UUID of the asset
|
|
1294
1294
|
*/
|
|
1295
1295
|
_id: string;
|
|
1296
|
-
/**
|
|
1296
|
+
/** The name of the asset */
|
|
1297
1297
|
_name: string;
|
|
1298
|
-
/**
|
|
1298
|
+
/** Name of the author of the most recent change */
|
|
1299
1299
|
_author?: string;
|
|
1300
|
-
/**
|
|
1300
|
+
/** Identity subject of the author of the most recent change */
|
|
1301
1301
|
_authorSubject?: string;
|
|
1302
|
-
/**
|
|
1302
|
+
/** Name of the original creator */
|
|
1303
1303
|
_creator?: string;
|
|
1304
|
-
/**
|
|
1304
|
+
/** Identity subject of the original creator */
|
|
1305
1305
|
_creatorSubject?: string;
|
|
1306
1306
|
fields?: {
|
|
1307
1307
|
title?: {
|
|
@@ -1314,11 +1314,11 @@ interface components {
|
|
|
1314
1314
|
/** @constant */
|
|
1315
1315
|
type: "text";
|
|
1316
1316
|
};
|
|
1317
|
-
/**
|
|
1317
|
+
/** An asset can reference at most one file. A file can be attached to only one asset. */
|
|
1318
1318
|
file?: {
|
|
1319
1319
|
/**
|
|
1320
1320
|
* Format: uuid
|
|
1321
|
-
*
|
|
1321
|
+
* File ID to attach. A trashed file cannot be attached to an active asset.
|
|
1322
1322
|
*/
|
|
1323
1323
|
value: string;
|
|
1324
1324
|
/** @constant */
|
|
@@ -1357,25 +1357,25 @@ interface components {
|
|
|
1357
1357
|
/** @constant */
|
|
1358
1358
|
type: "focalPoint";
|
|
1359
1359
|
};
|
|
1360
|
-
/**
|
|
1360
|
+
/** Asset field values */
|
|
1361
1361
|
custom?: {
|
|
1362
1362
|
[key: string]: components["schemas"]["ComponentParameter"];
|
|
1363
1363
|
};
|
|
1364
1364
|
};
|
|
1365
1365
|
_dataResources?: components["schemas"]["DataResourceDefinitions"];
|
|
1366
|
-
/**
|
|
1366
|
+
/** Array of label public IDs assigned to this asset (max 30) */
|
|
1367
1367
|
labels?: string[];
|
|
1368
1368
|
};
|
|
1369
|
-
/**
|
|
1369
|
+
/** Defines the shape of the asset input */
|
|
1370
1370
|
AssetInput: {
|
|
1371
|
-
/**
|
|
1371
|
+
/** Content type of the asset */
|
|
1372
1372
|
type?: string;
|
|
1373
1373
|
/**
|
|
1374
1374
|
* Format: uuid
|
|
1375
|
-
*
|
|
1375
|
+
* The public UUID of the asset
|
|
1376
1376
|
*/
|
|
1377
1377
|
_id?: string;
|
|
1378
|
-
/**
|
|
1378
|
+
/** The internal name of the asset */
|
|
1379
1379
|
_name?: string;
|
|
1380
1380
|
fields?: {
|
|
1381
1381
|
title?: {
|
|
@@ -1388,11 +1388,11 @@ interface components {
|
|
|
1388
1388
|
/** @constant */
|
|
1389
1389
|
type: "text";
|
|
1390
1390
|
};
|
|
1391
|
-
/**
|
|
1391
|
+
/** An asset can reference at most one file. A file can be attached to only one asset. */
|
|
1392
1392
|
file?: {
|
|
1393
1393
|
/**
|
|
1394
1394
|
* Format: uuid
|
|
1395
|
-
*
|
|
1395
|
+
* File ID to attach. A trashed file cannot be attached to an active asset.
|
|
1396
1396
|
*/
|
|
1397
1397
|
value: string;
|
|
1398
1398
|
/** @constant */
|
|
@@ -1408,55 +1408,55 @@ interface components {
|
|
|
1408
1408
|
};
|
|
1409
1409
|
};
|
|
1410
1410
|
_dataResources?: components["schemas"]["DataResourceDefinitions"];
|
|
1411
|
-
/**
|
|
1411
|
+
/** Array of label public IDs assigned to this asset (max 30) */
|
|
1412
1412
|
labels?: string[];
|
|
1413
1413
|
};
|
|
1414
1414
|
AssetApiResponse: {
|
|
1415
1415
|
/**
|
|
1416
1416
|
* Format: uuid
|
|
1417
|
-
*
|
|
1417
|
+
* The project ID that this layout data is part of
|
|
1418
1418
|
*/
|
|
1419
1419
|
projectId: string;
|
|
1420
1420
|
/**
|
|
1421
1421
|
* Format: date-time
|
|
1422
|
-
*
|
|
1422
|
+
* Created date string for this definition
|
|
1423
1423
|
*/
|
|
1424
1424
|
created: string;
|
|
1425
1425
|
/**
|
|
1426
1426
|
* Format: date-time
|
|
1427
|
-
*
|
|
1427
|
+
* Modified date string for this definition
|
|
1428
1428
|
*/
|
|
1429
1429
|
modified: string;
|
|
1430
1430
|
/**
|
|
1431
1431
|
* Format: date-time
|
|
1432
|
-
*
|
|
1432
|
+
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
1433
1433
|
*/
|
|
1434
1434
|
deletedAt?: string;
|
|
1435
1435
|
/**
|
|
1436
1436
|
* Format: uuid
|
|
1437
|
-
*
|
|
1437
|
+
* The release this asset belongs to. If not set, the asset belongs to the base
|
|
1438
1438
|
*/
|
|
1439
1439
|
releaseId?: string;
|
|
1440
1440
|
asset: components["schemas"]["Asset"];
|
|
1441
|
-
/**
|
|
1441
|
+
/** Full label entities for UI rendering (only present when withAssignedLabels=true). Read-only. */
|
|
1442
1442
|
assignedLabels?: {
|
|
1443
1443
|
[key: string]: {
|
|
1444
1444
|
/** Format: uuid */
|
|
1445
1445
|
projectId: string;
|
|
1446
1446
|
label: {
|
|
1447
|
-
/**
|
|
1447
|
+
/** Public ID of the label (cannot be changed after creation) */
|
|
1448
1448
|
publicId: string;
|
|
1449
|
-
/**
|
|
1449
|
+
/** Human readable name of the label */
|
|
1450
1450
|
displayName: string;
|
|
1451
|
-
/**
|
|
1451
|
+
/** Whether this label is a group label (cannot be changed after creation) */
|
|
1452
1452
|
isGroup: boolean;
|
|
1453
|
-
/**
|
|
1453
|
+
/** Public ID of the parent group label */
|
|
1454
1454
|
parent?: string;
|
|
1455
|
-
/**
|
|
1455
|
+
/** Human readable color identifier */
|
|
1456
1456
|
color: string;
|
|
1457
|
-
/**
|
|
1457
|
+
/** Short description of what the label is about */
|
|
1458
1458
|
description?: string;
|
|
1459
|
-
/**
|
|
1459
|
+
/** Scope of the label (currently unused) */
|
|
1460
1460
|
scope: string[];
|
|
1461
1461
|
};
|
|
1462
1462
|
/** Format: date-time */
|
|
@@ -1470,26 +1470,26 @@ interface components {
|
|
|
1470
1470
|
};
|
|
1471
1471
|
AssetListResponse: {
|
|
1472
1472
|
assets: components["schemas"]["AssetApiResponse"][];
|
|
1473
|
-
/**
|
|
1473
|
+
/** Total number of assets that match the query. Only present when `withTotalCount` option is true */
|
|
1474
1474
|
totalCount?: number;
|
|
1475
|
-
/**
|
|
1475
|
+
/** Per-field counts for distinct values */
|
|
1476
1476
|
facets?: {
|
|
1477
1477
|
[key: string]: {
|
|
1478
1478
|
[key: string]: number;
|
|
1479
1479
|
};
|
|
1480
1480
|
};
|
|
1481
1481
|
};
|
|
1482
|
-
/**
|
|
1482
|
+
/** Defines a connection to a dynamic token on a data resource */
|
|
1483
1483
|
DataElementConnectionDefinition: {
|
|
1484
|
-
/**
|
|
1484
|
+
/** A JSON Pointer expression that defines the data resource dynamic token value */
|
|
1485
1485
|
pointer: string;
|
|
1486
1486
|
/**
|
|
1487
|
-
*
|
|
1488
|
-
|
|
1487
|
+
* The syntax used to select the dynamic token to bind to
|
|
1488
|
+
|
|
1489
1489
|
*/
|
|
1490
1490
|
syntax: "jptr";
|
|
1491
1491
|
/**
|
|
1492
|
-
*
|
|
1492
|
+
* The action to take if the dynamic token cannot be resolved
|
|
1493
1493
|
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
1494
1494
|
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
1495
1495
|
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
@@ -1499,68 +1499,68 @@ interface components {
|
|
|
1499
1499
|
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
1500
1500
|
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
1501
1501
|
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
1502
|
-
|
|
1502
|
+
|
|
1503
1503
|
*/
|
|
1504
1504
|
failureAction?: "t" | "p" | "c" | "a";
|
|
1505
1505
|
/**
|
|
1506
|
-
*
|
|
1506
|
+
* How to report when the dynamic token cannot be resolved
|
|
1507
1507
|
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
1508
1508
|
* - w: WARNING: Report a warning message [default]
|
|
1509
1509
|
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
1510
|
-
|
|
1510
|
+
|
|
1511
1511
|
*/
|
|
1512
1512
|
failureLogLevel?: "e" | "w" | "i";
|
|
1513
1513
|
/**
|
|
1514
|
-
*
|
|
1514
|
+
* The default value to use if the dynamic token cannot be resolved.
|
|
1515
1515
|
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
1516
1516
|
*/
|
|
1517
1517
|
failureDefault?: string;
|
|
1518
1518
|
};
|
|
1519
1519
|
/**
|
|
1520
1520
|
* @deprecated
|
|
1521
|
-
*
|
|
1521
|
+
* beta functionality subject to change
|
|
1522
1522
|
*/
|
|
1523
1523
|
VisibilityCriteria: {
|
|
1524
|
-
/**
|
|
1524
|
+
/** The rule type to execute */
|
|
1525
1525
|
rule: string;
|
|
1526
1526
|
/**
|
|
1527
|
-
*
|
|
1527
|
+
* The source value of the rule.
|
|
1528
1528
|
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
1529
1529
|
*/
|
|
1530
1530
|
source?: string;
|
|
1531
|
-
/**
|
|
1531
|
+
/** The rule-definition-specific operator to test against */
|
|
1532
1532
|
op: string;
|
|
1533
|
-
/**
|
|
1533
|
+
/** The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
1534
1534
|
value: string | string[];
|
|
1535
1535
|
};
|
|
1536
1536
|
/**
|
|
1537
1537
|
* @deprecated
|
|
1538
|
-
*
|
|
1538
|
+
* beta functionality subject to change
|
|
1539
1539
|
*/
|
|
1540
1540
|
VisibilityCriteriaGroup: {
|
|
1541
1541
|
/**
|
|
1542
|
-
*
|
|
1543
|
-
|
|
1542
|
+
* The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
1543
|
+
|
|
1544
1544
|
*/
|
|
1545
1545
|
op?: "&" | "|";
|
|
1546
1546
|
clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
|
|
1547
1547
|
};
|
|
1548
|
-
/**
|
|
1548
|
+
/** Defines a conditional value for a component parameter */
|
|
1549
1549
|
ComponentParameterConditionalValue: {
|
|
1550
1550
|
when: components["schemas"]["VisibilityCriteriaGroup"];
|
|
1551
1551
|
/**
|
|
1552
|
-
*
|
|
1552
|
+
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
1553
1553
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
1554
1554
|
*/
|
|
1555
1555
|
value: unknown;
|
|
1556
1556
|
/**
|
|
1557
|
-
*
|
|
1557
|
+
* Unique sequence identifier of the conditional value within the component parameter.
|
|
1558
1558
|
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
1559
1559
|
*/
|
|
1560
1560
|
id: number;
|
|
1561
1561
|
};
|
|
1562
1562
|
/**
|
|
1563
|
-
*
|
|
1563
|
+
* Array of alternate values which are based on conditions.
|
|
1564
1564
|
*
|
|
1565
1565
|
* When requested with an explicit locale parameter, or via the route API:
|
|
1566
1566
|
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
@@ -1570,64 +1570,64 @@ interface components {
|
|
|
1570
1570
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
1571
1571
|
*/
|
|
1572
1572
|
ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
|
|
1573
|
-
/**
|
|
1573
|
+
/** Defines an editable parameter on a component */
|
|
1574
1574
|
ComponentParameter: {
|
|
1575
|
-
/**
|
|
1575
|
+
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
1576
1576
|
value?: unknown;
|
|
1577
|
-
/**
|
|
1577
|
+
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
1578
1578
|
type: string;
|
|
1579
1579
|
/** @deprecated */
|
|
1580
1580
|
connectedData?: components["schemas"]["DataElementConnectionDefinition"];
|
|
1581
1581
|
/**
|
|
1582
|
-
*
|
|
1582
|
+
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
1583
1583
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
1584
1584
|
*/
|
|
1585
1585
|
locales?: {
|
|
1586
1586
|
[key: string]: unknown;
|
|
1587
1587
|
};
|
|
1588
1588
|
conditions?: components["schemas"]["ComponentParameterConditions"];
|
|
1589
|
-
/**
|
|
1589
|
+
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
1590
1590
|
localesConditions?: {
|
|
1591
1591
|
[key: string]: components["schemas"]["ComponentParameterConditions"];
|
|
1592
1592
|
};
|
|
1593
1593
|
};
|
|
1594
|
-
/**
|
|
1594
|
+
/** Variable values for a data resource */
|
|
1595
1595
|
DataResourceVariables: {
|
|
1596
1596
|
[key: string]: string;
|
|
1597
1597
|
};
|
|
1598
|
-
/**
|
|
1598
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
1599
1599
|
DataResourceDefinition: {
|
|
1600
|
-
/**
|
|
1600
|
+
/** Public ID of the data type that provides this data */
|
|
1601
1601
|
type: string;
|
|
1602
|
-
/**
|
|
1602
|
+
/** Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false */
|
|
1603
1603
|
isPatternParameter?: boolean;
|
|
1604
1604
|
/**
|
|
1605
|
-
*
|
|
1605
|
+
* When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
1606
1606
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
1607
1607
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
1608
1608
|
*/
|
|
1609
1609
|
ignorePatternParameterDefault?: boolean;
|
|
1610
1610
|
/**
|
|
1611
|
-
*
|
|
1611
|
+
* When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
1612
1612
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1613
1613
|
*/
|
|
1614
1614
|
optionalPatternParameter?: boolean;
|
|
1615
1615
|
variables?: components["schemas"]["DataResourceVariables"];
|
|
1616
1616
|
};
|
|
1617
1617
|
/**
|
|
1618
|
-
*
|
|
1618
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1619
1619
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1620
1620
|
*/
|
|
1621
1621
|
DataResourceDefinitions: {
|
|
1622
1622
|
[key: string]: components["schemas"]["DataResourceDefinition"];
|
|
1623
1623
|
};
|
|
1624
1624
|
Error: {
|
|
1625
|
-
/**
|
|
1625
|
+
/** Error message(s) that occurred while processing the request */
|
|
1626
1626
|
errorMessage?: string[] | string;
|
|
1627
1627
|
};
|
|
1628
1628
|
};
|
|
1629
1629
|
responses: {
|
|
1630
|
-
/**
|
|
1630
|
+
/** Request input validation failed */
|
|
1631
1631
|
BadRequestError: {
|
|
1632
1632
|
headers: {
|
|
1633
1633
|
[name: string]: unknown;
|
|
@@ -1636,7 +1636,7 @@ interface components {
|
|
|
1636
1636
|
"application/json": components["schemas"]["Error"];
|
|
1637
1637
|
};
|
|
1638
1638
|
};
|
|
1639
|
-
/**
|
|
1639
|
+
/** API key or token was not valid */
|
|
1640
1640
|
UnauthorizedError: {
|
|
1641
1641
|
headers: {
|
|
1642
1642
|
[name: string]: unknown;
|
|
@@ -1645,7 +1645,7 @@ interface components {
|
|
|
1645
1645
|
"application/json": components["schemas"]["Error"];
|
|
1646
1646
|
};
|
|
1647
1647
|
};
|
|
1648
|
-
/**
|
|
1648
|
+
/** Permission was denied */
|
|
1649
1649
|
ForbiddenError: {
|
|
1650
1650
|
headers: {
|
|
1651
1651
|
[name: string]: unknown;
|
|
@@ -1654,14 +1654,14 @@ interface components {
|
|
|
1654
1654
|
"application/json": components["schemas"]["Error"];
|
|
1655
1655
|
};
|
|
1656
1656
|
};
|
|
1657
|
-
/**
|
|
1657
|
+
/** Too many requests in allowed time period */
|
|
1658
1658
|
RateLimitError: {
|
|
1659
1659
|
headers: {
|
|
1660
1660
|
[name: string]: unknown;
|
|
1661
1661
|
};
|
|
1662
1662
|
content?: never;
|
|
1663
1663
|
};
|
|
1664
|
-
/**
|
|
1664
|
+
/** Execution error occurred */
|
|
1665
1665
|
InternalServerError: {
|
|
1666
1666
|
headers: {
|
|
1667
1667
|
[name: string]: unknown;
|
|
@@ -1670,51 +1670,51 @@ interface components {
|
|
|
1670
1670
|
};
|
|
1671
1671
|
};
|
|
1672
1672
|
parameters: {
|
|
1673
|
-
/**
|
|
1673
|
+
/** The project the asset/assets are on */
|
|
1674
1674
|
projectId: string;
|
|
1675
|
-
/**
|
|
1675
|
+
/** Specify a single asset ID to fetch */
|
|
1676
1676
|
assetId: string;
|
|
1677
|
-
/**
|
|
1677
|
+
/** Specify multiple asset IDs to fetch. Response type will be a list */
|
|
1678
1678
|
assetIDs: string[];
|
|
1679
|
-
/**
|
|
1679
|
+
/** The asset type ID to filter by */
|
|
1680
1680
|
type: ("image" | "video" | "audio" | "other")[];
|
|
1681
|
-
/**
|
|
1681
|
+
/** Number of records to skip */
|
|
1682
1682
|
offset: number;
|
|
1683
|
-
/**
|
|
1683
|
+
/** Max number of records to return */
|
|
1684
1684
|
limit: number;
|
|
1685
1685
|
/**
|
|
1686
|
-
*
|
|
1686
|
+
* Matches assets where their name or description contains the specified keyword.
|
|
1687
1687
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
1688
1688
|
*/
|
|
1689
1689
|
keyword: string;
|
|
1690
1690
|
/**
|
|
1691
1691
|
* @deprecated
|
|
1692
|
-
*
|
|
1692
|
+
* BETA: Semantic search using vector similarity to find assets by meaning.
|
|
1693
1693
|
* Use this for "images of mountains" style queries.
|
|
1694
1694
|
* Requires AI credits.
|
|
1695
1695
|
*/
|
|
1696
1696
|
searchSemantic: string;
|
|
1697
1697
|
/**
|
|
1698
|
-
*
|
|
1698
|
+
* Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1699
1699
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
|
|
1700
1700
|
*/
|
|
1701
1701
|
orderBy: string[];
|
|
1702
1702
|
/**
|
|
1703
1703
|
* @deprecated
|
|
1704
|
-
*
|
|
1704
|
+
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
1705
1705
|
*/
|
|
1706
1706
|
facetBy: string;
|
|
1707
|
-
/**
|
|
1707
|
+
/** Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
1708
1708
|
createdBy: string;
|
|
1709
|
-
/**
|
|
1709
|
+
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1710
1710
|
updatedBy: string;
|
|
1711
1711
|
/**
|
|
1712
|
-
*
|
|
1712
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1713
1713
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1714
1714
|
*/
|
|
1715
1715
|
withTotalCount: boolean;
|
|
1716
1716
|
/**
|
|
1717
|
-
*
|
|
1717
|
+
* The ID of a release to fetch the content for.
|
|
1718
1718
|
*
|
|
1719
1719
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1720
1720
|
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
@@ -1723,19 +1723,19 @@ interface components {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
releaseId: string;
|
|
1725
1725
|
/**
|
|
1726
|
-
*
|
|
1726
|
+
* When true, includes full label entities in the response for UI rendering.
|
|
1727
1727
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1728
1728
|
* This parameter is not supported with uniform.global.
|
|
1729
1729
|
*/
|
|
1730
1730
|
withAssignedLabels: boolean;
|
|
1731
1731
|
/**
|
|
1732
1732
|
* @deprecated
|
|
1733
|
-
*
|
|
1733
|
+
* Returns additional author and creator metadata for the asset.
|
|
1734
1734
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1735
1735
|
*/
|
|
1736
1736
|
withUIStatus: boolean;
|
|
1737
1737
|
/**
|
|
1738
|
-
*
|
|
1738
|
+
* Controls filtering of trashed items.
|
|
1739
1739
|
*
|
|
1740
1740
|
* exclude: (default) Only return items not in trash.
|
|
1741
1741
|
* only: Only return trashed items (for trash view).
|