@uniformdev/assets 19.154.1-alpha.21 → 19.154.1-alpha.24

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +179 -174
  2. package/dist/index.d.ts +179 -174
  3. 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,7 +368,7 @@ 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
374
  /** @description The configuration object for the type (type-specific) */
@@ -382,20 +382,20 @@ interface external {
382
382
  /** @description A list of component definition public IDs that are allowed in this named slot */
383
383
  allowedComponents: string[];
384
384
  /**
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.
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
387
387
  *
388
388
  * @default false
389
389
  */
390
390
  inheritAllowedComponents: boolean;
391
391
  /**
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.
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`
394
394
  */
395
395
  allowAllComponents?: boolean;
396
396
  /**
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>`
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>`
399
399
  */
400
400
  patternsInAllowedComponents?: boolean;
401
401
  /** @description Minimum valid number of components in this slot */
@@ -428,7 +428,7 @@ interface external {
428
428
  regularExpression?: string;
429
429
  /**
430
430
  * @description Custom error message when regular expression validation fails.
431
- * Has no effect if `regularExpression` is not set.
431
+ * Has no effect if `regularExpression` is not set
432
432
  */
433
433
  regularExpressionMessage?: string;
434
434
  };
@@ -438,7 +438,7 @@ interface external {
438
438
  /** @description Friendly name of the variant */
439
439
  name: string;
440
440
  };
441
- /** @description Permission set for a component defintion */
441
+ /** @description Permission set for a component definition */
442
442
  ComponentDefinitionPermission: {
443
443
  roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
444
444
  /**
@@ -463,23 +463,23 @@ interface external {
463
463
  icon?: string;
464
464
  /**
465
465
  * @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.
466
+ * The parameter type must support being used as a title parameter for this to work
467
467
  *
468
468
  * @default null
469
469
  */
470
470
  titleParameter?: string | null;
471
471
  /**
472
- * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
472
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
473
473
  *
474
474
  * @default null
475
475
  */
476
476
  thumbnailParameter?: string | null;
477
477
  /**
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.
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
479
479
  * @default false
480
480
  */
481
481
  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. */
482
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
483
483
  parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
484
484
  /**
485
485
  * Format: uuid
@@ -504,12 +504,12 @@ interface external {
504
504
  useTeamPermissions?: boolean;
505
505
  /** @description Custom role permissions for this component definition */
506
506
  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. */
507
+ /** @description The named slots for this component; placement areas where arrays of other components can be added */
508
508
  slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
509
509
  slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
510
510
  /** @description Default component instance value */
511
511
  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 */
512
+ /** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
513
513
  variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
514
514
  /** @description Created date string for this definition (ignored for writes) */
515
515
  created?: string;
@@ -517,7 +517,7 @@ interface external {
517
517
  updated?: string;
518
518
  /**
519
519
  * Format: uuid
520
- * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached.
520
+ * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
521
521
  */
522
522
  workflowId?: string;
523
523
  };
@@ -528,11 +528,11 @@ interface external {
528
528
  name: string;
529
529
  /**
530
530
  * @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.
531
- * The field type must support being used as an entry name for this to work.
531
+ * The field type must support being used as an entry name for this to work
532
532
  */
533
533
  entryName?: string | null;
534
534
  /**
535
- * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
535
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
536
536
  *
537
537
  * @default null
538
538
  */
@@ -569,29 +569,29 @@ interface external {
569
569
  permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
570
570
  /**
571
571
  * Format: uuid
572
- * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached.
572
+ * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
573
573
  */
574
574
  workflowId?: string;
575
575
  };
576
- /** @description Defines an editable parameter on a component. */
576
+ /** @description Defines an editable parameter on a component */
577
577
  ComponentParameter: {
578
- /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
578
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable */
579
579
  value?: unknown;
580
- /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
580
+ /** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
581
581
  type: string;
582
582
  /** @deprecated */
583
583
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
584
584
  /**
585
585
  * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
586
- * Note that locales must be registered on the entry/composition `_locales` before being used.
586
+ * Note that locales must be registered on the entry/composition `_locales` before being used
587
587
  */
588
588
  locales?: {
589
589
  [key: string]: unknown;
590
590
  };
591
591
  };
592
- /** @description Defines a connection to a dynamic token on a data resource. */
592
+ /** @description Defines a connection to a dynamic token on a data resource */
593
593
  DataElementConnectionDefinition: {
594
- /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
594
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value */
595
595
  pointer: string;
596
596
  /**
597
597
  * @description The syntax used to select the dynamic token to bind to
@@ -601,14 +601,14 @@ interface external {
601
601
  /**
602
602
  * @description The action to take if the dynamic token cannot be resolved
603
603
  * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
604
- * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
605
- * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
606
- * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
604
+ * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
605
+ * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
606
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
607
607
  * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
608
608
  * - c: COMPONENT: Removes the whole parent component or block that contains the property.
609
- * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
610
- * it is treated as an 'a' failure because removing the root means we must remove all.
611
- * - 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.
609
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
610
+ * it is treated as an 'a' failure because removing the root means we must remove all
611
+ * - 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
612
612
  *
613
613
  * @enum {string}
614
614
  */
@@ -624,11 +624,11 @@ interface external {
624
624
  failureLogLevel?: "e" | "w" | "i";
625
625
  /**
626
626
  * @description The default value to use if the dynamic token cannot be resolved.
627
- * This is only used if the failureAction is the default (undefined, or explicitly token).
627
+ * This is only used if the failureAction is the default (undefined, or explicitly token)
628
628
  */
629
629
  failureDefault?: string;
630
630
  };
631
- /** @description Defines the shape of a component instance served by the composition API. */
631
+ /** @description Defines the shape of a component instance served by the composition API */
632
632
  ComponentInstance: {
633
633
  /** @description Type of the component instance (public_id of its definition) */
634
634
  type: string;
@@ -646,15 +646,15 @@ interface external {
646
646
  * @description Unique identifier of the component within the composition.
647
647
  * No assumptions should be made about the format of this value other than "it will be unique."
648
648
  * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
649
- * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
649
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
650
650
  */
651
651
  _id?: string;
652
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
652
+ /** @description Indicates this component instance should be sourced from a pattern library pattern */
653
653
  _pattern?: string;
654
654
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
655
655
  /**
656
656
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
657
- * Means nothing for PUTs; it will be ignored.
657
+ * Means nothing for PUTs; it will be ignored
658
658
  */
659
659
  _patternDataResources?: {
660
660
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -670,7 +670,7 @@ interface external {
670
670
  * the composition's override replaces the pattern's.
671
671
  *
672
672
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
673
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
673
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
674
674
  */
675
675
  _overrides?: {
676
676
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
@@ -680,10 +680,10 @@ interface external {
680
680
  * by consumers of the pattern.
681
681
  *
682
682
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
683
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
683
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
684
684
  */
685
685
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
686
- /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
686
+ /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
687
687
  _locales?: string[];
688
688
  };
689
689
  /** @description Defines the shape of the root component in a composition */
@@ -696,31 +696,31 @@ interface external {
696
696
  };
697
697
  /** @description Public ID of alternate visual appearance for this component, if any selected */
698
698
  variant?: string;
699
- /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
699
+ /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
700
700
  projectMapNodes?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
701
701
  /** @description Slots containing any child components */
702
702
  slots?: {
703
703
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
704
704
  };
705
- /** @description The public UUID of the composition. */
705
+ /** @description The public UUID of the composition */
706
706
  _id: string;
707
- /** @description Slug pattern of this component. */
707
+ /** @description Slug pattern of this component */
708
708
  _slug?: string | null;
709
- /** @description Friendly name of this component. */
709
+ /** @description Friendly name of this component */
710
710
  _name: string;
711
- /** @description Name of the author of the most recent change. */
711
+ /** @description Name of the author of the most recent change */
712
712
  _author?: string;
713
- /** @description Identity subject of the author of the most recent change. */
713
+ /** @description Identity subject of the author of the most recent change */
714
714
  _authorSubject?: string;
715
- /** @description Name of the original creator. */
715
+ /** @description Name of the original creator */
716
716
  _creator?: string;
717
- /** @description Identity subject of the original creator. */
717
+ /** @description Identity subject of the original creator */
718
718
  _creatorSubject?: string;
719
- /** @description Indicates this component instance should be sourced from a pattern library pattern. */
719
+ /** @description Indicates this component instance should be sourced from a pattern library pattern */
720
720
  _pattern?: string;
721
721
  /**
722
722
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
723
- * Means nothing for PUTs; it will be ignored.
723
+ * Means nothing for PUTs; it will be ignored
724
724
  */
725
725
  _patternDataResources?: {
726
726
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -737,7 +737,7 @@ interface external {
737
737
  * the composition's override replaces the pattern's.
738
738
  *
739
739
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
740
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
740
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
741
741
  */
742
742
  _overrides?: {
743
743
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
@@ -747,17 +747,17 @@ interface external {
747
747
  * by consumers of the pattern.
748
748
  *
749
749
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
750
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
750
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
751
751
  */
752
752
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
753
- /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
753
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
754
754
  _locales?: string[];
755
755
  };
756
756
  /**
757
757
  * @description Defines how to override a specific component.
758
758
  *
759
759
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
760
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
760
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
761
761
  */
762
762
  ComponentOverride: {
763
763
  parameters?: {
@@ -773,19 +773,19 @@ interface external {
773
773
  * NOTE: Data resources' overridability is defined in the data resource definition, not here.
774
774
  *
775
775
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
776
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
776
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
777
777
  */
778
778
  ComponentOverridability: {
779
- /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
779
+ /** @description Defines component parameter value overrides. Keys are the parameter public ID */
780
780
  parameters?: {
781
781
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
782
782
  };
783
- /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
783
+ /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
784
784
  variants?: boolean;
785
785
  /**
786
786
  * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
787
787
  * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
788
- * If not set, the default is false.
788
+ * If not set, the default is false
789
789
  */
790
790
  hideLockedParameters?: boolean;
791
791
  };
@@ -793,7 +793,7 @@ interface external {
793
793
  * @description Whether a parameter is overridable
794
794
  *
795
795
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
796
- * Future updates that do not break the overrides-applied state of a composition may be made without notice.
796
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
797
797
  *
798
798
  * @enum {string}
799
799
  */
@@ -801,8 +801,8 @@ interface external {
801
801
  /**
802
802
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
803
803
  * These are created in the UI and shared across a whole project.
804
- * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
805
- * for all header, parameter, and variable values to obscure the actual encrypted secret value.
804
+ * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
805
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value
806
806
  */
807
807
  DataSource: {
808
808
  /** @description Public ID of the data source */
@@ -811,14 +811,14 @@ interface external {
811
811
  displayName: string;
812
812
  /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
813
813
  connectorType: string;
814
- /** @description Base resource URL of the data source. No trailing slash. */
814
+ /** @description Base resource URL of the data source. No trailing slash */
815
815
  baseUrl: string;
816
816
  /** @description HTTP headers to pass with requests to the data source */
817
817
  headers?: {
818
818
  key: string;
819
819
  value: string;
820
820
  }[];
821
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
821
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
822
822
  parameters?: {
823
823
  key: string;
824
824
  value: string;
@@ -829,21 +829,21 @@ interface external {
829
829
  };
830
830
  /**
831
831
  * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
832
- * If a locale is not mapped, it will be passed through to the data source as-is.
832
+ * If a locale is not mapped, it will be passed through to the data source as-is
833
833
  */
834
834
  localeMapping?: {
835
835
  [key: string]: string;
836
836
  };
837
- /** @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. */
837
+ /** @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 */
838
838
  customPublic?: {
839
839
  [key: string]: unknown;
840
840
  };
841
- /** @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. */
841
+ /** @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 */
842
842
  custom?: {
843
843
  [key: string]: unknown;
844
844
  };
845
845
  };
846
- /** @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. */
846
+ /** @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 */
847
847
  DataType: {
848
848
  /** @description Public ID of the data type */
849
849
  id: string;
@@ -854,39 +854,39 @@ interface external {
854
854
  /**
855
855
  * @description A connector-specific archetype for this data type; used to select UI as well as perform any
856
856
  * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
857
- * no special UI or processing is required.
857
+ * no special UI or processing is required
858
858
  */
859
859
  archetype?: string;
860
860
  allowedOnComponents?: string[];
861
- /** @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. */
861
+ /** @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 */
862
862
  path: string;
863
- /** @description Time-to-live (in seconds) for the resource data cache. */
863
+ /** @description Time-to-live (in seconds) for the resource data cache */
864
864
  ttl?: number;
865
- /** @description A key for the resource data cache purging. */
865
+ /** @description A key for the resource data cache purging */
866
866
  purgeKey?: string;
867
- /** @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. */
867
+ /** @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 */
868
868
  badgeIconUrl?: string;
869
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
869
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
870
870
  headers?: {
871
871
  key: string;
872
872
  value: string;
873
873
  omitIfEmpty?: boolean;
874
874
  }[];
875
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
875
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
876
876
  parameters?: {
877
877
  key: string;
878
878
  value: string;
879
879
  omitIfEmpty?: boolean;
880
880
  }[];
881
- /** @description Body to pass with requests to the data type (ignored unless method is POST) */
881
+ /** @description Body to pass with requests to the data type (ignored unless the method is POST) */
882
882
  body?: string;
883
883
  /**
884
- * @description HTTP method to use with requests to the data type.
884
+ * @description HTTP method to use with requests to the data type
885
885
  * @default GET
886
886
  * @enum {string}
887
887
  */
888
888
  method: "GET" | "POST" | "HEAD";
889
- /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
889
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
890
890
  variables?: {
891
891
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
892
892
  };
@@ -899,26 +899,26 @@ interface external {
899
899
  DataVariableDefinition: {
900
900
  /** @description Display name of the data variable */
901
901
  displayName?: string;
902
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
902
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
903
903
  helpText?: string;
904
904
  /**
905
- * @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.
905
+ * @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
906
906
  * @default text
907
907
  */
908
908
  type?: string;
909
909
  /** @description Default value of the data variable */
910
910
  default: string;
911
- /** @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. */
911
+ /** @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 */
912
912
  order?: number;
913
913
  /**
914
914
  * @description An optional arbitrary human readable source identifier to describe where this variable is from.
915
- * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
915
+ * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
916
916
  */
917
917
  source?: string;
918
918
  };
919
919
  /**
920
920
  * @description Data definitions attached to this component. The property name is the key of the data in the data document.
921
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
921
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
922
922
  */
923
923
  DataResourceDefinitions: {
924
924
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
@@ -927,25 +927,30 @@ interface external {
927
927
  DataResourceDefinition: {
928
928
  /** @description Public ID of the data type that provides this data */
929
929
  type: string;
930
- /** @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. */
930
+ /** @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 */
931
931
  isPatternParameter?: boolean;
932
932
  /**
933
933
  * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
934
934
  * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
935
- * If isPatternParameter is false or undefined, this has no meaning.
935
+ * If isPatternParameter is false or undefined, this has no meaning
936
936
  */
937
937
  ignorePatternParameterDefault?: boolean;
938
+ /**
939
+ * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
940
+ * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
941
+ */
942
+ optionalPatternParameter?: boolean;
938
943
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
939
944
  };
940
- /** @description Variable values for a data resource. */
945
+ /** @description Variable values for a data resource */
941
946
  DataResourceVariables: {
942
947
  [key: string]: string;
943
948
  };
944
949
  /**
945
950
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
946
951
  * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
947
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
948
- * Means nothing for PUTs; it will be ignored.
952
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
953
+ * Means nothing for PUTs; it will be ignored
949
954
  *
950
955
  * @enum {string}
951
956
  */
@@ -953,23 +958,23 @@ interface external {
953
958
  HistoryApiResponse: {
954
959
  /**
955
960
  * @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.
956
- * If this is undefined then no more results are available.
961
+ * If this is undefined then no more results are available
957
962
  */
958
963
  cursor?: string;
959
964
  /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
960
965
  truncated?: boolean;
961
- /** @description Version history entries. */
966
+ /** @description Version history entries */
962
967
  results?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
963
968
  };
964
969
  HistoryEntry: {
965
- /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
970
+ /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
966
971
  versionId: string;
967
- /** @description The timestamp when the version was created in epoch milliseconds. */
972
+ /** @description The timestamp when the version was created in epoch milliseconds */
968
973
  timestamp: number;
969
- /** @description The name (full name) of the user who created the version. */
974
+ /** @description The name (full name) of the user who created the version */
970
975
  authorName: string;
971
976
  authorIsApiKey: boolean;
972
- /** @description The state of the entity when the history entry was made. */
977
+ /** @description The state of the entity when the history entry was made */
973
978
  state: number;
974
979
  };
975
980
  /** @description Category for tagging canvas entities */
@@ -982,12 +987,12 @@ interface external {
982
987
  /** @description Display name of the category */
983
988
  name: string;
984
989
  /**
985
- * @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.
990
+ * @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
986
991
  * @default 0
987
992
  */
988
993
  order?: number;
989
994
  };
990
- /** @description Project map node information related to a component. */
995
+ /** @description Project map node information related to a component */
991
996
  CompositionProjectMapNodeInfo: {
992
997
  /**
993
998
  * Format: uuid
@@ -996,36 +1001,36 @@ interface external {
996
1001
  id: string;
997
1002
  /**
998
1003
  * @description Fallback path of the project map node.
999
- * Note that the node may have matched via a locale-specific path which is in the `locales` object.
1004
+ * Note that the node may have matched via a locale-specific path which is in the `locales` object
1000
1005
  */
1001
1006
  path: string;
1002
1007
  /**
1003
1008
  * Format: uuid
1004
- * @description Unique identifier for the project map that this node belongs to.
1009
+ * @description Unique identifier for the project map that this node belongs to
1005
1010
  */
1006
1011
  projectMapId: string;
1007
1012
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1008
1013
  /**
1009
1014
  * @description Locale-specific paths of the project map node.
1010
- * Keys are locale codes.
1015
+ * Keys are locale codes
1011
1016
  */
1012
1017
  locales?: {
1013
1018
  [key: string]: {
1014
- /** @description Locale-specific path of the project map node. */
1019
+ /** @description Locale-specific path of the project map node */
1015
1020
  path: string;
1016
- /** @description Whether the path is inherited from a parent node which defined a path segment in this locale. */
1021
+ /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
1017
1022
  inherited: boolean;
1018
1023
  };
1019
1024
  };
1020
1025
  };
1021
- /** @description AI Prompt definition. */
1026
+ /** @description AI Prompt definition */
1022
1027
  Prompt: {
1023
1028
  /**
1024
1029
  * Format: uuid
1025
1030
  * @description Unique identifier for the prompt
1026
1031
  */
1027
1032
  id: string;
1028
- /** @description Unique identifier for the integration that this prompt belongs to. */
1033
+ /** @description Unique identifier for the integration that this prompt belongs to */
1029
1034
  integrationType: string;
1030
1035
  /** @description Name for the prompt */
1031
1036
  name?: string | null;
@@ -1067,13 +1072,13 @@ interface external {
1067
1072
  /**
1068
1073
  * @description Name of the original creator of the workflow.
1069
1074
  * If undefined, the user has been removed from the team.
1070
- * Ignored for writes.
1075
+ * Ignored for writes
1071
1076
  */
1072
1077
  createdBy?: string;
1073
1078
  /**
1074
1079
  * @description Name of the last modifier of the workflow.
1075
1080
  * If undefined, the user has been removed from the team.
1076
- * Ignored for writes.
1081
+ * Ignored for writes
1077
1082
  */
1078
1083
  modifiedBy?: string;
1079
1084
  };
@@ -1083,9 +1088,9 @@ interface external {
1083
1088
  name: string;
1084
1089
  /**
1085
1090
  * @description Defines roles which have permissions to this workflow stage
1086
- * NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1091
+ * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1087
1092
  * 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
1088
- * listed here, the stage is read only and publishing is disabled.
1093
+ * listed here, the stage is read-only and publishing is disabled
1089
1094
  */
1090
1095
  permissions: {
1091
1096
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
@@ -1094,19 +1099,19 @@ interface external {
1094
1099
  * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
1095
1100
  * 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.
1096
1101
  * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
1097
- * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1102
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
1098
1103
  */
1099
1104
  autoPublish?: boolean;
1100
1105
  /**
1101
1106
  * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
1102
1107
  * If the entity is not valid, the transition will not be allowed.
1103
- * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1108
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
1104
1109
  */
1105
1110
  requireValidity?: boolean;
1106
1111
  /**
1107
1112
  * @description Defines transitions to other stages
1108
1113
  * Every stage must define at least one transition, to avoid creating a workflow that
1109
- * has a stage that can never be escaped.
1114
+ * has a stage that can never be escaped
1110
1115
  */
1111
1116
  transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
1112
1117
  /**
@@ -1114,7 +1119,7 @@ interface external {
1114
1119
  * @default chevron-double-right-o
1115
1120
  */
1116
1121
  icon?: string;
1117
- /** @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. */
1122
+ /** @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 */
1118
1123
  order?: number;
1119
1124
  };
1120
1125
  /** @description Definition of a transition from one stage to another in a workflow */
@@ -1126,12 +1131,12 @@ interface external {
1126
1131
  to: string;
1127
1132
  /**
1128
1133
  * @description Name shown to the user when they execute this transition.
1129
- * If not provided, a default name will be assigned automatically based on the target stage.
1134
+ * If not provided, a default name will be assigned automatically based on the target stage
1130
1135
  */
1131
1136
  name: string;
1132
1137
  /**
1133
1138
  * @description Permissions for the stage transition.
1134
- * NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
1139
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
1135
1140
  */
1136
1141
  permissions: {
1137
1142
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
@@ -1139,14 +1144,14 @@ interface external {
1139
1144
  };
1140
1145
  /** @description Permissions for a workflow stage */
1141
1146
  WorkflowStagePermission: {
1142
- /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
1147
+ /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
1143
1148
  write?: boolean;
1144
- /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
1149
+ /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
1145
1150
  publish?: boolean;
1146
1151
  };
1147
1152
  /** @description Permissions for a workflow stage transition */
1148
1153
  WorkflowStageTransitionPermission: {
1149
- /** @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. */
1154
+ /** @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 */
1150
1155
  execute?: boolean;
1151
1156
  };
1152
1157
  };
@@ -1170,12 +1175,12 @@ interface external {
1170
1175
  * - When unspecified, composition data is fetched from base.
1171
1176
  * - 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.
1172
1177
  *
1173
- * 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.
1178
+ * 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
1174
1179
  */
1175
1180
  releaseId?: string;
1176
- /** The id of the node to retrieve, cannot have both this parameter and Path */
1181
+ /** The id of the node to retrieve, cannot have both this parameter and `path` */
1177
1182
  id?: string;
1178
- /** The path of the root node to retrieve, cannot have both this parameter and Id */
1183
+ /** The path of the root node to retrieve, cannot have both this parameter and `id` */
1179
1184
  path?: string;
1180
1185
  /** Composition id to find associated sitemap nodes for */
1181
1186
  compositionId?: string;
@@ -1183,9 +1188,9 @@ interface external {
1183
1188
  limit?: number;
1184
1189
  /** Number of records to skip before returning nodes */
1185
1190
  offset?: number;
1186
- /** Depth of the tree to fetch. Only applies when fetching by path. */
1191
+ /** Depth of the tree to fetch. This only applies when fetching by path */
1187
1192
  depth?: number;
1188
- /** State of compositions to fetch. 0 = draft, 64 = published. */
1193
+ /** State of compositions to fetch. 0 = draft, 64 = published */
1189
1194
  state?: number;
1190
1195
  /** should the data be returned as a json tree object (or a flat array) */
1191
1196
  tree?: boolean;
@@ -1193,19 +1198,19 @@ interface external {
1193
1198
  search?: string;
1194
1199
  /**
1195
1200
  * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
1196
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
1201
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
1197
1202
  */
1198
1203
  includeAncestors?: boolean;
1199
- /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
1204
+ /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
1200
1205
  expanded?: boolean;
1201
- /** include basic composition information. ID, type, state, name, and definition id. */
1206
+ /** include basic composition information. ID, type, state, name, and definition id */
1202
1207
  withCompositionData?: boolean;
1203
1208
  /**
1204
1209
  * @deprecated Returns the UI status string of the composition.
1205
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
1210
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
1206
1211
  */
1207
1212
  withCompositionUIStatus?: boolean;
1208
- /** Include basic redirect information. */
1213
+ /** Include basic redirect information */
1209
1214
  withRedirectData?: boolean;
1210
1215
  };
1211
1216
  };
@@ -1315,7 +1320,7 @@ interface external {
1315
1320
  };
1316
1321
  };
1317
1322
  };
1318
- /** Handles preflight requests. This endpoint allows CORS. */
1323
+ /** Handles preflight requests. This endpoint allows CORS */
1319
1324
  options: {
1320
1325
  responses: {
1321
1326
  /** OK */
@@ -1334,7 +1339,7 @@ interface external {
1334
1339
  id: string;
1335
1340
  /** @description Path representing the path to the current node */
1336
1341
  path: string;
1337
- /** @description Ordering of the node, higher numbers go after lower numbers. */
1342
+ /** @description Ordering of the node, higher numbers go after lower numbers */
1338
1343
  order?: number;
1339
1344
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1340
1345
  /** @description The name of the projectMap entry */
@@ -1372,13 +1377,13 @@ interface external {
1372
1377
  /** @description Last segment of the url in this locale */
1373
1378
  pathSegment: string;
1374
1379
  /**
1375
- * @description When false, the node explicitly defines a locale specific path segment.
1380
+ * @description When false, the node explicitly defines a locale-specific path segment.
1376
1381
  *
1377
- * When true, an ancestor defines a locale specific path segment,
1382
+ * When true, an ancestor defines a locale-specific path segment,
1378
1383
  * which makes its descendants resolvable using that segment.
1379
- * This node does not define a locale specific path segment.
1384
+ * This node does not define a locale-specific path segment.
1380
1385
  *
1381
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
1386
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
1382
1387
  */
1383
1388
  inherited?: boolean;
1384
1389
  };
@@ -1396,22 +1401,22 @@ interface external {
1396
1401
  */
1397
1402
  id?: string;
1398
1403
  }[];
1399
- /** @description Basic information about a composition from the context of a project map node. */
1404
+ /** @description Basic information about a composition from the context of a project map node */
1400
1405
  ProjectMapNodeCompositionData: {
1401
1406
  /** @description Type of the composition instance (public_id of its definition) */
1402
1407
  type: string;
1403
1408
  /**
1404
1409
  * Format: uuid
1405
- * @description The public UUID of the composition.
1410
+ * @description The public UUID of the composition
1406
1411
  */
1407
1412
  id: string;
1408
- /** @description Slug pattern of this composition. */
1413
+ /** @description Slug pattern of this composition */
1409
1414
  slug?: string | null;
1410
- /** @description Friendly name of this composition. */
1415
+ /** @description Friendly name of this composition */
1411
1416
  name: string;
1412
1417
  /**
1413
1418
  * @deprecated
1414
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
1419
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1415
1420
  * @enum {string}
1416
1421
  */
1417
1422
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
@@ -1422,7 +1427,7 @@ interface external {
1422
1427
  icon?: string;
1423
1428
  /** @description Friendly name of this Composition's Definition */
1424
1429
  typeName?: string;
1425
- /** @description List of locales that the composition is available in. If empty, available in all locales. */
1430
+ /** @description List of locales that the composition is available in. If empty, available in all locales */
1426
1431
  locales: string[];
1427
1432
  };
1428
1433
  ProjectMapNodeUpdate: {
@@ -1433,7 +1438,7 @@ interface external {
1433
1438
  id?: string;
1434
1439
  /** @description Path representing the path to the current node */
1435
1440
  path: string;
1436
- /** @description Ordering of the node, higher numbers go after lower numbers. */
1441
+ /** @description Ordering of the node, higher numbers go after lower numbers */
1437
1442
  order?: number;
1438
1443
  data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1439
1444
  /** @description The name of the projectMap entry */
@@ -1468,7 +1473,7 @@ interface external {
1468
1473
  /**
1469
1474
  * @description For dynamic nodes, this is the preview value for the dynamic value.
1470
1475
  * The preview value is used when editing a connected composition, and is the default
1471
- * dynamic node value unless the author has explicitly chosen a different value.
1476
+ * dynamic node value unless the author has explicitly chosen a different value
1472
1477
  */
1473
1478
  previewValue?: string;
1474
1479
  };