@uniformdev/assets 19.135.0 → 19.135.1-alpha.11
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 +391 -162
- package/dist/index.d.ts +391 -162
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -9,32 +9,32 @@ interface paths {
|
|
|
9
9
|
get: {
|
|
10
10
|
parameters: {
|
|
11
11
|
query: {
|
|
12
|
-
/** Specify a single asset ID to fetch
|
|
12
|
+
/** Specify a single asset ID to fetch */
|
|
13
13
|
assetId?: components["parameters"]["assetId"];
|
|
14
|
-
/** Specify multiple asset IDs to fetch. Response type will be a list
|
|
14
|
+
/** Specify multiple asset IDs to fetch. Response type will be a list */
|
|
15
15
|
assetIDs?: components["parameters"]["assetIDs"];
|
|
16
|
-
/** Filters asset lists by the user who created them. The user is specified by their identity subject
|
|
16
|
+
/** Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
17
17
|
createdBy?: components["parameters"]["createdBy"];
|
|
18
18
|
/**
|
|
19
19
|
* Matches assets where their name or description contains the specified keyword.
|
|
20
|
-
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
20
|
+
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
21
21
|
*/
|
|
22
22
|
keyword?: components["parameters"]["keyword"];
|
|
23
23
|
/** Max number of records to return */
|
|
24
24
|
limit?: components["parameters"]["limit"];
|
|
25
25
|
/** Number of records to skip */
|
|
26
26
|
offset?: components["parameters"]["offset"];
|
|
27
|
-
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending
|
|
27
|
+
/** Sets the sorting of the results. If unspecified, results are sorted by name ascending */
|
|
28
28
|
orderBy?: components["parameters"]["orderBy"];
|
|
29
|
-
/** The project the asset/assets are on
|
|
29
|
+
/** The project the asset/assets are on */
|
|
30
30
|
projectId: components["parameters"]["projectId"];
|
|
31
|
-
/** The asset type ID to filter by
|
|
31
|
+
/** The asset type ID to filter by */
|
|
32
32
|
type?: components["parameters"]["type"];
|
|
33
|
-
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject
|
|
33
|
+
/** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
34
34
|
updatedBy?: components["parameters"]["updatedBy"];
|
|
35
35
|
/**
|
|
36
36
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
37
|
-
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
37
|
+
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
38
38
|
*/
|
|
39
39
|
withTotalCount?: components["parameters"]["withTotalCount"];
|
|
40
40
|
/**
|
|
@@ -43,7 +43,7 @@ interface paths {
|
|
|
43
43
|
* - When unspecified, all release content is excluded from the result(s).
|
|
44
44
|
* - 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.
|
|
45
45
|
*
|
|
46
|
-
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
46
|
+
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
47
47
|
*/
|
|
48
48
|
releaseId?: components["parameters"]["releaseId"];
|
|
49
49
|
};
|
|
@@ -92,7 +92,7 @@ interface paths {
|
|
|
92
92
|
projectId: string;
|
|
93
93
|
/**
|
|
94
94
|
* Format: uuid
|
|
95
|
-
* @description The release ID to upsert the asset to. If unspecified the asset belongs to the base
|
|
95
|
+
* @description The release ID to upsert the asset to. If unspecified the asset belongs to the base
|
|
96
96
|
*/
|
|
97
97
|
releaseId?: string;
|
|
98
98
|
asset?: components["schemas"]["AssetInput"];
|
|
@@ -128,14 +128,14 @@ interface paths {
|
|
|
128
128
|
/**
|
|
129
129
|
* Format: uuid
|
|
130
130
|
* @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
|
|
131
|
-
* Note: deleting an asset from a release will not delete the asset from the base
|
|
131
|
+
* Note: deleting an asset from a release will not delete the asset from the base
|
|
132
132
|
*/
|
|
133
133
|
releaseId?: string;
|
|
134
134
|
};
|
|
135
135
|
};
|
|
136
136
|
};
|
|
137
137
|
};
|
|
138
|
-
/** Handles preflight requests. This endpoint allows CORS
|
|
138
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
139
139
|
options: {
|
|
140
140
|
responses: {
|
|
141
141
|
/** OK */
|
|
@@ -148,16 +148,16 @@ interface components {
|
|
|
148
148
|
schemas: {
|
|
149
149
|
/** @description Defines the shape of the asset */
|
|
150
150
|
Asset: {
|
|
151
|
-
/** @description Asset type of the asset
|
|
151
|
+
/** @description Asset type of the asset */
|
|
152
152
|
type: string;
|
|
153
153
|
/**
|
|
154
154
|
* Format: uuid
|
|
155
|
-
* @description The public UUID of the asset
|
|
155
|
+
* @description The public UUID of the asset
|
|
156
156
|
*/
|
|
157
157
|
_id: string;
|
|
158
|
-
/** @description The name of the asset
|
|
158
|
+
/** @description The name of the asset */
|
|
159
159
|
_name?: string;
|
|
160
|
-
/** @description Name of the author of the most recent change
|
|
160
|
+
/** @description Name of the author of the most recent change */
|
|
161
161
|
_author?: string;
|
|
162
162
|
fields?: {
|
|
163
163
|
title?: {
|
|
@@ -201,7 +201,7 @@ interface components {
|
|
|
201
201
|
/** @constant */
|
|
202
202
|
type: "number";
|
|
203
203
|
};
|
|
204
|
-
/** @description Asset field values
|
|
204
|
+
/** @description Asset field values */
|
|
205
205
|
custom?: {
|
|
206
206
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
207
207
|
};
|
|
@@ -210,14 +210,14 @@ interface components {
|
|
|
210
210
|
};
|
|
211
211
|
/** @description Defines the shape of the asset input */
|
|
212
212
|
AssetInput: {
|
|
213
|
-
/** @description Content type of the asset
|
|
213
|
+
/** @description Content type of the asset */
|
|
214
214
|
type: string;
|
|
215
215
|
/**
|
|
216
216
|
* Format: uuid
|
|
217
|
-
* @description The public UUID of the asset
|
|
217
|
+
* @description The public UUID of the asset
|
|
218
218
|
*/
|
|
219
219
|
_id?: string;
|
|
220
|
-
/** @description The internal name of the asset
|
|
220
|
+
/** @description The internal name of the asset */
|
|
221
221
|
_name?: string;
|
|
222
222
|
fields?: {
|
|
223
223
|
title?: {
|
|
@@ -246,36 +246,36 @@ interface components {
|
|
|
246
246
|
*/
|
|
247
247
|
projectId: string;
|
|
248
248
|
/**
|
|
249
|
-
* Format: date-time
|
|
249
|
+
* Format: date-time
|
|
250
250
|
* @description Created date string for this definition
|
|
251
251
|
*/
|
|
252
252
|
created: string;
|
|
253
253
|
/**
|
|
254
|
-
* Format: date-time
|
|
254
|
+
* Format: date-time
|
|
255
255
|
* @description Modified date string for this definition
|
|
256
256
|
*/
|
|
257
257
|
modified: string;
|
|
258
258
|
/**
|
|
259
259
|
* Format: uuid
|
|
260
|
-
* @description The release this asset belongs to. If not set, the asset belongs to the base
|
|
260
|
+
* @description The release this asset belongs to. If not set, the asset belongs to the base
|
|
261
261
|
*/
|
|
262
262
|
releaseId?: string;
|
|
263
263
|
asset: components["schemas"]["Asset"];
|
|
264
264
|
};
|
|
265
265
|
AssetListResponse: {
|
|
266
266
|
assets: components["schemas"]["AssetApiResponse"][];
|
|
267
|
-
/** @description Total number of assets that match the query. Only present when `withTotalCount` option is true
|
|
267
|
+
/** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
|
|
268
268
|
totalCount?: number;
|
|
269
269
|
};
|
|
270
270
|
};
|
|
271
271
|
parameters: {
|
|
272
|
-
/** @description The project the asset/assets are on
|
|
272
|
+
/** @description The project the asset/assets are on */
|
|
273
273
|
projectId: string;
|
|
274
|
-
/** @description Specify a single asset ID to fetch
|
|
274
|
+
/** @description Specify a single asset ID to fetch */
|
|
275
275
|
assetId: string;
|
|
276
|
-
/** @description Specify multiple asset IDs to fetch. Response type will be a list
|
|
276
|
+
/** @description Specify multiple asset IDs to fetch. Response type will be a list */
|
|
277
277
|
assetIDs: string[];
|
|
278
|
-
/** @description The asset type ID to filter by
|
|
278
|
+
/** @description The asset type ID to filter by */
|
|
279
279
|
type: ("image" | "video" | "audio" | "document")[];
|
|
280
280
|
/** @description Number of records to skip */
|
|
281
281
|
offset: number;
|
|
@@ -283,18 +283,18 @@ interface components {
|
|
|
283
283
|
limit: number;
|
|
284
284
|
/**
|
|
285
285
|
* @description Matches assets where their name or description contains the specified keyword.
|
|
286
|
-
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
286
|
+
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
287
287
|
*/
|
|
288
288
|
keyword: string;
|
|
289
|
-
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
|
|
289
|
+
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending */
|
|
290
290
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
|
|
291
|
-
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject
|
|
291
|
+
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
292
292
|
createdBy: string;
|
|
293
|
-
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
|
|
293
|
+
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
294
294
|
updatedBy: string;
|
|
295
295
|
/**
|
|
296
296
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
297
|
-
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
297
|
+
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
298
298
|
*/
|
|
299
299
|
withTotalCount: boolean;
|
|
300
300
|
/**
|
|
@@ -303,7 +303,7 @@ interface components {
|
|
|
303
303
|
* - When unspecified, all release content is excluded from the result(s).
|
|
304
304
|
* - 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.
|
|
305
305
|
*
|
|
306
|
-
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
306
|
+
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
307
307
|
*/
|
|
308
308
|
releaseId: string;
|
|
309
309
|
};
|
|
@@ -355,7 +355,7 @@ interface external {
|
|
|
355
355
|
paths: {};
|
|
356
356
|
components: {
|
|
357
357
|
schemas: {
|
|
358
|
-
/** @description Public ID (used in code). Do not change after creation
|
|
358
|
+
/** @description Public ID (used in code). Do not change after creation */
|
|
359
359
|
PublicIdProperty: string;
|
|
360
360
|
/** @description The definition of a component parameter */
|
|
361
361
|
ComponentDefinitionParameter: {
|
|
@@ -368,9 +368,24 @@ interface external {
|
|
|
368
368
|
type: string;
|
|
369
369
|
/**
|
|
370
370
|
* @description If true, this property can have locale-specific values. If false or not defined,
|
|
371
|
-
* this property will have a single value that is shared for all locales
|
|
371
|
+
* this property will have a single value that is shared for all locales
|
|
372
372
|
*/
|
|
373
373
|
localizable?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
376
|
+
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
377
|
+
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
378
|
+
*
|
|
379
|
+
* If `localized` is false, this has no effect.
|
|
380
|
+
*/
|
|
381
|
+
notLocalizedByDefault?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
384
|
+
* When combined with a localized value, each locale has independent conditional values.
|
|
385
|
+
*
|
|
386
|
+
* When not defined, conditional values are not allowed.
|
|
387
|
+
*/
|
|
388
|
+
allowConditionalValues?: boolean;
|
|
374
389
|
/** @description The configuration object for the type (type-specific) */
|
|
375
390
|
typeConfig?: unknown;
|
|
376
391
|
};
|
|
@@ -382,20 +397,20 @@ interface external {
|
|
|
382
397
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
383
398
|
allowedComponents: string[];
|
|
384
399
|
/**
|
|
385
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
386
|
-
* If allowAllComponents is true, this value is ignored
|
|
400
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
401
|
+
* If `allowAllComponents` is true, this value is ignored
|
|
387
402
|
*
|
|
388
403
|
* @default false
|
|
389
404
|
*/
|
|
390
405
|
inheritAllowedComponents: boolean;
|
|
391
406
|
/**
|
|
392
|
-
* @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
|
|
393
|
-
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents
|
|
407
|
+
* @description When false or not defined, only components in `allowedComponents` may be added to this slot - and if `allowedComponents` is empty, nothing can be added.
|
|
408
|
+
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
394
409
|
*/
|
|
395
410
|
allowAllComponents?: boolean;
|
|
396
411
|
/**
|
|
397
|
-
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
|
398
|
-
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
|
412
|
+
* @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
413
|
+
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
399
414
|
*/
|
|
400
415
|
patternsInAllowedComponents?: boolean;
|
|
401
416
|
/** @description Minimum valid number of components in this slot */
|
|
@@ -428,7 +443,7 @@ interface external {
|
|
|
428
443
|
regularExpression?: string;
|
|
429
444
|
/**
|
|
430
445
|
* @description Custom error message when regular expression validation fails.
|
|
431
|
-
* Has no effect if `regularExpression` is not set
|
|
446
|
+
* Has no effect if `regularExpression` is not set
|
|
432
447
|
*/
|
|
433
448
|
regularExpressionMessage?: string;
|
|
434
449
|
};
|
|
@@ -438,7 +453,7 @@ interface external {
|
|
|
438
453
|
/** @description Friendly name of the variant */
|
|
439
454
|
name: string;
|
|
440
455
|
};
|
|
441
|
-
/** @description Permission set for a component
|
|
456
|
+
/** @description Permission set for a component definition */
|
|
442
457
|
ComponentDefinitionPermission: {
|
|
443
458
|
roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
444
459
|
/**
|
|
@@ -463,23 +478,23 @@ interface external {
|
|
|
463
478
|
icon?: string;
|
|
464
479
|
/**
|
|
465
480
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
466
|
-
* The parameter type must support being used as a title parameter for this to work
|
|
481
|
+
* The parameter type must support being used as a title parameter for this to work
|
|
467
482
|
*
|
|
468
483
|
* @default null
|
|
469
484
|
*/
|
|
470
485
|
titleParameter?: string | null;
|
|
471
486
|
/**
|
|
472
|
-
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
487
|
+
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
473
488
|
*
|
|
474
489
|
* @default null
|
|
475
490
|
*/
|
|
476
491
|
thumbnailParameter?: string | null;
|
|
477
492
|
/**
|
|
478
|
-
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
493
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
|
|
479
494
|
* @default false
|
|
480
495
|
*/
|
|
481
496
|
canBeComposition?: boolean;
|
|
482
|
-
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries
|
|
497
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
483
498
|
parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
484
499
|
/**
|
|
485
500
|
* Format: uuid
|
|
@@ -487,15 +502,9 @@ interface external {
|
|
|
487
502
|
* @default null
|
|
488
503
|
*/
|
|
489
504
|
categoryId?: string | null;
|
|
490
|
-
/**
|
|
491
|
-
* @description Description of the component definition
|
|
492
|
-
* @default null
|
|
493
|
-
*/
|
|
505
|
+
/** @description Description of the component definition */
|
|
494
506
|
description?: string;
|
|
495
|
-
/**
|
|
496
|
-
* @description Description of the component definition
|
|
497
|
-
* @default null
|
|
498
|
-
*/
|
|
507
|
+
/** @description Description of the component definition */
|
|
499
508
|
previewImageUrl?: string;
|
|
500
509
|
/**
|
|
501
510
|
* @description if this component uses team permissions or custom permissions
|
|
@@ -504,17 +513,22 @@ interface external {
|
|
|
504
513
|
useTeamPermissions?: boolean;
|
|
505
514
|
/** @description Custom role permissions for this component definition */
|
|
506
515
|
permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
507
|
-
/** @description The named slots for this component; placement areas where arrays of other components can be added
|
|
516
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
508
517
|
slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
|
509
518
|
slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
|
510
519
|
/** @description Default component instance value */
|
|
511
520
|
defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
|
512
|
-
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
|
521
|
+
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
513
522
|
variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
|
514
523
|
/** @description Created date string for this definition (ignored for writes) */
|
|
515
524
|
created?: string;
|
|
516
525
|
/** @description Last modified date string for this definition (ignored for writes) */
|
|
517
526
|
updated?: string;
|
|
527
|
+
/**
|
|
528
|
+
* Format: uuid
|
|
529
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
|
|
530
|
+
*/
|
|
531
|
+
workflowId?: string;
|
|
518
532
|
};
|
|
519
533
|
/** @description Defines a content type */
|
|
520
534
|
ContentType: {
|
|
@@ -523,21 +537,18 @@ interface external {
|
|
|
523
537
|
name: string;
|
|
524
538
|
/**
|
|
525
539
|
* @description 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.
|
|
526
|
-
* The field type must support being used as an entry name for this to work
|
|
540
|
+
* The field type must support being used as an entry name for this to work
|
|
527
541
|
*/
|
|
528
542
|
entryName?: string | null;
|
|
529
543
|
/**
|
|
530
|
-
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
544
|
+
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
531
545
|
*
|
|
532
546
|
* @default null
|
|
533
547
|
*/
|
|
534
548
|
thumbnailField?: string | null;
|
|
535
549
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
536
550
|
fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
537
|
-
/**
|
|
538
|
-
* @description Description of the content type
|
|
539
|
-
* @default null
|
|
540
|
-
*/
|
|
551
|
+
/** @description Description of the content type */
|
|
541
552
|
description?: string;
|
|
542
553
|
/**
|
|
543
554
|
* @description Icon name for the content type (e.g. 'screen')
|
|
@@ -562,34 +573,127 @@ interface external {
|
|
|
562
573
|
useTeamPermissions?: boolean;
|
|
563
574
|
/** @description Custom role permissions for this content type */
|
|
564
575
|
permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
576
|
+
/**
|
|
577
|
+
* Format: uuid
|
|
578
|
+
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
579
|
+
*/
|
|
580
|
+
workflowId?: string;
|
|
565
581
|
};
|
|
566
|
-
/** @description Defines an editable parameter on a component
|
|
582
|
+
/** @description Defines an editable parameter on a component */
|
|
567
583
|
ComponentParameter: {
|
|
568
|
-
/** @description The value of the parameter. Any JSON-serializable value is acceptable
|
|
584
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
569
585
|
value?: unknown;
|
|
570
|
-
/** @description The type of the parameter. Determines how it is displayed when editing
|
|
586
|
+
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
571
587
|
type: string;
|
|
572
588
|
/** @deprecated */
|
|
573
589
|
connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
|
574
590
|
/**
|
|
575
591
|
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
576
|
-
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
592
|
+
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
577
593
|
*/
|
|
578
594
|
locales?: {
|
|
579
595
|
[key: string]: unknown;
|
|
580
596
|
};
|
|
597
|
+
conditions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
598
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
599
|
+
localesConditions?: {
|
|
600
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* @description Array of alternate values which are based on conditions.
|
|
605
|
+
*
|
|
606
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
607
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
608
|
+
* * If no conditions match, the `value` property is used.
|
|
609
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
610
|
+
*
|
|
611
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
612
|
+
*/
|
|
613
|
+
ComponentParameterConditions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
|
614
|
+
/** @description Defines a conditional value for a component parameter */
|
|
615
|
+
ComponentParameterConditionalValue: {
|
|
616
|
+
when: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
|
617
|
+
/**
|
|
618
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
619
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
620
|
+
*/
|
|
621
|
+
value: unknown;
|
|
622
|
+
/**
|
|
623
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
624
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
625
|
+
*/
|
|
626
|
+
id: number;
|
|
581
627
|
};
|
|
582
|
-
/**
|
|
628
|
+
/**
|
|
629
|
+
* @deprecated
|
|
630
|
+
* @description beta functionality subject to change
|
|
631
|
+
*/
|
|
632
|
+
VisibilityCriteriaGroup: {
|
|
633
|
+
/**
|
|
634
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
635
|
+
* @enum {string}
|
|
636
|
+
*/
|
|
637
|
+
op?: "&" | "|";
|
|
638
|
+
clauses: (external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* @deprecated
|
|
642
|
+
* @description beta functionality subject to change
|
|
643
|
+
*/
|
|
644
|
+
VisibilityCriteria: {
|
|
645
|
+
/** @description The rule type to execute */
|
|
646
|
+
rule: string;
|
|
647
|
+
/**
|
|
648
|
+
* @description The source value of the rule.
|
|
649
|
+
* 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.
|
|
650
|
+
*/
|
|
651
|
+
source?: string;
|
|
652
|
+
/** @description The rule-definition-specific operator to test against */
|
|
653
|
+
op: string;
|
|
654
|
+
/** @description 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. */
|
|
655
|
+
value: string | string[];
|
|
656
|
+
};
|
|
657
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
583
658
|
DataElementConnectionDefinition: {
|
|
584
|
-
/** @description A JSON Pointer expression that defines the data resource dynamic token value
|
|
659
|
+
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
585
660
|
pointer: string;
|
|
586
661
|
/**
|
|
587
662
|
* @description The syntax used to select the dynamic token to bind to
|
|
588
663
|
* @enum {string}
|
|
589
664
|
*/
|
|
590
665
|
syntax: "jptr";
|
|
666
|
+
/**
|
|
667
|
+
* @description The action to take if the dynamic token cannot be resolved
|
|
668
|
+
* - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
|
|
669
|
+
* NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
|
|
670
|
+
* NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
|
|
671
|
+
* this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
|
|
672
|
+
* - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
|
|
673
|
+
* - c: COMPONENT: Removes the whole parent component or block that contains the property.
|
|
674
|
+
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
675
|
+
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
676
|
+
* - 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
|
|
677
|
+
*
|
|
678
|
+
* @enum {string}
|
|
679
|
+
*/
|
|
680
|
+
failureAction?: "t" | "p" | "c" | "a";
|
|
681
|
+
/**
|
|
682
|
+
* @description How to report when the dynamic token cannot be resolved
|
|
683
|
+
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
684
|
+
* - w: WARNING: Report a warning message [default]
|
|
685
|
+
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
686
|
+
*
|
|
687
|
+
* @enum {string}
|
|
688
|
+
*/
|
|
689
|
+
failureLogLevel?: "e" | "w" | "i";
|
|
690
|
+
/**
|
|
691
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
692
|
+
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
693
|
+
*/
|
|
694
|
+
failureDefault?: string;
|
|
591
695
|
};
|
|
592
|
-
/** @description Defines the shape of a component instance served by the composition API
|
|
696
|
+
/** @description Defines the shape of a component instance served by the composition API */
|
|
593
697
|
ComponentInstance: {
|
|
594
698
|
/** @description Type of the component instance (public_id of its definition) */
|
|
595
699
|
type: string;
|
|
@@ -607,15 +711,15 @@ interface external {
|
|
|
607
711
|
* @description Unique identifier of the component within the composition.
|
|
608
712
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
609
713
|
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
610
|
-
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
714
|
+
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
611
715
|
*/
|
|
612
716
|
_id?: string;
|
|
613
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern
|
|
717
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
614
718
|
_pattern?: string;
|
|
615
719
|
_dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
616
720
|
/**
|
|
617
721
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
618
|
-
* Means nothing for PUTs; it will be ignored
|
|
722
|
+
* Means nothing for PUTs; it will be ignored
|
|
619
723
|
*/
|
|
620
724
|
_patternDataResources?: {
|
|
621
725
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
@@ -631,7 +735,7 @@ interface external {
|
|
|
631
735
|
* the composition's override replaces the pattern's.
|
|
632
736
|
*
|
|
633
737
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
634
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
738
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
635
739
|
*/
|
|
636
740
|
_overrides?: {
|
|
637
741
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
|
@@ -641,10 +745,10 @@ interface external {
|
|
|
641
745
|
* by consumers of the pattern.
|
|
642
746
|
*
|
|
643
747
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
644
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
748
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
645
749
|
*/
|
|
646
750
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
|
647
|
-
/** @description Array of locales
|
|
751
|
+
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
648
752
|
_locales?: string[];
|
|
649
753
|
};
|
|
650
754
|
/** @description Defines the shape of the root component in a composition */
|
|
@@ -657,23 +761,31 @@ interface external {
|
|
|
657
761
|
};
|
|
658
762
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
659
763
|
variant?: string;
|
|
660
|
-
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated
|
|
764
|
+
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
661
765
|
projectMapNodes?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
662
766
|
/** @description Slots containing any child components */
|
|
663
767
|
slots?: {
|
|
664
768
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
665
769
|
};
|
|
666
|
-
/** @description The public UUID of the composition
|
|
770
|
+
/** @description The public UUID of the composition */
|
|
667
771
|
_id: string;
|
|
668
|
-
/** @description Slug pattern of this component
|
|
772
|
+
/** @description Slug pattern of this component */
|
|
669
773
|
_slug?: string | null;
|
|
670
|
-
/** @description Friendly name of this component
|
|
774
|
+
/** @description Friendly name of this component */
|
|
671
775
|
_name: string;
|
|
672
|
-
/** @description
|
|
776
|
+
/** @description Name of the author of the most recent change */
|
|
777
|
+
_author?: string;
|
|
778
|
+
/** @description Identity subject of the author of the most recent change */
|
|
779
|
+
_authorSubject?: string;
|
|
780
|
+
/** @description Name of the original creator */
|
|
781
|
+
_creator?: string;
|
|
782
|
+
/** @description Identity subject of the original creator */
|
|
783
|
+
_creatorSubject?: string;
|
|
784
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
673
785
|
_pattern?: string;
|
|
674
786
|
/**
|
|
675
787
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
676
|
-
* Means nothing for PUTs; it will be ignored
|
|
788
|
+
* Means nothing for PUTs; it will be ignored
|
|
677
789
|
*/
|
|
678
790
|
_patternDataResources?: {
|
|
679
791
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
@@ -690,7 +802,7 @@ interface external {
|
|
|
690
802
|
* the composition's override replaces the pattern's.
|
|
691
803
|
*
|
|
692
804
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
693
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
805
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
694
806
|
*/
|
|
695
807
|
_overrides?: {
|
|
696
808
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
|
@@ -700,17 +812,17 @@ interface external {
|
|
|
700
812
|
* by consumers of the pattern.
|
|
701
813
|
*
|
|
702
814
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
703
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
815
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
704
816
|
*/
|
|
705
817
|
_overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
|
706
|
-
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data
|
|
818
|
+
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
707
819
|
_locales?: string[];
|
|
708
820
|
};
|
|
709
821
|
/**
|
|
710
822
|
* @description Defines how to override a specific component.
|
|
711
823
|
*
|
|
712
824
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
713
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
825
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
714
826
|
*/
|
|
715
827
|
ComponentOverride: {
|
|
716
828
|
parameters?: {
|
|
@@ -726,19 +838,19 @@ interface external {
|
|
|
726
838
|
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
727
839
|
*
|
|
728
840
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
729
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
841
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
730
842
|
*/
|
|
731
843
|
ComponentOverridability: {
|
|
732
|
-
/** @description Defines component parameter value overrides. Keys are the parameter public ID
|
|
844
|
+
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
733
845
|
parameters?: {
|
|
734
846
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
|
735
847
|
};
|
|
736
|
-
/** @description Allows overriding a display variant is allowed
|
|
848
|
+
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
737
849
|
variants?: boolean;
|
|
738
850
|
/**
|
|
739
851
|
* @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
740
852
|
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
741
|
-
* If not set, the default is false
|
|
853
|
+
* If not set, the default is false
|
|
742
854
|
*/
|
|
743
855
|
hideLockedParameters?: boolean;
|
|
744
856
|
};
|
|
@@ -746,7 +858,7 @@ interface external {
|
|
|
746
858
|
* @description Whether a parameter is overridable
|
|
747
859
|
*
|
|
748
860
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
749
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
861
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
750
862
|
*
|
|
751
863
|
* @enum {string}
|
|
752
864
|
*/
|
|
@@ -754,24 +866,24 @@ interface external {
|
|
|
754
866
|
/**
|
|
755
867
|
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
756
868
|
* These are created in the UI and shared across a whole project.
|
|
757
|
-
* NOTE:
|
|
758
|
-
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
869
|
+
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
870
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
759
871
|
*/
|
|
760
872
|
DataSource: {
|
|
761
873
|
/** @description Public ID of the data source */
|
|
762
874
|
id: string;
|
|
763
875
|
/** @description Display name of the data source */
|
|
764
876
|
displayName: string;
|
|
765
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an
|
|
877
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
|
|
766
878
|
connectorType: string;
|
|
767
|
-
/** @description Base resource URL of the data source. No trailing slash
|
|
879
|
+
/** @description Base resource URL of the data source. No trailing slash */
|
|
768
880
|
baseUrl: string;
|
|
769
881
|
/** @description HTTP headers to pass with requests to the data source */
|
|
770
882
|
headers?: {
|
|
771
883
|
key: string;
|
|
772
884
|
value: string;
|
|
773
885
|
}[];
|
|
774
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys
|
|
886
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
775
887
|
parameters?: {
|
|
776
888
|
key: string;
|
|
777
889
|
value: string;
|
|
@@ -782,21 +894,21 @@ interface external {
|
|
|
782
894
|
};
|
|
783
895
|
/**
|
|
784
896
|
* @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
785
|
-
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
897
|
+
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
786
898
|
*/
|
|
787
899
|
localeMapping?: {
|
|
788
900
|
[key: string]: string;
|
|
789
901
|
};
|
|
790
|
-
/** @description 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
|
|
902
|
+
/** @description 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 */
|
|
791
903
|
customPublic?: {
|
|
792
904
|
[key: string]: unknown;
|
|
793
905
|
};
|
|
794
|
-
/** @description 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
|
|
906
|
+
/** @description 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 */
|
|
795
907
|
custom?: {
|
|
796
908
|
[key: string]: unknown;
|
|
797
909
|
};
|
|
798
910
|
};
|
|
799
|
-
/** @description 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
|
|
911
|
+
/** @description 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 */
|
|
800
912
|
DataType: {
|
|
801
913
|
/** @description Public ID of the data type */
|
|
802
914
|
id: string;
|
|
@@ -807,39 +919,39 @@ interface external {
|
|
|
807
919
|
/**
|
|
808
920
|
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
809
921
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
810
|
-
* no special UI or processing is required
|
|
922
|
+
* no special UI or processing is required
|
|
811
923
|
*/
|
|
812
924
|
archetype?: string;
|
|
813
925
|
allowedOnComponents?: string[];
|
|
814
|
-
/** @description 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 leading slash
|
|
926
|
+
/** @description 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 */
|
|
815
927
|
path: string;
|
|
816
|
-
/** @description Time-to-live (in seconds) for the resource data cache
|
|
928
|
+
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
817
929
|
ttl?: number;
|
|
818
|
-
/** @description A key for the resource data cache purging
|
|
930
|
+
/** @description A key for the resource data cache purging */
|
|
819
931
|
purgeKey?: string;
|
|
820
|
-
/** @description 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
|
|
932
|
+
/** @description 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 */
|
|
821
933
|
badgeIconUrl?: string;
|
|
822
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys
|
|
934
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
823
935
|
headers?: {
|
|
824
936
|
key: string;
|
|
825
937
|
value: string;
|
|
826
938
|
omitIfEmpty?: boolean;
|
|
827
939
|
}[];
|
|
828
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys
|
|
940
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
829
941
|
parameters?: {
|
|
830
942
|
key: string;
|
|
831
943
|
value: string;
|
|
832
944
|
omitIfEmpty?: boolean;
|
|
833
945
|
}[];
|
|
834
|
-
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
|
946
|
+
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
835
947
|
body?: string;
|
|
836
948
|
/**
|
|
837
|
-
* @description HTTP method to use with requests to the data type
|
|
949
|
+
* @description HTTP method to use with requests to the data type
|
|
838
950
|
* @default GET
|
|
839
951
|
* @enum {string}
|
|
840
952
|
*/
|
|
841
953
|
method: "GET" | "POST" | "HEAD";
|
|
842
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys
|
|
954
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
843
955
|
variables?: {
|
|
844
956
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
845
957
|
};
|
|
@@ -852,26 +964,26 @@ interface external {
|
|
|
852
964
|
DataVariableDefinition: {
|
|
853
965
|
/** @description Display name of the data variable */
|
|
854
966
|
displayName?: string;
|
|
855
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does
|
|
967
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
856
968
|
helpText?: string;
|
|
857
969
|
/**
|
|
858
|
-
* @description 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
|
|
970
|
+
* @description 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
|
|
859
971
|
* @default text
|
|
860
972
|
*/
|
|
861
973
|
type?: string;
|
|
862
974
|
/** @description Default value of the data variable */
|
|
863
975
|
default: string;
|
|
864
|
-
/** @description 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
|
|
976
|
+
/** @description 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 */
|
|
865
977
|
order?: number;
|
|
866
978
|
/**
|
|
867
979
|
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
868
|
-
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
980
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
869
981
|
*/
|
|
870
982
|
source?: string;
|
|
871
983
|
};
|
|
872
984
|
/**
|
|
873
985
|
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
874
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
986
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
875
987
|
*/
|
|
876
988
|
DataResourceDefinitions: {
|
|
877
989
|
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
@@ -880,25 +992,30 @@ interface external {
|
|
|
880
992
|
DataResourceDefinition: {
|
|
881
993
|
/** @description Public ID of the data type that provides this data */
|
|
882
994
|
type: string;
|
|
883
|
-
/** @description 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
|
|
995
|
+
/** @description 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 */
|
|
884
996
|
isPatternParameter?: boolean;
|
|
885
997
|
/**
|
|
886
998
|
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
887
999
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
888
|
-
* If isPatternParameter is false or undefined, this has no meaning
|
|
1000
|
+
* If isPatternParameter is false or undefined, this has no meaning
|
|
889
1001
|
*/
|
|
890
1002
|
ignorePatternParameterDefault?: boolean;
|
|
1003
|
+
/**
|
|
1004
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
1005
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1006
|
+
*/
|
|
1007
|
+
optionalPatternParameter?: boolean;
|
|
891
1008
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
892
1009
|
};
|
|
893
|
-
/** @description Variable values for a data resource
|
|
1010
|
+
/** @description Variable values for a data resource */
|
|
894
1011
|
DataResourceVariables: {
|
|
895
1012
|
[key: string]: string;
|
|
896
1013
|
};
|
|
897
1014
|
/**
|
|
898
1015
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
899
1016
|
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
900
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted,
|
|
901
|
-
* Means nothing for PUTs; it will be ignored
|
|
1017
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
1018
|
+
* Means nothing for PUTs; it will be ignored
|
|
902
1019
|
*
|
|
903
1020
|
* @enum {string}
|
|
904
1021
|
*/
|
|
@@ -906,23 +1023,23 @@ interface external {
|
|
|
906
1023
|
HistoryApiResponse: {
|
|
907
1024
|
/**
|
|
908
1025
|
* @description 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.
|
|
909
|
-
* If this is undefined then no more results are available
|
|
1026
|
+
* If this is undefined then no more results are available
|
|
910
1027
|
*/
|
|
911
1028
|
cursor?: string;
|
|
912
1029
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
913
1030
|
truncated?: boolean;
|
|
914
|
-
/** @description Version history entries
|
|
1031
|
+
/** @description Version history entries */
|
|
915
1032
|
results?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
|
|
916
1033
|
};
|
|
917
1034
|
HistoryEntry: {
|
|
918
|
-
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API
|
|
1035
|
+
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
919
1036
|
versionId: string;
|
|
920
|
-
/** @description The timestamp when the version was created in epoch milliseconds
|
|
1037
|
+
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
921
1038
|
timestamp: number;
|
|
922
|
-
/** @description The name (full name) of the user who created the version
|
|
1039
|
+
/** @description The name (full name) of the user who created the version */
|
|
923
1040
|
authorName: string;
|
|
924
1041
|
authorIsApiKey: boolean;
|
|
925
|
-
/** @description The state of the entity when the history entry was made
|
|
1042
|
+
/** @description The state of the entity when the history entry was made */
|
|
926
1043
|
state: number;
|
|
927
1044
|
};
|
|
928
1045
|
/** @description Category for tagging canvas entities */
|
|
@@ -935,12 +1052,12 @@ interface external {
|
|
|
935
1052
|
/** @description Display name of the category */
|
|
936
1053
|
name: string;
|
|
937
1054
|
/**
|
|
938
|
-
* @description 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
|
|
1055
|
+
* @description 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
|
|
939
1056
|
* @default 0
|
|
940
1057
|
*/
|
|
941
1058
|
order?: number;
|
|
942
1059
|
};
|
|
943
|
-
/** @description Project map node information related to a component
|
|
1060
|
+
/** @description Project map node information related to a component */
|
|
944
1061
|
CompositionProjectMapNodeInfo: {
|
|
945
1062
|
/**
|
|
946
1063
|
* Format: uuid
|
|
@@ -949,36 +1066,36 @@ interface external {
|
|
|
949
1066
|
id: string;
|
|
950
1067
|
/**
|
|
951
1068
|
* @description Fallback path of the project map node.
|
|
952
|
-
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
1069
|
+
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
953
1070
|
*/
|
|
954
1071
|
path: string;
|
|
955
1072
|
/**
|
|
956
1073
|
* Format: uuid
|
|
957
|
-
* @description Unique identifier for the project map that this node belongs to
|
|
1074
|
+
* @description Unique identifier for the project map that this node belongs to
|
|
958
1075
|
*/
|
|
959
1076
|
projectMapId: string;
|
|
960
1077
|
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
961
1078
|
/**
|
|
962
1079
|
* @description Locale-specific paths of the project map node.
|
|
963
|
-
* Keys are locale codes
|
|
1080
|
+
* Keys are locale codes
|
|
964
1081
|
*/
|
|
965
1082
|
locales?: {
|
|
966
1083
|
[key: string]: {
|
|
967
|
-
/** @description Locale-specific path of the project map node
|
|
1084
|
+
/** @description Locale-specific path of the project map node */
|
|
968
1085
|
path: string;
|
|
969
|
-
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale
|
|
1086
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
970
1087
|
inherited: boolean;
|
|
971
1088
|
};
|
|
972
1089
|
};
|
|
973
1090
|
};
|
|
974
|
-
/** @description AI Prompt definition
|
|
1091
|
+
/** @description AI Prompt definition */
|
|
975
1092
|
Prompt: {
|
|
976
1093
|
/**
|
|
977
1094
|
* Format: uuid
|
|
978
1095
|
* @description Unique identifier for the prompt
|
|
979
1096
|
*/
|
|
980
1097
|
id: string;
|
|
981
|
-
/** @description Unique identifier for the integration that this prompt belongs to
|
|
1098
|
+
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
982
1099
|
integrationType: string;
|
|
983
1100
|
/** @description Name for the prompt */
|
|
984
1101
|
name?: string | null;
|
|
@@ -995,6 +1112,113 @@ interface external {
|
|
|
995
1112
|
/** @description Supported parameter types */
|
|
996
1113
|
parameterTypes?: string[] | null;
|
|
997
1114
|
};
|
|
1115
|
+
/** @description Definition of a workflow that can be assigned to entities */
|
|
1116
|
+
WorkflowDefinition: {
|
|
1117
|
+
/**
|
|
1118
|
+
* Format: uuid
|
|
1119
|
+
* @description Unique identifier of the workflow definition
|
|
1120
|
+
*/
|
|
1121
|
+
id: string;
|
|
1122
|
+
/** @description Workflow name */
|
|
1123
|
+
name: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Format: uuid
|
|
1126
|
+
* @description The ID of the initial stage in the stages object.
|
|
1127
|
+
*/
|
|
1128
|
+
initialStage: string;
|
|
1129
|
+
/** @description All stages of the workflow */
|
|
1130
|
+
stages: {
|
|
1131
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
|
|
1132
|
+
};
|
|
1133
|
+
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1134
|
+
modified?: string;
|
|
1135
|
+
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
1136
|
+
created?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description Name of the original creator of the workflow.
|
|
1139
|
+
* If undefined, the user has been removed from the team.
|
|
1140
|
+
* Ignored for writes
|
|
1141
|
+
*/
|
|
1142
|
+
createdBy?: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* @description Name of the last modifier of the workflow.
|
|
1145
|
+
* If undefined, the user has been removed from the team.
|
|
1146
|
+
* Ignored for writes
|
|
1147
|
+
*/
|
|
1148
|
+
modifiedBy?: string;
|
|
1149
|
+
};
|
|
1150
|
+
/** @description Definition of a stage in a workflow */
|
|
1151
|
+
WorkflowStage: {
|
|
1152
|
+
/** @description Name of the stage */
|
|
1153
|
+
name: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
1156
|
+
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
1157
|
+
* 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
|
|
1158
|
+
* listed here, the stage is read-only and publishing is disabled
|
|
1159
|
+
*/
|
|
1160
|
+
permissions: {
|
|
1161
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
|
|
1162
|
+
};
|
|
1163
|
+
/**
|
|
1164
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
1165
|
+
* 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.
|
|
1166
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
1167
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
1168
|
+
*/
|
|
1169
|
+
autoPublish?: boolean;
|
|
1170
|
+
/**
|
|
1171
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
1172
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
1173
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
1174
|
+
*/
|
|
1175
|
+
requireValidity?: boolean;
|
|
1176
|
+
/**
|
|
1177
|
+
* @description Defines transitions to other stages
|
|
1178
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1179
|
+
* has a stage that can never be escaped
|
|
1180
|
+
*/
|
|
1181
|
+
transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
|
|
1182
|
+
/**
|
|
1183
|
+
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1184
|
+
* @default chevron-double-right-o
|
|
1185
|
+
*/
|
|
1186
|
+
icon?: string;
|
|
1187
|
+
/** @description 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 */
|
|
1188
|
+
order?: number;
|
|
1189
|
+
};
|
|
1190
|
+
/** @description Definition of a transition from one stage to another in a workflow */
|
|
1191
|
+
WorkflowStageTransition: {
|
|
1192
|
+
/**
|
|
1193
|
+
* Format: uuid
|
|
1194
|
+
* @description The target stage to transition to
|
|
1195
|
+
*/
|
|
1196
|
+
to: string;
|
|
1197
|
+
/**
|
|
1198
|
+
* @description Name shown to the user when they execute this transition.
|
|
1199
|
+
* If not provided, a default name will be assigned automatically based on the target stage
|
|
1200
|
+
*/
|
|
1201
|
+
name: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* @description Permissions for the stage transition.
|
|
1204
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
1205
|
+
*/
|
|
1206
|
+
permissions: {
|
|
1207
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
|
|
1208
|
+
};
|
|
1209
|
+
};
|
|
1210
|
+
/** @description Permissions for a workflow stage */
|
|
1211
|
+
WorkflowStagePermission: {
|
|
1212
|
+
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
1213
|
+
write?: boolean;
|
|
1214
|
+
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
1215
|
+
publish?: boolean;
|
|
1216
|
+
};
|
|
1217
|
+
/** @description Permissions for a workflow stage transition */
|
|
1218
|
+
WorkflowStageTransitionPermission: {
|
|
1219
|
+
/** @description Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it */
|
|
1220
|
+
execute?: boolean;
|
|
1221
|
+
};
|
|
998
1222
|
};
|
|
999
1223
|
};
|
|
1000
1224
|
operations: {};
|
|
@@ -1016,12 +1240,12 @@ interface external {
|
|
|
1016
1240
|
* - When unspecified, composition data is fetched from base.
|
|
1017
1241
|
* - 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.
|
|
1018
1242
|
*
|
|
1019
|
-
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
|
|
1243
|
+
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
|
|
1020
1244
|
*/
|
|
1021
1245
|
releaseId?: string;
|
|
1022
|
-
/** The id of the node to retrieve, cannot have both this parameter and
|
|
1246
|
+
/** The id of the node to retrieve, cannot have both this parameter and `path` */
|
|
1023
1247
|
id?: string;
|
|
1024
|
-
/** The path of the root node to retrieve, cannot have both this parameter and
|
|
1248
|
+
/** The path of the root node to retrieve, cannot have both this parameter and `id` */
|
|
1025
1249
|
path?: string;
|
|
1026
1250
|
/** Composition id to find associated sitemap nodes for */
|
|
1027
1251
|
compositionId?: string;
|
|
@@ -1029,9 +1253,9 @@ interface external {
|
|
|
1029
1253
|
limit?: number;
|
|
1030
1254
|
/** Number of records to skip before returning nodes */
|
|
1031
1255
|
offset?: number;
|
|
1032
|
-
/** Depth of the tree to fetch.
|
|
1256
|
+
/** Depth of the tree to fetch. This only applies when fetching by path */
|
|
1033
1257
|
depth?: number;
|
|
1034
|
-
/** State of compositions to fetch. 0 = draft, 64 = published
|
|
1258
|
+
/** State of compositions to fetch. 0 = draft, 64 = published */
|
|
1035
1259
|
state?: number;
|
|
1036
1260
|
/** should the data be returned as a json tree object (or a flat array) */
|
|
1037
1261
|
tree?: boolean;
|
|
@@ -1039,19 +1263,19 @@ interface external {
|
|
|
1039
1263
|
search?: string;
|
|
1040
1264
|
/**
|
|
1041
1265
|
* Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
|
|
1042
|
-
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
|
|
1266
|
+
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
|
|
1043
1267
|
*/
|
|
1044
1268
|
includeAncestors?: boolean;
|
|
1045
|
-
/** include expanded helper computed properties,
|
|
1269
|
+
/** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
|
|
1046
1270
|
expanded?: boolean;
|
|
1047
|
-
/** include basic composition information. ID, type, state, name, and definition id
|
|
1271
|
+
/** include basic composition information. ID, type, state, name, and definition id */
|
|
1048
1272
|
withCompositionData?: boolean;
|
|
1049
1273
|
/**
|
|
1050
1274
|
* @deprecated Returns the UI status string of the composition.
|
|
1051
|
-
* This internal status is subject to change without notice
|
|
1275
|
+
* This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
|
|
1052
1276
|
*/
|
|
1053
1277
|
withCompositionUIStatus?: boolean;
|
|
1054
|
-
/** Include basic redirect information
|
|
1278
|
+
/** Include basic redirect information */
|
|
1055
1279
|
withRedirectData?: boolean;
|
|
1056
1280
|
};
|
|
1057
1281
|
};
|
|
@@ -1161,7 +1385,7 @@ interface external {
|
|
|
1161
1385
|
};
|
|
1162
1386
|
};
|
|
1163
1387
|
};
|
|
1164
|
-
/** Handles preflight requests. This endpoint allows CORS
|
|
1388
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
1165
1389
|
options: {
|
|
1166
1390
|
responses: {
|
|
1167
1391
|
/** OK */
|
|
@@ -1180,7 +1404,7 @@ interface external {
|
|
|
1180
1404
|
id: string;
|
|
1181
1405
|
/** @description Path representing the path to the current node */
|
|
1182
1406
|
path: string;
|
|
1183
|
-
/** @description Ordering of the node, higher numbers go after lower numbers
|
|
1407
|
+
/** @description Ordering of the node, higher numbers go after lower numbers */
|
|
1184
1408
|
order?: number;
|
|
1185
1409
|
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1186
1410
|
/** @description The name of the projectMap entry */
|
|
@@ -1218,13 +1442,13 @@ interface external {
|
|
|
1218
1442
|
/** @description Last segment of the url in this locale */
|
|
1219
1443
|
pathSegment: string;
|
|
1220
1444
|
/**
|
|
1221
|
-
* @description When false, the node explicitly defines a locale
|
|
1445
|
+
* @description When false, the node explicitly defines a locale-specific path segment.
|
|
1222
1446
|
*
|
|
1223
|
-
* When true, an ancestor defines a locale
|
|
1447
|
+
* When true, an ancestor defines a locale-specific path segment,
|
|
1224
1448
|
* which makes its descendants resolvable using that segment.
|
|
1225
|
-
* This node does not define a locale
|
|
1449
|
+
* This node does not define a locale-specific path segment.
|
|
1226
1450
|
*
|
|
1227
|
-
* Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
|
|
1451
|
+
* Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
|
|
1228
1452
|
*/
|
|
1229
1453
|
inherited?: boolean;
|
|
1230
1454
|
};
|
|
@@ -1242,22 +1466,22 @@ interface external {
|
|
|
1242
1466
|
*/
|
|
1243
1467
|
id?: string;
|
|
1244
1468
|
}[];
|
|
1245
|
-
/** @description Basic information about a composition from the context of a project map node
|
|
1469
|
+
/** @description Basic information about a composition from the context of a project map node */
|
|
1246
1470
|
ProjectMapNodeCompositionData: {
|
|
1247
1471
|
/** @description Type of the composition instance (public_id of its definition) */
|
|
1248
1472
|
type: string;
|
|
1249
1473
|
/**
|
|
1250
1474
|
* Format: uuid
|
|
1251
|
-
* @description The public UUID of the composition
|
|
1475
|
+
* @description The public UUID of the composition
|
|
1252
1476
|
*/
|
|
1253
1477
|
id: string;
|
|
1254
|
-
/** @description Slug pattern of this composition
|
|
1478
|
+
/** @description Slug pattern of this composition */
|
|
1255
1479
|
slug?: string | null;
|
|
1256
|
-
/** @description Friendly name of this composition
|
|
1480
|
+
/** @description Friendly name of this composition */
|
|
1257
1481
|
name: string;
|
|
1258
1482
|
/**
|
|
1259
1483
|
* @deprecated
|
|
1260
|
-
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
1484
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
1261
1485
|
* @enum {string}
|
|
1262
1486
|
*/
|
|
1263
1487
|
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
@@ -1268,8 +1492,13 @@ interface external {
|
|
|
1268
1492
|
icon?: string;
|
|
1269
1493
|
/** @description Friendly name of this Composition's Definition */
|
|
1270
1494
|
typeName?: string;
|
|
1271
|
-
/** @description List of locales that the composition is available in. If empty, available in all locales
|
|
1495
|
+
/** @description List of locales that the composition is available in. If empty, available in all locales */
|
|
1272
1496
|
locales: string[];
|
|
1497
|
+
/**
|
|
1498
|
+
* Format: date-time
|
|
1499
|
+
* @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
|
|
1500
|
+
*/
|
|
1501
|
+
modified?: string;
|
|
1273
1502
|
};
|
|
1274
1503
|
ProjectMapNodeUpdate: {
|
|
1275
1504
|
/**
|
|
@@ -1279,7 +1508,7 @@ interface external {
|
|
|
1279
1508
|
id?: string;
|
|
1280
1509
|
/** @description Path representing the path to the current node */
|
|
1281
1510
|
path: string;
|
|
1282
|
-
/** @description Ordering of the node, higher numbers go after lower numbers
|
|
1511
|
+
/** @description Ordering of the node, higher numbers go after lower numbers */
|
|
1283
1512
|
order?: number;
|
|
1284
1513
|
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1285
1514
|
/** @description The name of the projectMap entry */
|
|
@@ -1314,7 +1543,7 @@ interface external {
|
|
|
1314
1543
|
/**
|
|
1315
1544
|
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1316
1545
|
* The preview value is used when editing a connected composition, and is the default
|
|
1317
|
-
* dynamic node value unless the author has explicitly chosen a different value
|
|
1546
|
+
* dynamic node value unless the author has explicitly chosen a different value
|
|
1318
1547
|
*/
|
|
1319
1548
|
previewValue?: string;
|
|
1320
1549
|
};
|
|
@@ -1322,7 +1551,7 @@ interface external {
|
|
|
1322
1551
|
/** @description The name of the query string parameter */
|
|
1323
1552
|
name: string;
|
|
1324
1553
|
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1325
|
-
value
|
|
1554
|
+
value?: string;
|
|
1326
1555
|
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1327
1556
|
helpText?: string;
|
|
1328
1557
|
};
|