@uniformdev/assets 20.74.6-alpha.6 → 20.74.6-alpha.7.sha-23d7a1d929
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 +418 -396
- package/dist/index.d.ts +418 -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,57 +338,62 @@ 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?: {
|
|
387
387
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
388
388
|
};
|
|
389
|
+
/**
|
|
390
|
+
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
391
|
+
* Means nothing for PUTs; it will be ignored
|
|
392
|
+
*/
|
|
393
|
+
_patternOptedInQueryStrings?: string[];
|
|
389
394
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
390
395
|
/**
|
|
391
|
-
*
|
|
396
|
+
* Defines patch overrides to component IDs that live in the composition.
|
|
392
397
|
* This can be used to override parameters that are defined on patterns,
|
|
393
398
|
* including nested patterns, with values that are specific to this composition.
|
|
394
399
|
* The keys in this object are component IDs.
|
|
@@ -403,66 +408,71 @@ interface components$1 {
|
|
|
403
408
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
404
409
|
};
|
|
405
410
|
/**
|
|
406
|
-
*
|
|
411
|
+
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
407
412
|
* Means nothing for PUTs; it will be ignored
|
|
408
413
|
*/
|
|
409
414
|
_patternOverrides?: {
|
|
410
415
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
411
416
|
};
|
|
412
417
|
/**
|
|
413
|
-
*
|
|
418
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
414
419
|
* by consumers of the pattern.
|
|
415
420
|
*
|
|
416
421
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
417
422
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
418
423
|
*/
|
|
419
424
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
420
|
-
/**
|
|
425
|
+
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
421
426
|
_locales?: string[];
|
|
422
427
|
};
|
|
423
|
-
/**
|
|
428
|
+
/** Defines the shape of the root component in a composition */
|
|
424
429
|
RootComponentInstance: {
|
|
425
|
-
/**
|
|
430
|
+
/** Type of the component instance (public_id of its definition) */
|
|
426
431
|
type: string;
|
|
427
|
-
/**
|
|
432
|
+
/** Component parameter values for the component instance */
|
|
428
433
|
parameters?: {
|
|
429
434
|
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
430
435
|
};
|
|
431
|
-
/**
|
|
436
|
+
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
432
437
|
variant?: string;
|
|
433
|
-
/**
|
|
438
|
+
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
434
439
|
projectMapNodes?: components$1["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
435
|
-
/**
|
|
440
|
+
/** Slots containing any child components */
|
|
436
441
|
slots?: {
|
|
437
442
|
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
438
443
|
};
|
|
439
|
-
/**
|
|
444
|
+
/** The ID of the composition */
|
|
440
445
|
_id: string;
|
|
441
|
-
/**
|
|
446
|
+
/** Slug pattern of this component */
|
|
442
447
|
_slug?: string | null;
|
|
443
|
-
/**
|
|
448
|
+
/** Friendly name of this component */
|
|
444
449
|
_name: string;
|
|
445
|
-
/**
|
|
450
|
+
/** Name of the author of the most recent change */
|
|
446
451
|
_author?: string;
|
|
447
|
-
/**
|
|
452
|
+
/** Identity subject of the author of the most recent change */
|
|
448
453
|
_authorSubject?: string;
|
|
449
|
-
/**
|
|
454
|
+
/** Name of the original creator */
|
|
450
455
|
_creator?: string;
|
|
451
|
-
/**
|
|
456
|
+
/** Identity subject of the original creator */
|
|
452
457
|
_creatorSubject?: string;
|
|
453
|
-
/**
|
|
458
|
+
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
454
459
|
_pattern?: string;
|
|
455
460
|
/**
|
|
456
|
-
*
|
|
461
|
+
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
457
462
|
* Means nothing for PUTs; it will be ignored
|
|
458
463
|
*/
|
|
459
464
|
_patternDataResources?: {
|
|
460
465
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
461
466
|
};
|
|
467
|
+
/**
|
|
468
|
+
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
469
|
+
* Means nothing for PUTs; it will be ignored
|
|
470
|
+
*/
|
|
471
|
+
_patternOptedInQueryStrings?: string[];
|
|
462
472
|
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
463
473
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
464
474
|
/**
|
|
465
|
-
*
|
|
475
|
+
* Defines patch overrides to component IDs that live in the composition.
|
|
466
476
|
* This can be used to override parameters that are defined on patterns,
|
|
467
477
|
* including nested patterns, with values that are specific to this composition.
|
|
468
478
|
* The keys in this object are component IDs.
|
|
@@ -477,25 +487,31 @@ interface components$1 {
|
|
|
477
487
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
478
488
|
};
|
|
479
489
|
/**
|
|
480
|
-
*
|
|
490
|
+
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
481
491
|
* Means nothing for PUTs; it will be ignored
|
|
482
492
|
*/
|
|
483
493
|
_patternOverrides?: {
|
|
484
494
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
485
495
|
};
|
|
486
496
|
/**
|
|
487
|
-
*
|
|
497
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
488
498
|
* by consumers of the pattern.
|
|
489
499
|
*
|
|
490
500
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
491
501
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
492
502
|
*/
|
|
493
503
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
494
|
-
/**
|
|
504
|
+
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
495
505
|
_locales?: string[];
|
|
506
|
+
/**
|
|
507
|
+
* Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
|
|
508
|
+
* Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
|
|
509
|
+
* holds only what was authored here. Omitted whenever overrides are resolved.
|
|
510
|
+
*/
|
|
511
|
+
_optedInQueryStrings?: string[];
|
|
496
512
|
};
|
|
497
513
|
/**
|
|
498
|
-
*
|
|
514
|
+
* Defines how to override a specific component.
|
|
499
515
|
*
|
|
500
516
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
501
517
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
@@ -509,7 +525,7 @@ interface components$1 {
|
|
|
509
525
|
};
|
|
510
526
|
variant?: string;
|
|
511
527
|
/**
|
|
512
|
-
*
|
|
528
|
+
* Overrides data resource definitions for a pattern component.
|
|
513
529
|
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
514
530
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
515
531
|
*/
|
|
@@ -518,371 +534,371 @@ interface components$1 {
|
|
|
518
534
|
};
|
|
519
535
|
};
|
|
520
536
|
/**
|
|
521
|
-
*
|
|
537
|
+
* Defines how a component on a pattern may have its values overridden.
|
|
522
538
|
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
523
539
|
*
|
|
524
540
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
525
541
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
526
542
|
*/
|
|
527
543
|
ComponentOverridability: {
|
|
528
|
-
/**
|
|
544
|
+
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
529
545
|
parameters?: {
|
|
530
546
|
[key: string]: components$1["schemas"]["OverrideOptions"];
|
|
531
547
|
};
|
|
532
|
-
/**
|
|
548
|
+
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
533
549
|
variants?: boolean;
|
|
534
550
|
/**
|
|
535
|
-
*
|
|
551
|
+
* If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
536
552
|
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
537
553
|
* If not set, the default is false
|
|
538
554
|
*/
|
|
539
555
|
hideLockedParameters?: boolean;
|
|
540
556
|
};
|
|
541
557
|
/**
|
|
542
|
-
*
|
|
558
|
+
* Whether a parameter is overridable
|
|
543
559
|
*
|
|
544
560
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
545
561
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
546
|
-
|
|
562
|
+
|
|
547
563
|
*/
|
|
548
564
|
OverrideOptions: "yes" | "no";
|
|
549
|
-
/**
|
|
565
|
+
/** Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
|
|
550
566
|
AlternativeDataSourceData: {
|
|
551
|
-
/**
|
|
567
|
+
/** Base resource URL of the data source. No trailing slash */
|
|
552
568
|
baseUrl: string;
|
|
553
|
-
/**
|
|
569
|
+
/** HTTP headers to pass with requests to the data source */
|
|
554
570
|
headers?: {
|
|
555
571
|
key: string;
|
|
556
572
|
value: string;
|
|
557
573
|
omitIfEmpty?: boolean;
|
|
558
574
|
}[];
|
|
559
|
-
/**
|
|
575
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
560
576
|
parameters?: {
|
|
561
577
|
key: string;
|
|
562
578
|
value: string;
|
|
563
579
|
omitIfEmpty?: boolean;
|
|
564
580
|
}[];
|
|
565
|
-
/**
|
|
581
|
+
/** Variables needed to make calls to the data source */
|
|
566
582
|
variables?: {
|
|
567
583
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
568
584
|
};
|
|
569
585
|
};
|
|
570
586
|
/**
|
|
571
|
-
*
|
|
587
|
+
* An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
572
588
|
* These are created in the UI and shared across a whole project.
|
|
573
589
|
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
574
590
|
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
575
591
|
*/
|
|
576
592
|
DataSource: {
|
|
577
|
-
/**
|
|
593
|
+
/** Public ID of the data source */
|
|
578
594
|
id: string;
|
|
579
|
-
/**
|
|
595
|
+
/** Display name of the data source */
|
|
580
596
|
displayName: string;
|
|
581
|
-
/**
|
|
597
|
+
/** The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
|
|
582
598
|
connectorType: string;
|
|
583
|
-
/**
|
|
599
|
+
/** Base resource URL of the data source. No trailing slash */
|
|
584
600
|
baseUrl: string;
|
|
585
|
-
/**
|
|
601
|
+
/** HTTP headers to pass with requests to the data source */
|
|
586
602
|
headers?: {
|
|
587
603
|
key: string;
|
|
588
604
|
value: string;
|
|
589
605
|
}[];
|
|
590
|
-
/**
|
|
606
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
591
607
|
parameters?: {
|
|
592
608
|
key: string;
|
|
593
609
|
value: string;
|
|
594
610
|
}[];
|
|
595
|
-
/**
|
|
611
|
+
/** Variables needed to make calls to the data source */
|
|
596
612
|
variables?: {
|
|
597
613
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
598
614
|
};
|
|
599
615
|
/**
|
|
600
|
-
*
|
|
616
|
+
* Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
601
617
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
602
618
|
*/
|
|
603
619
|
localeMapping?: {
|
|
604
620
|
[key: string]: string;
|
|
605
621
|
};
|
|
606
622
|
/**
|
|
607
|
-
*
|
|
623
|
+
* If true, data source will require additional credentials to access unpublished data.
|
|
608
624
|
* 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
625
|
*/
|
|
610
626
|
enableUnpublishedMode?: boolean;
|
|
611
|
-
/**
|
|
627
|
+
/** 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
628
|
customPublic?: {
|
|
613
629
|
[key: string]: unknown;
|
|
614
630
|
};
|
|
615
|
-
/**
|
|
631
|
+
/** 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
632
|
custom?: {
|
|
617
633
|
[key: string]: unknown;
|
|
618
634
|
};
|
|
619
|
-
/**
|
|
635
|
+
/** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
620
636
|
variants?: {
|
|
621
637
|
unpublished?: components$1["schemas"]["AlternativeDataSourceData"];
|
|
622
638
|
};
|
|
623
|
-
/**
|
|
639
|
+
/** Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
624
640
|
created?: string;
|
|
625
|
-
/**
|
|
641
|
+
/** Last modified date of the data source in ISO 8601 format (ignored for writes) */
|
|
626
642
|
modified?: string;
|
|
627
|
-
/**
|
|
643
|
+
/** User or API key ID that created the data source (ignored for writes) */
|
|
628
644
|
createdBy?: string;
|
|
629
|
-
/**
|
|
645
|
+
/** User or API key ID that last modified the data source (ignored for writes) */
|
|
630
646
|
modifiedBy?: string;
|
|
631
647
|
};
|
|
632
|
-
/**
|
|
648
|
+
/** 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
649
|
DataType: {
|
|
634
|
-
/**
|
|
650
|
+
/** Public ID of the data type */
|
|
635
651
|
id: string;
|
|
636
|
-
/**
|
|
652
|
+
/** Display name of the data type */
|
|
637
653
|
displayName: string;
|
|
638
|
-
/**
|
|
654
|
+
/** Public ID of the associated data source */
|
|
639
655
|
dataSourceId: string;
|
|
640
656
|
/**
|
|
641
|
-
*
|
|
657
|
+
* A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
642
658
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
643
659
|
* no special UI or processing is required
|
|
644
660
|
*/
|
|
645
661
|
archetype?: string;
|
|
646
662
|
allowedOnComponents?: string[];
|
|
647
|
-
/**
|
|
663
|
+
/** 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
664
|
path: string;
|
|
649
|
-
/**
|
|
665
|
+
/** Time-to-live (in seconds) for the resource data cache */
|
|
650
666
|
ttl?: number;
|
|
651
|
-
/**
|
|
667
|
+
/** A key for the resource data cache purging */
|
|
652
668
|
purgeKey?: string;
|
|
653
|
-
/**
|
|
669
|
+
/** 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
670
|
badgeIconUrl?: string;
|
|
655
|
-
/**
|
|
671
|
+
/** HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
656
672
|
headers?: {
|
|
657
673
|
key: string;
|
|
658
674
|
value: string;
|
|
659
675
|
omitIfEmpty?: boolean;
|
|
660
676
|
}[];
|
|
661
|
-
/**
|
|
677
|
+
/** Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
662
678
|
parameters?: {
|
|
663
679
|
key: string;
|
|
664
680
|
value: string;
|
|
665
681
|
omitIfEmpty?: boolean;
|
|
666
682
|
}[];
|
|
667
|
-
/**
|
|
683
|
+
/** Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
668
684
|
body?: string;
|
|
669
685
|
/**
|
|
670
|
-
*
|
|
671
|
-
* @
|
|
672
|
-
|
|
686
|
+
* HTTP method to use with requests to the data type
|
|
687
|
+
* @defaultValue GET
|
|
688
|
+
|
|
673
689
|
*/
|
|
674
690
|
method: "GET" | "POST" | "HEAD";
|
|
675
|
-
/**
|
|
691
|
+
/** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
676
692
|
variables?: {
|
|
677
693
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
678
694
|
};
|
|
679
|
-
/**
|
|
695
|
+
/** Custom configuration specific to the data source being defined */
|
|
680
696
|
custom?: {
|
|
681
697
|
[key: string]: unknown;
|
|
682
698
|
};
|
|
683
|
-
/**
|
|
699
|
+
/** Created date of the data type in ISO 8601 format (ignored for writes) */
|
|
684
700
|
created?: string;
|
|
685
|
-
/**
|
|
701
|
+
/** Last modified date of the data type in ISO 8601 format (ignored for writes) */
|
|
686
702
|
modified?: string;
|
|
687
|
-
/**
|
|
703
|
+
/** User or API key ID that created the data type (ignored for writes) */
|
|
688
704
|
createdBy?: string;
|
|
689
|
-
/**
|
|
705
|
+
/** User or API key ID that last modified the data type (ignored for writes) */
|
|
690
706
|
modifiedBy?: string;
|
|
691
707
|
};
|
|
692
|
-
/**
|
|
708
|
+
/** Defines the shape of a data variable on a Data Source or Data Type */
|
|
693
709
|
DataVariableDefinition: {
|
|
694
|
-
/**
|
|
710
|
+
/** Display name of the data variable */
|
|
695
711
|
displayName?: string;
|
|
696
|
-
/**
|
|
712
|
+
/** Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
697
713
|
helpText?: string;
|
|
698
714
|
/**
|
|
699
|
-
*
|
|
700
|
-
* @
|
|
715
|
+
* 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
|
|
716
|
+
* @defaultValue text
|
|
701
717
|
*/
|
|
702
718
|
type?: string;
|
|
703
|
-
/**
|
|
719
|
+
/** Default value of the data variable */
|
|
704
720
|
default: string;
|
|
705
|
-
/**
|
|
721
|
+
/** 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
722
|
order?: number;
|
|
707
723
|
/**
|
|
708
|
-
*
|
|
724
|
+
* An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
709
725
|
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
710
726
|
*/
|
|
711
727
|
source?: string;
|
|
712
728
|
};
|
|
713
729
|
/**
|
|
714
|
-
*
|
|
730
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
715
731
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
716
732
|
*/
|
|
717
733
|
DataResourceDefinitions: {
|
|
718
734
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
719
735
|
};
|
|
720
|
-
/**
|
|
736
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
721
737
|
DataResourceDefinition: {
|
|
722
|
-
/**
|
|
738
|
+
/** Public ID of the data type that provides this data */
|
|
723
739
|
type: string;
|
|
724
|
-
/**
|
|
740
|
+
/** 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
741
|
isPatternParameter?: boolean;
|
|
726
742
|
/**
|
|
727
|
-
*
|
|
743
|
+
* When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
728
744
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
729
745
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
730
746
|
*/
|
|
731
747
|
ignorePatternParameterDefault?: boolean;
|
|
732
748
|
/**
|
|
733
|
-
*
|
|
749
|
+
* When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
734
750
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
735
751
|
*/
|
|
736
752
|
optionalPatternParameter?: boolean;
|
|
737
753
|
variables?: components$1["schemas"]["DataResourceVariables"];
|
|
738
754
|
};
|
|
739
|
-
/**
|
|
755
|
+
/** Variable values for a data resource */
|
|
740
756
|
DataResourceVariables: {
|
|
741
757
|
[key: string]: string;
|
|
742
758
|
};
|
|
743
759
|
/**
|
|
744
|
-
*
|
|
760
|
+
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
745
761
|
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
746
762
|
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
747
763
|
* Means nothing for PUTs; it will be ignored
|
|
748
|
-
|
|
764
|
+
|
|
749
765
|
*/
|
|
750
766
|
PatternError: "NOTFOUND" | "CYCLIC";
|
|
751
767
|
HistoryApiResponse: {
|
|
752
768
|
/**
|
|
753
|
-
*
|
|
769
|
+
* 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
770
|
* If this is undefined then no more results are available
|
|
755
771
|
*/
|
|
756
772
|
cursor?: string;
|
|
757
|
-
/**
|
|
773
|
+
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
758
774
|
truncated?: boolean;
|
|
759
|
-
/**
|
|
775
|
+
/** Version history entries */
|
|
760
776
|
results?: components$1["schemas"]["HistoryEntry"][];
|
|
761
777
|
};
|
|
762
778
|
HistoryEntry: {
|
|
763
|
-
/**
|
|
779
|
+
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
764
780
|
versionId: string;
|
|
765
|
-
/**
|
|
781
|
+
/** The timestamp when the version was created in epoch milliseconds */
|
|
766
782
|
timestamp: number;
|
|
767
|
-
/**
|
|
783
|
+
/** The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
768
784
|
authorName: string;
|
|
769
785
|
authorIsApiKey: boolean;
|
|
770
|
-
/**
|
|
786
|
+
/** The identity who created the version; absent on old history entries. */
|
|
771
787
|
authorSubject?: string;
|
|
772
|
-
/**
|
|
788
|
+
/** The state of the entity when the history entry was made */
|
|
773
789
|
state: number;
|
|
774
790
|
};
|
|
775
|
-
/**
|
|
791
|
+
/** Category for tagging canvas entities */
|
|
776
792
|
Category: {
|
|
777
793
|
/**
|
|
778
794
|
* Format: uuid
|
|
779
|
-
*
|
|
795
|
+
* Unique identifier for the category
|
|
780
796
|
*/
|
|
781
797
|
id: string;
|
|
782
|
-
/**
|
|
798
|
+
/** Display name of the category */
|
|
783
799
|
name: string;
|
|
784
800
|
/**
|
|
785
|
-
*
|
|
786
|
-
* @
|
|
801
|
+
* 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
|
|
802
|
+
* @defaultValue 0
|
|
787
803
|
*/
|
|
788
804
|
order?: number;
|
|
789
805
|
};
|
|
790
|
-
/**
|
|
806
|
+
/** Project map node information related to a component */
|
|
791
807
|
CompositionProjectMapNodeInfo: {
|
|
792
808
|
/**
|
|
793
809
|
* Format: uuid
|
|
794
|
-
*
|
|
810
|
+
* Unique identifier for the project map node
|
|
795
811
|
*/
|
|
796
812
|
id: string;
|
|
797
813
|
/**
|
|
798
|
-
*
|
|
814
|
+
* Fallback path of the project map node.
|
|
799
815
|
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
800
816
|
*/
|
|
801
817
|
path: string;
|
|
802
818
|
/**
|
|
803
819
|
* Format: uuid
|
|
804
|
-
*
|
|
820
|
+
* Unique identifier for the project map that this node belongs to
|
|
805
821
|
*/
|
|
806
822
|
projectMapId: string;
|
|
807
823
|
data?: components$1["schemas"]["ProjectMapNodeData"];
|
|
808
824
|
/**
|
|
809
|
-
*
|
|
825
|
+
* Locale-specific paths of the project map node.
|
|
810
826
|
* Keys are locale codes
|
|
811
827
|
*/
|
|
812
828
|
locales?: {
|
|
813
829
|
[key: string]: {
|
|
814
|
-
/**
|
|
830
|
+
/** Locale-specific path of the project map node */
|
|
815
831
|
path: string;
|
|
816
|
-
/**
|
|
832
|
+
/** Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
817
833
|
inherited: boolean;
|
|
818
834
|
};
|
|
819
835
|
};
|
|
820
836
|
};
|
|
821
|
-
/**
|
|
837
|
+
/** AI Prompt definition */
|
|
822
838
|
Prompt: {
|
|
823
839
|
/**
|
|
824
840
|
* Format: uuid
|
|
825
|
-
*
|
|
841
|
+
* Unique identifier for the prompt
|
|
826
842
|
*/
|
|
827
843
|
id: string;
|
|
828
|
-
/**
|
|
844
|
+
/** Unique identifier for the integration that this prompt belongs to */
|
|
829
845
|
integrationType: string;
|
|
830
|
-
/**
|
|
846
|
+
/** Name for the prompt */
|
|
831
847
|
name?: string | null;
|
|
832
|
-
/**
|
|
848
|
+
/** Text for the prompt */
|
|
833
849
|
text?: string | null;
|
|
834
|
-
/**
|
|
850
|
+
/** Data for the prompt */
|
|
835
851
|
data?: {
|
|
836
852
|
[key: string]: unknown;
|
|
837
853
|
} | null;
|
|
838
|
-
/**
|
|
854
|
+
/** Turn off/on prompt */
|
|
839
855
|
enabled?: boolean | null;
|
|
840
|
-
/**
|
|
856
|
+
/** Integration default prompt */
|
|
841
857
|
builtIn?: boolean | null;
|
|
842
|
-
/**
|
|
858
|
+
/** Supported parameter types */
|
|
843
859
|
parameterTypes?: string[] | null;
|
|
844
860
|
};
|
|
845
|
-
/**
|
|
861
|
+
/** Definition of a workflow that can be assigned to entities */
|
|
846
862
|
WorkflowDefinition: {
|
|
847
863
|
/**
|
|
848
864
|
* Format: uuid
|
|
849
|
-
*
|
|
865
|
+
* Unique identifier of the workflow definition
|
|
850
866
|
*/
|
|
851
867
|
id: string;
|
|
852
|
-
/**
|
|
868
|
+
/** Workflow name */
|
|
853
869
|
name: string;
|
|
854
870
|
/**
|
|
855
871
|
* Format: uuid
|
|
856
|
-
*
|
|
872
|
+
* The ID of the initial stage in the stages object.
|
|
857
873
|
*/
|
|
858
874
|
initialStage: string;
|
|
859
|
-
/**
|
|
875
|
+
/** All stages of the workflow */
|
|
860
876
|
stages: {
|
|
861
877
|
[key: string]: components$1["schemas"]["WorkflowStage"];
|
|
862
878
|
};
|
|
863
|
-
/**
|
|
879
|
+
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
864
880
|
modified?: string;
|
|
865
|
-
/**
|
|
881
|
+
/** Created ISO date string for this definition (ignored for writes) */
|
|
866
882
|
created?: string;
|
|
867
883
|
/**
|
|
868
|
-
*
|
|
884
|
+
* Name of the original creator of the workflow.
|
|
869
885
|
* If undefined, the user has been removed from the team.
|
|
870
886
|
* Ignored for writes
|
|
871
887
|
*/
|
|
872
888
|
createdBy?: string;
|
|
873
889
|
/**
|
|
874
|
-
*
|
|
890
|
+
* Name of the last modifier of the workflow.
|
|
875
891
|
* If undefined, the user has been removed from the team.
|
|
876
892
|
* Ignored for writes
|
|
877
893
|
*/
|
|
878
894
|
modifiedBy?: string;
|
|
879
895
|
};
|
|
880
|
-
/**
|
|
896
|
+
/** Definition of a stage in a workflow */
|
|
881
897
|
WorkflowStage: {
|
|
882
|
-
/**
|
|
898
|
+
/** Name of the stage */
|
|
883
899
|
name: string;
|
|
884
900
|
/**
|
|
885
|
-
*
|
|
901
|
+
* Defines roles which have permissions to this workflow stage
|
|
886
902
|
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
887
903
|
* 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
904
|
* listed here, the stage is read-only and publishing is disabled
|
|
@@ -891,62 +907,62 @@ interface components$1 {
|
|
|
891
907
|
[key: string]: components$1["schemas"]["WorkflowStagePermission"];
|
|
892
908
|
};
|
|
893
909
|
/**
|
|
894
|
-
*
|
|
910
|
+
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
895
911
|
* 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
912
|
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
897
913
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
898
914
|
*/
|
|
899
915
|
autoPublish?: boolean;
|
|
900
916
|
/**
|
|
901
|
-
*
|
|
917
|
+
* When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
902
918
|
* If the entity is not valid, the transition will not be allowed.
|
|
903
919
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
904
920
|
*/
|
|
905
921
|
requireValidity?: boolean;
|
|
906
922
|
/**
|
|
907
|
-
*
|
|
923
|
+
* Defines transitions to other stages
|
|
908
924
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
909
925
|
* has a stage that can never be escaped
|
|
910
926
|
*/
|
|
911
927
|
transitions: components$1["schemas"]["WorkflowStageTransition"][];
|
|
912
928
|
/**
|
|
913
|
-
*
|
|
914
|
-
* @
|
|
929
|
+
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
930
|
+
* @defaultValue chevron-double-right-o
|
|
915
931
|
*/
|
|
916
932
|
icon?: string;
|
|
917
|
-
/**
|
|
933
|
+
/** 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
934
|
order?: number;
|
|
919
935
|
};
|
|
920
|
-
/**
|
|
936
|
+
/** Definition of a transition from one stage to another in a workflow */
|
|
921
937
|
WorkflowStageTransition: {
|
|
922
938
|
/**
|
|
923
939
|
* Format: uuid
|
|
924
|
-
*
|
|
940
|
+
* The target stage to transition to
|
|
925
941
|
*/
|
|
926
942
|
to: string;
|
|
927
943
|
/**
|
|
928
|
-
*
|
|
944
|
+
* Name shown to the user when they execute this transition.
|
|
929
945
|
* If not provided, a default name will be assigned automatically based on the target stage
|
|
930
946
|
*/
|
|
931
947
|
name: string;
|
|
932
948
|
/**
|
|
933
|
-
*
|
|
949
|
+
* Permissions for the stage transition.
|
|
934
950
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
935
951
|
*/
|
|
936
952
|
permissions: {
|
|
937
953
|
[key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
|
|
938
954
|
};
|
|
939
955
|
};
|
|
940
|
-
/**
|
|
956
|
+
/** Permissions for a workflow stage */
|
|
941
957
|
WorkflowStagePermission: {
|
|
942
|
-
/**
|
|
958
|
+
/** Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
943
959
|
write?: boolean;
|
|
944
|
-
/**
|
|
960
|
+
/** Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
945
961
|
publish?: boolean;
|
|
946
962
|
};
|
|
947
|
-
/**
|
|
963
|
+
/** Permissions for a workflow stage transition */
|
|
948
964
|
WorkflowStageTransitionPermission: {
|
|
949
|
-
/**
|
|
965
|
+
/** 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
966
|
execute?: boolean;
|
|
951
967
|
};
|
|
952
968
|
/** @enum {string} */
|
|
@@ -954,34 +970,40 @@ interface components$1 {
|
|
|
954
970
|
/** @enum {string} */
|
|
955
971
|
ReleaseScheduleState: "scheduled" | "unscheduled";
|
|
956
972
|
ProjectMapNodeAllowedQueryString: {
|
|
957
|
-
/**
|
|
973
|
+
/** The name of the query string parameter */
|
|
958
974
|
name: string;
|
|
959
|
-
/**
|
|
975
|
+
/** The default value of the query string if it is not provided by an incoming route path */
|
|
960
976
|
value?: string;
|
|
961
|
-
/**
|
|
977
|
+
/** Help text for authors who might be setting up a preview value for this query string */
|
|
962
978
|
helpText?: string;
|
|
963
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Controls whether a global query string is always shown in Canvas or must be opted into.
|
|
981
|
+
* This property is ignored on node-level query strings. When omitted, the query string is always shown.
|
|
982
|
+
|
|
983
|
+
*/
|
|
984
|
+
editorVisibility?: "opt-in";
|
|
985
|
+
/** Configuration for providing a list of allowed values for this query string */
|
|
964
986
|
optionsSource?: {
|
|
965
987
|
/**
|
|
966
|
-
*
|
|
967
|
-
|
|
988
|
+
* The source type for the options
|
|
989
|
+
|
|
968
990
|
*/
|
|
969
991
|
source: "static";
|
|
970
992
|
options: {
|
|
971
|
-
/**
|
|
993
|
+
/** Display name for the option */
|
|
972
994
|
name: string;
|
|
973
|
-
/**
|
|
995
|
+
/** The actual value to be used */
|
|
974
996
|
value: string;
|
|
975
997
|
}[];
|
|
976
998
|
};
|
|
977
999
|
};
|
|
978
1000
|
ProjectMapNodeData: {
|
|
979
|
-
/**
|
|
1001
|
+
/** 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
1002
|
isSearchHit?: boolean;
|
|
981
|
-
/**
|
|
1003
|
+
/** Query strings that are allowed to be passed to the node */
|
|
982
1004
|
queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
983
1005
|
/**
|
|
984
|
-
*
|
|
1006
|
+
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
985
1007
|
* The preview value is used when editing a connected composition, and is the default
|
|
986
1008
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
987
1009
|
*/
|
|
@@ -1004,7 +1026,7 @@ interface paths {
|
|
|
1004
1026
|
cookie?: never;
|
|
1005
1027
|
};
|
|
1006
1028
|
/**
|
|
1007
|
-
*
|
|
1029
|
+
* In addition to the named parameters below, this endpoint accepts the
|
|
1008
1030
|
* following query parameter convention which is pattern-validated and
|
|
1009
1031
|
* therefore not declared as named parameters:
|
|
1010
1032
|
*
|
|
@@ -1058,51 +1080,51 @@ interface paths {
|
|
|
1058
1080
|
get: {
|
|
1059
1081
|
parameters: {
|
|
1060
1082
|
query: {
|
|
1061
|
-
/**
|
|
1083
|
+
/** Specify a single asset ID to fetch */
|
|
1062
1084
|
assetId?: components["parameters"]["assetId"];
|
|
1063
|
-
/**
|
|
1085
|
+
/** Specify multiple asset IDs to fetch. Response type will be a list */
|
|
1064
1086
|
assetIDs?: components["parameters"]["assetIDs"];
|
|
1065
|
-
/**
|
|
1087
|
+
/** Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
1066
1088
|
createdBy?: components["parameters"]["createdBy"];
|
|
1067
1089
|
/**
|
|
1068
|
-
*
|
|
1090
|
+
* Matches assets where their name or description contains the specified keyword.
|
|
1069
1091
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
1070
1092
|
*/
|
|
1071
1093
|
keyword?: components["parameters"]["keyword"];
|
|
1072
1094
|
/**
|
|
1073
1095
|
* @deprecated
|
|
1074
|
-
*
|
|
1096
|
+
* BETA: Semantic search using vector similarity to find assets by meaning.
|
|
1075
1097
|
* Use this for "images of mountains" style queries.
|
|
1076
1098
|
* Requires AI credits.
|
|
1077
1099
|
*/
|
|
1078
1100
|
searchSemantic?: components["parameters"]["searchSemantic"];
|
|
1079
|
-
/**
|
|
1101
|
+
/** Max number of records to return */
|
|
1080
1102
|
limit?: components["parameters"]["limit"];
|
|
1081
|
-
/**
|
|
1103
|
+
/** Number of records to skip */
|
|
1082
1104
|
offset?: components["parameters"]["offset"];
|
|
1083
1105
|
/**
|
|
1084
|
-
*
|
|
1106
|
+
* Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1085
1107
|
* 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
1108
|
*/
|
|
1087
1109
|
orderBy?: components["parameters"]["orderBy"];
|
|
1088
1110
|
/**
|
|
1089
1111
|
* @deprecated
|
|
1090
|
-
*
|
|
1112
|
+
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
1091
1113
|
*/
|
|
1092
1114
|
facetBy?: components["parameters"]["facetBy"];
|
|
1093
|
-
/**
|
|
1115
|
+
/** The project the asset/assets are on */
|
|
1094
1116
|
projectId: components["parameters"]["projectId"];
|
|
1095
|
-
/**
|
|
1117
|
+
/** The asset type ID to filter by */
|
|
1096
1118
|
type?: components["parameters"]["type"];
|
|
1097
|
-
/**
|
|
1119
|
+
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1098
1120
|
updatedBy?: components["parameters"]["updatedBy"];
|
|
1099
1121
|
/**
|
|
1100
|
-
*
|
|
1122
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1101
1123
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1102
1124
|
*/
|
|
1103
1125
|
withTotalCount?: components["parameters"]["withTotalCount"];
|
|
1104
1126
|
/**
|
|
1105
|
-
*
|
|
1127
|
+
* The ID of a release to fetch the content for.
|
|
1106
1128
|
*
|
|
1107
1129
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1108
1130
|
* - 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 +1133,19 @@ interface paths {
|
|
|
1111
1133
|
*/
|
|
1112
1134
|
releaseId?: components["parameters"]["releaseId"];
|
|
1113
1135
|
/**
|
|
1114
|
-
*
|
|
1136
|
+
* When true, includes full label entities in the response for UI rendering.
|
|
1115
1137
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1116
1138
|
* This parameter is not supported with uniform.global.
|
|
1117
1139
|
*/
|
|
1118
1140
|
withAssignedLabels?: components["parameters"]["withAssignedLabels"];
|
|
1119
1141
|
/**
|
|
1120
1142
|
* @deprecated
|
|
1121
|
-
*
|
|
1143
|
+
* Returns additional author and creator metadata for the asset.
|
|
1122
1144
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1123
1145
|
*/
|
|
1124
1146
|
withUIStatus?: components["parameters"]["withUIStatus"];
|
|
1125
1147
|
/**
|
|
1126
|
-
*
|
|
1148
|
+
* Controls filtering of trashed items.
|
|
1127
1149
|
*
|
|
1128
1150
|
* exclude: (default) Only return items not in trash.
|
|
1129
1151
|
* only: Only return trashed items (for trash view).
|
|
@@ -1137,7 +1159,7 @@ interface paths {
|
|
|
1137
1159
|
};
|
|
1138
1160
|
requestBody?: never;
|
|
1139
1161
|
responses: {
|
|
1140
|
-
/**
|
|
1162
|
+
/** OK */
|
|
1141
1163
|
200: {
|
|
1142
1164
|
headers: {
|
|
1143
1165
|
[name: string]: unknown;
|
|
@@ -1149,14 +1171,14 @@ interface paths {
|
|
|
1149
1171
|
400: components["responses"]["BadRequestError"];
|
|
1150
1172
|
401: components["responses"]["UnauthorizedError"];
|
|
1151
1173
|
403: components["responses"]["ForbiddenError"];
|
|
1152
|
-
/**
|
|
1174
|
+
/** Asset not found */
|
|
1153
1175
|
404: {
|
|
1154
1176
|
headers: {
|
|
1155
1177
|
[name: string]: unknown;
|
|
1156
1178
|
};
|
|
1157
1179
|
content: {
|
|
1158
1180
|
"application/json": {
|
|
1159
|
-
/**
|
|
1181
|
+
/** The error message */
|
|
1160
1182
|
errorMessage: string;
|
|
1161
1183
|
};
|
|
1162
1184
|
};
|
|
@@ -1166,7 +1188,7 @@ interface paths {
|
|
|
1166
1188
|
};
|
|
1167
1189
|
};
|
|
1168
1190
|
/**
|
|
1169
|
-
*
|
|
1191
|
+
* Creates or updates assets. Submitting the ID of a trashed asset restores it.
|
|
1170
1192
|
* A file-backed asset must include its original file reference when restored.
|
|
1171
1193
|
*/
|
|
1172
1194
|
put: {
|
|
@@ -1181,12 +1203,12 @@ interface paths {
|
|
|
1181
1203
|
"application/json": {
|
|
1182
1204
|
/**
|
|
1183
1205
|
* Format: uuid
|
|
1184
|
-
*
|
|
1206
|
+
* The project ID to upsert the asset to
|
|
1185
1207
|
*/
|
|
1186
1208
|
projectId: string;
|
|
1187
1209
|
/**
|
|
1188
1210
|
* Format: uuid
|
|
1189
|
-
*
|
|
1211
|
+
* The release ID to upsert the asset to. If unspecified the asset belongs to the base
|
|
1190
1212
|
*/
|
|
1191
1213
|
releaseId?: string;
|
|
1192
1214
|
asset?: components["schemas"]["AssetInput"];
|
|
@@ -1195,7 +1217,7 @@ interface paths {
|
|
|
1195
1217
|
};
|
|
1196
1218
|
};
|
|
1197
1219
|
responses: {
|
|
1198
|
-
/**
|
|
1220
|
+
/** OK */
|
|
1199
1221
|
204: {
|
|
1200
1222
|
headers: {
|
|
1201
1223
|
[name: string]: unknown;
|
|
@@ -1211,7 +1233,7 @@ interface paths {
|
|
|
1211
1233
|
};
|
|
1212
1234
|
post?: never;
|
|
1213
1235
|
/**
|
|
1214
|
-
*
|
|
1236
|
+
* Moves an asset to trash. Trashed assets are omitted from default GET results and
|
|
1215
1237
|
* permanently deleted after the configured retention period.
|
|
1216
1238
|
*/
|
|
1217
1239
|
delete: {
|
|
@@ -1226,17 +1248,17 @@ interface paths {
|
|
|
1226
1248
|
"application/json": {
|
|
1227
1249
|
/**
|
|
1228
1250
|
* Format: uuid
|
|
1229
|
-
*
|
|
1251
|
+
* The ID of the asset to move to trash
|
|
1230
1252
|
*/
|
|
1231
1253
|
assetId: string;
|
|
1232
1254
|
/**
|
|
1233
1255
|
* Format: uuid
|
|
1234
|
-
*
|
|
1256
|
+
* The ID of the project the asset belongs to
|
|
1235
1257
|
*/
|
|
1236
1258
|
projectId: string;
|
|
1237
1259
|
/**
|
|
1238
1260
|
* Format: uuid
|
|
1239
|
-
*
|
|
1261
|
+
* The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
|
|
1240
1262
|
* Note: deleting an asset from a release will not delete the asset from the base
|
|
1241
1263
|
*/
|
|
1242
1264
|
releaseId?: string;
|
|
@@ -1244,7 +1266,7 @@ interface paths {
|
|
|
1244
1266
|
};
|
|
1245
1267
|
};
|
|
1246
1268
|
responses: {
|
|
1247
|
-
/**
|
|
1269
|
+
/** OK */
|
|
1248
1270
|
204: {
|
|
1249
1271
|
headers: {
|
|
1250
1272
|
[name: string]: unknown;
|
|
@@ -1258,7 +1280,7 @@ interface paths {
|
|
|
1258
1280
|
500: components["responses"]["InternalServerError"];
|
|
1259
1281
|
};
|
|
1260
1282
|
};
|
|
1261
|
-
/**
|
|
1283
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
1262
1284
|
options: {
|
|
1263
1285
|
parameters: {
|
|
1264
1286
|
query?: never;
|
|
@@ -1268,7 +1290,7 @@ interface paths {
|
|
|
1268
1290
|
};
|
|
1269
1291
|
requestBody?: never;
|
|
1270
1292
|
responses: {
|
|
1271
|
-
/**
|
|
1293
|
+
/** OK */
|
|
1272
1294
|
204: {
|
|
1273
1295
|
headers: {
|
|
1274
1296
|
[name: string]: unknown;
|
|
@@ -1284,24 +1306,24 @@ interface paths {
|
|
|
1284
1306
|
}
|
|
1285
1307
|
interface components {
|
|
1286
1308
|
schemas: {
|
|
1287
|
-
/**
|
|
1309
|
+
/** Defines the shape of the asset */
|
|
1288
1310
|
Asset: {
|
|
1289
|
-
/**
|
|
1311
|
+
/** Asset type of the asset */
|
|
1290
1312
|
type: string;
|
|
1291
1313
|
/**
|
|
1292
1314
|
* Format: uuid
|
|
1293
|
-
*
|
|
1315
|
+
* The public UUID of the asset
|
|
1294
1316
|
*/
|
|
1295
1317
|
_id: string;
|
|
1296
|
-
/**
|
|
1318
|
+
/** The name of the asset */
|
|
1297
1319
|
_name: string;
|
|
1298
|
-
/**
|
|
1320
|
+
/** Name of the author of the most recent change */
|
|
1299
1321
|
_author?: string;
|
|
1300
|
-
/**
|
|
1322
|
+
/** Identity subject of the author of the most recent change */
|
|
1301
1323
|
_authorSubject?: string;
|
|
1302
|
-
/**
|
|
1324
|
+
/** Name of the original creator */
|
|
1303
1325
|
_creator?: string;
|
|
1304
|
-
/**
|
|
1326
|
+
/** Identity subject of the original creator */
|
|
1305
1327
|
_creatorSubject?: string;
|
|
1306
1328
|
fields?: {
|
|
1307
1329
|
title?: {
|
|
@@ -1314,11 +1336,11 @@ interface components {
|
|
|
1314
1336
|
/** @constant */
|
|
1315
1337
|
type: "text";
|
|
1316
1338
|
};
|
|
1317
|
-
/**
|
|
1339
|
+
/** An asset can reference at most one file. A file can be attached to only one asset. */
|
|
1318
1340
|
file?: {
|
|
1319
1341
|
/**
|
|
1320
1342
|
* Format: uuid
|
|
1321
|
-
*
|
|
1343
|
+
* File ID to attach. A trashed file cannot be attached to an active asset.
|
|
1322
1344
|
*/
|
|
1323
1345
|
value: string;
|
|
1324
1346
|
/** @constant */
|
|
@@ -1357,25 +1379,25 @@ interface components {
|
|
|
1357
1379
|
/** @constant */
|
|
1358
1380
|
type: "focalPoint";
|
|
1359
1381
|
};
|
|
1360
|
-
/**
|
|
1382
|
+
/** Asset field values */
|
|
1361
1383
|
custom?: {
|
|
1362
1384
|
[key: string]: components["schemas"]["ComponentParameter"];
|
|
1363
1385
|
};
|
|
1364
1386
|
};
|
|
1365
1387
|
_dataResources?: components["schemas"]["DataResourceDefinitions"];
|
|
1366
|
-
/**
|
|
1388
|
+
/** Array of label public IDs assigned to this asset (max 30) */
|
|
1367
1389
|
labels?: string[];
|
|
1368
1390
|
};
|
|
1369
|
-
/**
|
|
1391
|
+
/** Defines the shape of the asset input */
|
|
1370
1392
|
AssetInput: {
|
|
1371
|
-
/**
|
|
1393
|
+
/** Content type of the asset */
|
|
1372
1394
|
type?: string;
|
|
1373
1395
|
/**
|
|
1374
1396
|
* Format: uuid
|
|
1375
|
-
*
|
|
1397
|
+
* The public UUID of the asset
|
|
1376
1398
|
*/
|
|
1377
1399
|
_id?: string;
|
|
1378
|
-
/**
|
|
1400
|
+
/** The internal name of the asset */
|
|
1379
1401
|
_name?: string;
|
|
1380
1402
|
fields?: {
|
|
1381
1403
|
title?: {
|
|
@@ -1388,11 +1410,11 @@ interface components {
|
|
|
1388
1410
|
/** @constant */
|
|
1389
1411
|
type: "text";
|
|
1390
1412
|
};
|
|
1391
|
-
/**
|
|
1413
|
+
/** An asset can reference at most one file. A file can be attached to only one asset. */
|
|
1392
1414
|
file?: {
|
|
1393
1415
|
/**
|
|
1394
1416
|
* Format: uuid
|
|
1395
|
-
*
|
|
1417
|
+
* File ID to attach. A trashed file cannot be attached to an active asset.
|
|
1396
1418
|
*/
|
|
1397
1419
|
value: string;
|
|
1398
1420
|
/** @constant */
|
|
@@ -1408,55 +1430,55 @@ interface components {
|
|
|
1408
1430
|
};
|
|
1409
1431
|
};
|
|
1410
1432
|
_dataResources?: components["schemas"]["DataResourceDefinitions"];
|
|
1411
|
-
/**
|
|
1433
|
+
/** Array of label public IDs assigned to this asset (max 30) */
|
|
1412
1434
|
labels?: string[];
|
|
1413
1435
|
};
|
|
1414
1436
|
AssetApiResponse: {
|
|
1415
1437
|
/**
|
|
1416
1438
|
* Format: uuid
|
|
1417
|
-
*
|
|
1439
|
+
* The project ID that this layout data is part of
|
|
1418
1440
|
*/
|
|
1419
1441
|
projectId: string;
|
|
1420
1442
|
/**
|
|
1421
1443
|
* Format: date-time
|
|
1422
|
-
*
|
|
1444
|
+
* Created date string for this definition
|
|
1423
1445
|
*/
|
|
1424
1446
|
created: string;
|
|
1425
1447
|
/**
|
|
1426
1448
|
* Format: date-time
|
|
1427
|
-
*
|
|
1449
|
+
* Modified date string for this definition
|
|
1428
1450
|
*/
|
|
1429
1451
|
modified: string;
|
|
1430
1452
|
/**
|
|
1431
1453
|
* Format: date-time
|
|
1432
|
-
*
|
|
1454
|
+
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
1433
1455
|
*/
|
|
1434
1456
|
deletedAt?: string;
|
|
1435
1457
|
/**
|
|
1436
1458
|
* Format: uuid
|
|
1437
|
-
*
|
|
1459
|
+
* The release this asset belongs to. If not set, the asset belongs to the base
|
|
1438
1460
|
*/
|
|
1439
1461
|
releaseId?: string;
|
|
1440
1462
|
asset: components["schemas"]["Asset"];
|
|
1441
|
-
/**
|
|
1463
|
+
/** Full label entities for UI rendering (only present when withAssignedLabels=true). Read-only. */
|
|
1442
1464
|
assignedLabels?: {
|
|
1443
1465
|
[key: string]: {
|
|
1444
1466
|
/** Format: uuid */
|
|
1445
1467
|
projectId: string;
|
|
1446
1468
|
label: {
|
|
1447
|
-
/**
|
|
1469
|
+
/** Public ID of the label (cannot be changed after creation) */
|
|
1448
1470
|
publicId: string;
|
|
1449
|
-
/**
|
|
1471
|
+
/** Human readable name of the label */
|
|
1450
1472
|
displayName: string;
|
|
1451
|
-
/**
|
|
1473
|
+
/** Whether this label is a group label (cannot be changed after creation) */
|
|
1452
1474
|
isGroup: boolean;
|
|
1453
|
-
/**
|
|
1475
|
+
/** Public ID of the parent group label */
|
|
1454
1476
|
parent?: string;
|
|
1455
|
-
/**
|
|
1477
|
+
/** Human readable color identifier */
|
|
1456
1478
|
color: string;
|
|
1457
|
-
/**
|
|
1479
|
+
/** Short description of what the label is about */
|
|
1458
1480
|
description?: string;
|
|
1459
|
-
/**
|
|
1481
|
+
/** Scope of the label (currently unused) */
|
|
1460
1482
|
scope: string[];
|
|
1461
1483
|
};
|
|
1462
1484
|
/** Format: date-time */
|
|
@@ -1470,26 +1492,26 @@ interface components {
|
|
|
1470
1492
|
};
|
|
1471
1493
|
AssetListResponse: {
|
|
1472
1494
|
assets: components["schemas"]["AssetApiResponse"][];
|
|
1473
|
-
/**
|
|
1495
|
+
/** Total number of assets that match the query. Only present when `withTotalCount` option is true */
|
|
1474
1496
|
totalCount?: number;
|
|
1475
|
-
/**
|
|
1497
|
+
/** Per-field counts for distinct values */
|
|
1476
1498
|
facets?: {
|
|
1477
1499
|
[key: string]: {
|
|
1478
1500
|
[key: string]: number;
|
|
1479
1501
|
};
|
|
1480
1502
|
};
|
|
1481
1503
|
};
|
|
1482
|
-
/**
|
|
1504
|
+
/** Defines a connection to a dynamic token on a data resource */
|
|
1483
1505
|
DataElementConnectionDefinition: {
|
|
1484
|
-
/**
|
|
1506
|
+
/** A JSON Pointer expression that defines the data resource dynamic token value */
|
|
1485
1507
|
pointer: string;
|
|
1486
1508
|
/**
|
|
1487
|
-
*
|
|
1488
|
-
|
|
1509
|
+
* The syntax used to select the dynamic token to bind to
|
|
1510
|
+
|
|
1489
1511
|
*/
|
|
1490
1512
|
syntax: "jptr";
|
|
1491
1513
|
/**
|
|
1492
|
-
*
|
|
1514
|
+
* The action to take if the dynamic token cannot be resolved
|
|
1493
1515
|
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
1494
1516
|
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
1495
1517
|
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
@@ -1499,68 +1521,68 @@ interface components {
|
|
|
1499
1521
|
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
1500
1522
|
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
1501
1523
|
* - 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
|
-
|
|
1524
|
+
|
|
1503
1525
|
*/
|
|
1504
1526
|
failureAction?: "t" | "p" | "c" | "a";
|
|
1505
1527
|
/**
|
|
1506
|
-
*
|
|
1528
|
+
* How to report when the dynamic token cannot be resolved
|
|
1507
1529
|
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
1508
1530
|
* - w: WARNING: Report a warning message [default]
|
|
1509
1531
|
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
1510
|
-
|
|
1532
|
+
|
|
1511
1533
|
*/
|
|
1512
1534
|
failureLogLevel?: "e" | "w" | "i";
|
|
1513
1535
|
/**
|
|
1514
|
-
*
|
|
1536
|
+
* The default value to use if the dynamic token cannot be resolved.
|
|
1515
1537
|
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
1516
1538
|
*/
|
|
1517
1539
|
failureDefault?: string;
|
|
1518
1540
|
};
|
|
1519
1541
|
/**
|
|
1520
1542
|
* @deprecated
|
|
1521
|
-
*
|
|
1543
|
+
* beta functionality subject to change
|
|
1522
1544
|
*/
|
|
1523
1545
|
VisibilityCriteria: {
|
|
1524
|
-
/**
|
|
1546
|
+
/** The rule type to execute */
|
|
1525
1547
|
rule: string;
|
|
1526
1548
|
/**
|
|
1527
|
-
*
|
|
1549
|
+
* The source value of the rule.
|
|
1528
1550
|
* 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
1551
|
*/
|
|
1530
1552
|
source?: string;
|
|
1531
|
-
/**
|
|
1553
|
+
/** The rule-definition-specific operator to test against */
|
|
1532
1554
|
op: string;
|
|
1533
|
-
/**
|
|
1555
|
+
/** 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
1556
|
value: string | string[];
|
|
1535
1557
|
};
|
|
1536
1558
|
/**
|
|
1537
1559
|
* @deprecated
|
|
1538
|
-
*
|
|
1560
|
+
* beta functionality subject to change
|
|
1539
1561
|
*/
|
|
1540
1562
|
VisibilityCriteriaGroup: {
|
|
1541
1563
|
/**
|
|
1542
|
-
*
|
|
1543
|
-
|
|
1564
|
+
* The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
1565
|
+
|
|
1544
1566
|
*/
|
|
1545
1567
|
op?: "&" | "|";
|
|
1546
1568
|
clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
|
|
1547
1569
|
};
|
|
1548
|
-
/**
|
|
1570
|
+
/** Defines a conditional value for a component parameter */
|
|
1549
1571
|
ComponentParameterConditionalValue: {
|
|
1550
1572
|
when: components["schemas"]["VisibilityCriteriaGroup"];
|
|
1551
1573
|
/**
|
|
1552
|
-
*
|
|
1574
|
+
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
1553
1575
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
1554
1576
|
*/
|
|
1555
1577
|
value: unknown;
|
|
1556
1578
|
/**
|
|
1557
|
-
*
|
|
1579
|
+
* Unique sequence identifier of the conditional value within the component parameter.
|
|
1558
1580
|
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
1559
1581
|
*/
|
|
1560
1582
|
id: number;
|
|
1561
1583
|
};
|
|
1562
1584
|
/**
|
|
1563
|
-
*
|
|
1585
|
+
* Array of alternate values which are based on conditions.
|
|
1564
1586
|
*
|
|
1565
1587
|
* When requested with an explicit locale parameter, or via the route API:
|
|
1566
1588
|
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
@@ -1570,64 +1592,64 @@ interface components {
|
|
|
1570
1592
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
1571
1593
|
*/
|
|
1572
1594
|
ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
|
|
1573
|
-
/**
|
|
1595
|
+
/** Defines an editable parameter on a component */
|
|
1574
1596
|
ComponentParameter: {
|
|
1575
|
-
/**
|
|
1597
|
+
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
1576
1598
|
value?: unknown;
|
|
1577
|
-
/**
|
|
1599
|
+
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
1578
1600
|
type: string;
|
|
1579
1601
|
/** @deprecated */
|
|
1580
1602
|
connectedData?: components["schemas"]["DataElementConnectionDefinition"];
|
|
1581
1603
|
/**
|
|
1582
|
-
*
|
|
1604
|
+
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
1583
1605
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
1584
1606
|
*/
|
|
1585
1607
|
locales?: {
|
|
1586
1608
|
[key: string]: unknown;
|
|
1587
1609
|
};
|
|
1588
1610
|
conditions?: components["schemas"]["ComponentParameterConditions"];
|
|
1589
|
-
/**
|
|
1611
|
+
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
1590
1612
|
localesConditions?: {
|
|
1591
1613
|
[key: string]: components["schemas"]["ComponentParameterConditions"];
|
|
1592
1614
|
};
|
|
1593
1615
|
};
|
|
1594
|
-
/**
|
|
1616
|
+
/** Variable values for a data resource */
|
|
1595
1617
|
DataResourceVariables: {
|
|
1596
1618
|
[key: string]: string;
|
|
1597
1619
|
};
|
|
1598
|
-
/**
|
|
1620
|
+
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
1599
1621
|
DataResourceDefinition: {
|
|
1600
|
-
/**
|
|
1622
|
+
/** Public ID of the data type that provides this data */
|
|
1601
1623
|
type: string;
|
|
1602
|
-
/**
|
|
1624
|
+
/** 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
1625
|
isPatternParameter?: boolean;
|
|
1604
1626
|
/**
|
|
1605
|
-
*
|
|
1627
|
+
* When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
1606
1628
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
1607
1629
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
1608
1630
|
*/
|
|
1609
1631
|
ignorePatternParameterDefault?: boolean;
|
|
1610
1632
|
/**
|
|
1611
|
-
*
|
|
1633
|
+
* When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
1612
1634
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1613
1635
|
*/
|
|
1614
1636
|
optionalPatternParameter?: boolean;
|
|
1615
1637
|
variables?: components["schemas"]["DataResourceVariables"];
|
|
1616
1638
|
};
|
|
1617
1639
|
/**
|
|
1618
|
-
*
|
|
1640
|
+
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1619
1641
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1620
1642
|
*/
|
|
1621
1643
|
DataResourceDefinitions: {
|
|
1622
1644
|
[key: string]: components["schemas"]["DataResourceDefinition"];
|
|
1623
1645
|
};
|
|
1624
1646
|
Error: {
|
|
1625
|
-
/**
|
|
1647
|
+
/** Error message(s) that occurred while processing the request */
|
|
1626
1648
|
errorMessage?: string[] | string;
|
|
1627
1649
|
};
|
|
1628
1650
|
};
|
|
1629
1651
|
responses: {
|
|
1630
|
-
/**
|
|
1652
|
+
/** Request input validation failed */
|
|
1631
1653
|
BadRequestError: {
|
|
1632
1654
|
headers: {
|
|
1633
1655
|
[name: string]: unknown;
|
|
@@ -1636,7 +1658,7 @@ interface components {
|
|
|
1636
1658
|
"application/json": components["schemas"]["Error"];
|
|
1637
1659
|
};
|
|
1638
1660
|
};
|
|
1639
|
-
/**
|
|
1661
|
+
/** API key or token was not valid */
|
|
1640
1662
|
UnauthorizedError: {
|
|
1641
1663
|
headers: {
|
|
1642
1664
|
[name: string]: unknown;
|
|
@@ -1645,7 +1667,7 @@ interface components {
|
|
|
1645
1667
|
"application/json": components["schemas"]["Error"];
|
|
1646
1668
|
};
|
|
1647
1669
|
};
|
|
1648
|
-
/**
|
|
1670
|
+
/** Permission was denied */
|
|
1649
1671
|
ForbiddenError: {
|
|
1650
1672
|
headers: {
|
|
1651
1673
|
[name: string]: unknown;
|
|
@@ -1654,14 +1676,14 @@ interface components {
|
|
|
1654
1676
|
"application/json": components["schemas"]["Error"];
|
|
1655
1677
|
};
|
|
1656
1678
|
};
|
|
1657
|
-
/**
|
|
1679
|
+
/** Too many requests in allowed time period */
|
|
1658
1680
|
RateLimitError: {
|
|
1659
1681
|
headers: {
|
|
1660
1682
|
[name: string]: unknown;
|
|
1661
1683
|
};
|
|
1662
1684
|
content?: never;
|
|
1663
1685
|
};
|
|
1664
|
-
/**
|
|
1686
|
+
/** Execution error occurred */
|
|
1665
1687
|
InternalServerError: {
|
|
1666
1688
|
headers: {
|
|
1667
1689
|
[name: string]: unknown;
|
|
@@ -1670,51 +1692,51 @@ interface components {
|
|
|
1670
1692
|
};
|
|
1671
1693
|
};
|
|
1672
1694
|
parameters: {
|
|
1673
|
-
/**
|
|
1695
|
+
/** The project the asset/assets are on */
|
|
1674
1696
|
projectId: string;
|
|
1675
|
-
/**
|
|
1697
|
+
/** Specify a single asset ID to fetch */
|
|
1676
1698
|
assetId: string;
|
|
1677
|
-
/**
|
|
1699
|
+
/** Specify multiple asset IDs to fetch. Response type will be a list */
|
|
1678
1700
|
assetIDs: string[];
|
|
1679
|
-
/**
|
|
1701
|
+
/** The asset type ID to filter by */
|
|
1680
1702
|
type: ("image" | "video" | "audio" | "other")[];
|
|
1681
|
-
/**
|
|
1703
|
+
/** Number of records to skip */
|
|
1682
1704
|
offset: number;
|
|
1683
|
-
/**
|
|
1705
|
+
/** Max number of records to return */
|
|
1684
1706
|
limit: number;
|
|
1685
1707
|
/**
|
|
1686
|
-
*
|
|
1708
|
+
* Matches assets where their name or description contains the specified keyword.
|
|
1687
1709
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
1688
1710
|
*/
|
|
1689
1711
|
keyword: string;
|
|
1690
1712
|
/**
|
|
1691
1713
|
* @deprecated
|
|
1692
|
-
*
|
|
1714
|
+
* BETA: Semantic search using vector similarity to find assets by meaning.
|
|
1693
1715
|
* Use this for "images of mountains" style queries.
|
|
1694
1716
|
* Requires AI credits.
|
|
1695
1717
|
*/
|
|
1696
1718
|
searchSemantic: string;
|
|
1697
1719
|
/**
|
|
1698
|
-
*
|
|
1720
|
+
* Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1699
1721
|
* 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
1722
|
*/
|
|
1701
1723
|
orderBy: string[];
|
|
1702
1724
|
/**
|
|
1703
1725
|
* @deprecated
|
|
1704
|
-
*
|
|
1726
|
+
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
1705
1727
|
*/
|
|
1706
1728
|
facetBy: string;
|
|
1707
|
-
/**
|
|
1729
|
+
/** Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
1708
1730
|
createdBy: string;
|
|
1709
|
-
/**
|
|
1731
|
+
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1710
1732
|
updatedBy: string;
|
|
1711
1733
|
/**
|
|
1712
|
-
*
|
|
1734
|
+
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1713
1735
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1714
1736
|
*/
|
|
1715
1737
|
withTotalCount: boolean;
|
|
1716
1738
|
/**
|
|
1717
|
-
*
|
|
1739
|
+
* The ID of a release to fetch the content for.
|
|
1718
1740
|
*
|
|
1719
1741
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1720
1742
|
* - 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 +1745,19 @@ interface components {
|
|
|
1723
1745
|
*/
|
|
1724
1746
|
releaseId: string;
|
|
1725
1747
|
/**
|
|
1726
|
-
*
|
|
1748
|
+
* When true, includes full label entities in the response for UI rendering.
|
|
1727
1749
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1728
1750
|
* This parameter is not supported with uniform.global.
|
|
1729
1751
|
*/
|
|
1730
1752
|
withAssignedLabels: boolean;
|
|
1731
1753
|
/**
|
|
1732
1754
|
* @deprecated
|
|
1733
|
-
*
|
|
1755
|
+
* Returns additional author and creator metadata for the asset.
|
|
1734
1756
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1735
1757
|
*/
|
|
1736
1758
|
withUIStatus: boolean;
|
|
1737
1759
|
/**
|
|
1738
|
-
*
|
|
1760
|
+
* Controls filtering of trashed items.
|
|
1739
1761
|
*
|
|
1740
1762
|
* exclude: (default) Only return items not in trash.
|
|
1741
1763
|
* only: Only return trashed items (for trash view).
|