@uniformdev/assets 19.158.0 → 19.159.1-alpha.16

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