@uniformdev/assets 19.195.0 → 19.195.1-alpha.3

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 +543 -2133
  2. package/dist/index.d.ts +543 -2133
  3. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -13,25 +13,22 @@ interface components$1 {
13
13
  helpText?: string;
14
14
  /** @description Type name of the parameter (provided by a Uniform integration) */
15
15
  type: string;
16
- /**
17
- * @description If true, this property can have locale-specific values. If false or not defined,
18
- * this property will have a single value that is shared for all locales
19
- */
16
+ /** @description If true, this property can have locale-specific values. If false or not defined,
17
+ * this property will have a single value that is shared for all locales
18
+ * */
20
19
  localizable?: boolean;
21
- /**
22
- * @description When `localizable` is true, this property controls the default localizability of the property.
23
- * true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
24
- * false/undefined - when the property has no existing value, it will store separate values for each enabled locale
20
+ /** @description When `localizable` is true, this property controls the default localizability of the property.
21
+ * true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
22
+ * false/undefined - when the property has no existing value, it will store separate values for each enabled locale
25
23
  *
26
- * If `localized` is false, this has no effect.
27
- */
24
+ * If `localized` is false, this has no effect.
25
+ * */
28
26
  notLocalizedByDefault?: boolean;
29
- /**
30
- * @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
31
- * When combined with a localized value, each locale has independent conditional values.
27
+ /** @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
28
+ * When combined with a localized value, each locale has independent conditional values.
32
29
  *
33
- * When not defined, conditional values are not allowed.
34
- */
30
+ * When not defined, conditional values are not allowed.
31
+ * */
35
32
  allowConditionalValues?: boolean;
36
33
  /** @description The configuration object for the type (type-specific) */
37
34
  typeConfig?: unknown;
@@ -45,20 +42,18 @@ interface components$1 {
45
42
  allowedComponents: string[];
46
43
  /**
47
44
  * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
48
- * If `allowAllComponents` is true, this value is ignored
45
+ * If `allowAllComponents` is true, this value is ignored
49
46
  *
50
47
  * @default false
51
48
  */
52
49
  inheritAllowedComponents: boolean;
53
- /**
54
- * @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.
55
- * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
56
- */
50
+ /** @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.
51
+ * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
52
+ * */
57
53
  allowAllComponents?: boolean;
58
- /**
59
- * @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
60
- * When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
61
- */
54
+ /** @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
55
+ * When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
56
+ * */
62
57
  patternsInAllowedComponents?: boolean;
63
58
  /** @description Minimum valid number of components in this slot */
64
59
  minComponents?: number;
@@ -69,9 +64,9 @@ interface components$1 {
69
64
  ComponentDefinitionSlugSettings: {
70
65
  /**
71
66
  * @description Whether the slug is required
72
- * no: slug is optional
73
- * yes: slug is required
74
- * disabled: slug is disabled and will not be shown in the editor
67
+ * no: slug is optional
68
+ * yes: slug is required
69
+ * disabled: slug is disabled and will not be shown in the editor
75
70
  *
76
71
  * @default no
77
72
  * @enum {string}
@@ -79,19 +74,18 @@ interface components$1 {
79
74
  required?: "no" | "yes" | "disabled";
80
75
  /**
81
76
  * @description Slug uniqueness configuration.
82
- * no = no unique constraint
83
- * local = must be unique within this component type
84
- * global = must be unique across all component types
77
+ * no = no unique constraint
78
+ * local = must be unique within this component type
79
+ * global = must be unique across all component types
85
80
  *
86
81
  * @enum {string}
87
82
  */
88
83
  unique?: "no" | "local" | "global";
89
84
  /** @description Regular expression slugs must match */
90
85
  regularExpression?: string;
91
- /**
92
- * @description Custom error message when regular expression validation fails.
93
- * Has no effect if `regularExpression` is not set
94
- */
86
+ /** @description Custom error message when regular expression validation fails.
87
+ * Has no effect if `regularExpression` is not set
88
+ * */
95
89
  regularExpressionMessage?: string;
96
90
  };
97
91
  /** @description The definition of a component variant */
@@ -105,7 +99,7 @@ interface components$1 {
105
99
  roleId: components$1["schemas"]["PublicIdProperty"];
106
100
  /**
107
101
  * @description Permission type for this permission ComponentDefinition:
108
- * read | write | create | delete
102
+ * read | write | create | delete
109
103
  *
110
104
  * @enum {string}
111
105
  */
@@ -125,7 +119,7 @@ interface components$1 {
125
119
  icon?: string;
126
120
  /**
127
121
  * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
128
- * The parameter type must support being used as a title parameter for this to work
122
+ * The parameter type must support being used as a title parameter for this to work
129
123
  *
130
124
  * @default null
131
125
  */
@@ -182,10 +176,9 @@ interface components$1 {
182
176
  id: components$1["schemas"]["PublicIdProperty"];
183
177
  /** @description Friendly name of the content type */
184
178
  name: string;
185
- /**
186
- * @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.
187
- * The field type must support being used as an entry name for this to work
188
- */
179
+ /** @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.
180
+ * The field type must support being used as an entry name for this to work
181
+ * */
189
182
  entryName?: string | null;
190
183
  /**
191
184
  * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
@@ -234,42 +227,40 @@ interface components$1 {
234
227
  type: string;
235
228
  /** @deprecated */
236
229
  connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
237
- /**
238
- * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
239
- * Note that locales must be registered on the entry/composition `_locales` before being used
240
- */
230
+ /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
231
+ * Note that locales must be registered on the entry/composition `_locales` before being used
232
+ * */
241
233
  locales?: {
242
234
  [key: string]: unknown;
243
235
  };
244
236
  conditions?: components$1["schemas"]["ComponentParameterConditions"];
245
- /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
237
+ /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
238
+ * */
246
239
  localesConditions?: {
247
240
  [key: string]: components$1["schemas"]["ComponentParameterConditions"];
248
241
  };
249
242
  };
250
- /**
251
- * @description Array of alternate values which are based on conditions.
243
+ /** @description Array of alternate values which are based on conditions.
252
244
  *
253
- * When requested with an explicit locale parameter, or via the route API:
254
- * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
255
- * * If no conditions match, the `value` property is used.
256
- * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
245
+ * When requested with an explicit locale parameter, or via the route API:
246
+ * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
247
+ * * If no conditions match, the `value` property is used.
248
+ * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
257
249
  *
258
- * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
259
- */
250
+ * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
251
+ * */
260
252
  ComponentParameterConditions: components$1["schemas"]["ComponentParameterConditionalValue"][];
261
- /** @description Defines a conditional value for a component parameter */
253
+ /** @description Defines a conditional value for a component parameter
254
+ * */
262
255
  ComponentParameterConditionalValue: {
263
256
  when: components$1["schemas"]["VisibilityCriteriaGroup"];
264
- /**
265
- * @description The value of the parameter. Any JSON-serializable value is acceptable.
266
- * A value of `null` will cause the parameter value to be removed, if it matches.
267
- */
257
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable.
258
+ * A value of `null` will cause the parameter value to be removed, if it matches.
259
+ * */
268
260
  value: unknown;
269
- /**
270
- * @description Unique sequence identifier of the conditional value within the component parameter.
271
- * This value must be unique within the conditional values array, and it should not change after a condition is created.
272
- */
261
+ /** @description Unique sequence identifier of the conditional value within the component parameter.
262
+ * This value must be unique within the conditional values array, and it should not change after a condition is created.
263
+ * */
273
264
  id: number;
274
265
  };
275
266
  /**
@@ -291,17 +282,17 @@ interface components$1 {
291
282
  VisibilityCriteria: {
292
283
  /** @description The rule type to execute */
293
284
  rule: string;
294
- /**
295
- * @description The source value of the rule.
296
- * For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
297
- */
285
+ /** @description The source value of the rule.
286
+ * For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
287
+ * */
298
288
  source?: string;
299
289
  /** @description The rule-definition-specific operator to test against */
300
290
  op: string;
301
291
  /** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
302
292
  value: string | string[];
303
293
  };
304
- /** @description Defines a connection to a dynamic token on a data resource */
294
+ /** @description Defines a connection to a dynamic token on a data resource
295
+ * */
305
296
  DataElementConnectionDefinition: {
306
297
  /** @description A JSON Pointer expression that defines the data resource dynamic token value */
307
298
  pointer: string;
@@ -312,32 +303,31 @@ interface components$1 {
312
303
  syntax: "jptr";
313
304
  /**
314
305
  * @description The action to take if the dynamic token cannot be resolved
315
- * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
316
- * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
317
- * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
318
- * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
319
- * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
320
- * - c: COMPONENT: Removes the whole parent component or block that contains the property.
321
- * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
322
- * it is treated as an 'a' failure because removing the root means we must remove all
323
- * - 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
306
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
307
+ * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
308
+ * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
309
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
310
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
311
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
312
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
313
+ * it is treated as an 'a' failure because removing the root means we must remove all
314
+ * - 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
324
315
  *
325
316
  * @enum {string}
326
317
  */
327
318
  failureAction?: "t" | "p" | "c" | "a";
328
319
  /**
329
320
  * @description How to report when the dynamic token cannot be resolved
330
- * - e: ERROR: Report an error message (this will prevent publishing)
331
- * - w: WARNING: Report a warning message [default]
332
- * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
321
+ * - e: ERROR: Report an error message (this will prevent publishing)
322
+ * - w: WARNING: Report a warning message [default]
323
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
333
324
  *
334
325
  * @enum {string}
335
326
  */
336
327
  failureLogLevel?: "e" | "w" | "i";
337
- /**
338
- * @description The default value to use if the dynamic token cannot be resolved.
339
- * This is only used if the failureAction is the default (undefined, or explicitly token)
340
- */
328
+ /** @description The default value to use if the dynamic token cannot be resolved.
329
+ * This is only used if the failureAction is the default (undefined, or explicitly token)
330
+ * */
341
331
  failureDefault?: string;
342
332
  };
343
333
  /** @description Defines the shape of a component instance served by the composition API */
@@ -354,46 +344,42 @@ interface components$1 {
354
344
  slots?: {
355
345
  [key: string]: components$1["schemas"]["ComponentInstance"][];
356
346
  };
357
- /**
358
- * @description Unique identifier of the component within the composition.
359
- * No assumptions should be made about the format of this value other than "it will be unique."
360
- * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
361
- * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
362
- */
347
+ /** @description Unique identifier of the component within the composition.
348
+ * No assumptions should be made about the format of this value other than "it will be unique."
349
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
350
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
351
+ * */
363
352
  _id?: string;
364
353
  /** @description Indicates this component instance should be sourced from a pattern library pattern */
365
354
  _pattern?: string;
366
355
  _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
367
- /**
368
- * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
369
- * Means nothing for PUTs; it will be ignored
370
- */
356
+ /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
357
+ * Means nothing for PUTs; it will be ignored
358
+ * */
371
359
  _patternDataResources?: {
372
360
  [key: string]: components$1["schemas"]["DataResourceDefinition"];
373
361
  };
374
362
  _patternError?: components$1["schemas"]["PatternError"];
375
- /**
376
- * @description Defines patch overrides to component IDs that live in the composition.
377
- * This can be used to override parameters that are defined on patterns,
378
- * including nested patterns, with values that are specific to this composition.
379
- * The keys in this object are component IDs.
380
- * Overrides are applied from the top down, so for example if both the composition
381
- * and a pattern on the composition define an override on a nested pattern,
382
- * the composition's override replaces the pattern's.
363
+ /** @description Defines patch overrides to component IDs that live in the composition.
364
+ * This can be used to override parameters that are defined on patterns,
365
+ * including nested patterns, with values that are specific to this composition.
366
+ * The keys in this object are component IDs.
367
+ * Overrides are applied from the top down, so for example if both the composition
368
+ * and a pattern on the composition define an override on a nested pattern,
369
+ * the composition's override replaces the pattern's.
383
370
  *
384
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
385
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
386
- */
371
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
372
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
373
+ * */
387
374
  _overrides?: {
388
375
  [key: string]: components$1["schemas"]["ComponentOverride"];
389
376
  };
390
- /**
391
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
392
- * by consumers of the pattern.
377
+ /** @description When used on a pattern, defines how the pattern's parameters may be overridden
378
+ * by consumers of the pattern.
393
379
  *
394
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
395
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
396
- */
380
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
381
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
382
+ * */
397
383
  _overridability?: components$1["schemas"]["ComponentOverridability"];
398
384
  /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
399
385
  _locales?: string[];
@@ -430,47 +416,43 @@ interface components$1 {
430
416
  _creatorSubject?: string;
431
417
  /** @description Indicates this component instance should be sourced from a pattern library pattern */
432
418
  _pattern?: string;
433
- /**
434
- * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
435
- * Means nothing for PUTs; it will be ignored
436
- */
419
+ /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
420
+ * Means nothing for PUTs; it will be ignored
421
+ * */
437
422
  _patternDataResources?: {
438
423
  [key: string]: components$1["schemas"]["DataResourceDefinition"];
439
424
  };
440
425
  _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
441
426
  _patternError?: components$1["schemas"]["PatternError"];
442
- /**
443
- * @description Defines patch overrides to component IDs that live in the composition.
444
- * This can be used to override parameters that are defined on patterns,
445
- * including nested patterns, with values that are specific to this composition.
446
- * The keys in this object are component IDs.
447
- * Overrides are applied from the top down, so for example if both the composition
448
- * and a pattern on the composition define an override on a nested pattern,
449
- * the composition's override replaces the pattern's.
427
+ /** @description Defines patch overrides to component IDs that live in the composition.
428
+ * This can be used to override parameters that are defined on patterns,
429
+ * including nested patterns, with values that are specific to this composition.
430
+ * The keys in this object are component IDs.
431
+ * Overrides are applied from the top down, so for example if both the composition
432
+ * and a pattern on the composition define an override on a nested pattern,
433
+ * the composition's override replaces the pattern's.
450
434
  *
451
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
452
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
453
- */
435
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
436
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
437
+ * */
454
438
  _overrides?: {
455
439
  [key: string]: components$1["schemas"]["ComponentOverride"];
456
440
  };
457
- /**
458
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
459
- * by consumers of the pattern.
441
+ /** @description When used on a pattern, defines how the pattern's parameters may be overridden
442
+ * by consumers of the pattern.
460
443
  *
461
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
462
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
463
- */
444
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
445
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
446
+ * */
464
447
  _overridability?: components$1["schemas"]["ComponentOverridability"];
465
448
  /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
466
449
  _locales?: string[];
467
450
  };
468
- /**
469
- * @description Defines how to override a specific component.
451
+ /** @description Defines how to override a specific component.
470
452
  *
471
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
472
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
473
- */
453
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
454
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
455
+ * */
474
456
  ComponentOverride: {
475
457
  parameters?: {
476
458
  [key: string]: components$1["schemas"]["ComponentParameter"];
@@ -480,13 +462,12 @@ interface components$1 {
480
462
  };
481
463
  variant?: string;
482
464
  };
483
- /**
484
- * @description Defines how a component on a pattern may have its values overridden.
485
- * NOTE: Data resources' overridability is defined in the data resource definition, not here.
465
+ /** @description Defines how a component on a pattern may have its values overridden.
466
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
486
467
  *
487
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
488
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
489
- */
468
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
469
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
470
+ * */
490
471
  ComponentOverridability: {
491
472
  /** @description Defines component parameter value overrides. Keys are the parameter public ID */
492
473
  parameters?: {
@@ -494,23 +475,23 @@ interface components$1 {
494
475
  };
495
476
  /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
496
477
  variants?: boolean;
497
- /**
498
- * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
499
- * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
500
- * If not set, the default is false
501
- */
478
+ /** @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
479
+ * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
480
+ * If not set, the default is false
481
+ * */
502
482
  hideLockedParameters?: boolean;
503
483
  };
504
484
  /**
505
485
  * @description Whether a parameter is overridable
506
486
  *
507
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
508
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
487
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
488
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice
509
489
  *
510
490
  * @enum {string}
511
491
  */
512
492
  OverrideOptions: "yes" | "no";
513
- /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
493
+ /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data.
494
+ * */
514
495
  AlternativeDataSourceData: {
515
496
  /** @description Base resource URL of the data source. No trailing slash */
516
497
  baseUrl: string;
@@ -531,12 +512,11 @@ interface components$1 {
531
512
  [key: string]: components$1["schemas"]["DataVariableDefinition"];
532
513
  };
533
514
  };
534
- /**
535
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
536
- * These are created in the UI and shared across a whole project.
537
- * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
538
- * for all header, parameter, and variable values to obscure the actual encrypted secret value
539
- */
515
+ /** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
516
+ * These are created in the UI and shared across a whole project.
517
+ * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
518
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value
519
+ * */
540
520
  DataSource: {
541
521
  /** @description Public ID of the data source */
542
522
  id: string;
@@ -560,17 +540,15 @@ interface components$1 {
560
540
  variables?: {
561
541
  [key: string]: components$1["schemas"]["DataVariableDefinition"];
562
542
  };
563
- /**
564
- * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
565
- * If a locale is not mapped, it will be passed through to the data source as-is
566
- */
543
+ /** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
544
+ * If a locale is not mapped, it will be passed through to the data source as-is
545
+ * */
567
546
  localeMapping?: {
568
547
  [key: string]: string;
569
548
  };
570
- /**
571
- * @description If true, data source will require additional credentials to access unpublished data.
572
- * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
573
- */
549
+ /** @description If true, data source will require additional credentials to access unpublished data.
550
+ * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
551
+ * */
574
552
  enableUnpublishedMode?: boolean;
575
553
  /** @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 */
576
554
  customPublic?: {
@@ -593,11 +571,10 @@ interface components$1 {
593
571
  displayName: string;
594
572
  /** @description Public ID of the associated data source */
595
573
  dataSourceId: string;
596
- /**
597
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
598
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
599
- * no special UI or processing is required
600
- */
574
+ /** @description A connector-specific archetype for this data type; used to select UI as well as perform any
575
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
576
+ * no special UI or processing is required
577
+ * */
601
578
  archetype?: string;
602
579
  allowedOnComponents?: string[];
603
580
  /** @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 */
@@ -652,16 +629,14 @@ interface components$1 {
652
629
  default: string;
653
630
  /** @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 */
654
631
  order?: number;
655
- /**
656
- * @description An optional arbitrary human readable source identifier to describe where this variable is from.
657
- * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
658
- */
632
+ /** @description An optional arbitrary human readable source identifier to describe where this variable is from.
633
+ * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
634
+ * */
659
635
  source?: string;
660
636
  };
661
- /**
662
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
663
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
664
- */
637
+ /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
638
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
639
+ * */
665
640
  DataResourceDefinitions: {
666
641
  [key: string]: components$1["schemas"]["DataResourceDefinition"];
667
642
  };
@@ -671,16 +646,14 @@ interface components$1 {
671
646
  type: string;
672
647
  /** @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 */
673
648
  isPatternParameter?: boolean;
674
- /**
675
- * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
676
- * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
677
- * If isPatternParameter is false or undefined, this has no meaning
678
- */
649
+ /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
650
+ * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
651
+ * If isPatternParameter is false or undefined, this has no meaning
652
+ * */
679
653
  ignorePatternParameterDefault?: boolean;
680
- /**
681
- * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
682
- * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
683
- */
654
+ /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
655
+ * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
656
+ * */
684
657
  optionalPatternParameter?: boolean;
685
658
  variables?: components$1["schemas"]["DataResourceVariables"];
686
659
  };
@@ -690,18 +663,17 @@ interface components$1 {
690
663
  };
691
664
  /**
692
665
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
693
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
694
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
695
- * Means nothing for PUTs; it will be ignored
666
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
667
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
668
+ * Means nothing for PUTs; it will be ignored
696
669
  *
697
670
  * @enum {string}
698
671
  */
699
672
  PatternError: "NOTFOUND" | "CYCLIC";
700
673
  HistoryApiResponse: {
701
- /**
702
- * @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.
703
- * If this is undefined then no more results are available
704
- */
674
+ /** @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.
675
+ * If this is undefined then no more results are available
676
+ * */
705
677
  cursor?: string;
706
678
  /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
707
679
  truncated?: boolean;
@@ -741,26 +713,25 @@ interface components$1 {
741
713
  * @description Unique identifier for the project map node
742
714
  */
743
715
  id: string;
744
- /**
745
- * @description Fallback path of the project map node.
746
- * Note that the node may have matched via a locale-specific path which is in the `locales` object
747
- */
716
+ /** @description Fallback path of the project map node.
717
+ * Note that the node may have matched via a locale-specific path which is in the `locales` object
718
+ * */
748
719
  path: string;
749
720
  /**
750
721
  * Format: uuid
751
722
  * @description Unique identifier for the project map that this node belongs to
752
723
  */
753
724
  projectMapId: string;
754
- data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
755
- /**
756
- * @description Locale-specific paths of the project map node.
757
- * Keys are locale codes
758
- */
725
+ data?: components$1["schemas"]["ProjectMapNodeData"];
726
+ /** @description Locale-specific paths of the project map node.
727
+ * Keys are locale codes
728
+ * */
759
729
  locales?: {
760
730
  [key: string]: {
761
731
  /** @description Locale-specific path of the project map node */
762
732
  path: string;
763
- /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
733
+ /** @description Whether the path is inherited from a parent node which defined a path segment in this locale
734
+ * */
764
735
  inherited: boolean;
765
736
  };
766
737
  };
@@ -811,50 +782,44 @@ interface components$1 {
811
782
  modified?: string;
812
783
  /** @description Created ISO date string for this definition (ignored for writes) */
813
784
  created?: string;
814
- /**
815
- * @description Name of the original creator of the workflow.
816
- * If undefined, the user has been removed from the team.
817
- * Ignored for writes
818
- */
785
+ /** @description Name of the original creator of the workflow.
786
+ * If undefined, the user has been removed from the team.
787
+ * Ignored for writes
788
+ * */
819
789
  createdBy?: string;
820
- /**
821
- * @description Name of the last modifier of the workflow.
822
- * If undefined, the user has been removed from the team.
823
- * Ignored for writes
824
- */
790
+ /** @description Name of the last modifier of the workflow.
791
+ * If undefined, the user has been removed from the team.
792
+ * Ignored for writes
793
+ * */
825
794
  modifiedBy?: string;
826
795
  };
827
796
  /** @description Definition of a stage in a workflow */
828
797
  WorkflowStage: {
829
798
  /** @description Name of the stage */
830
799
  name: string;
831
- /**
832
- * @description Defines roles which have permissions to this workflow stage
833
- * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
834
- * 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
835
- * listed here, the stage is read-only and publishing is disabled
836
- */
800
+ /** @description Defines roles which have permissions to this workflow stage
801
+ * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
802
+ * 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
803
+ * listed here, the stage is read-only and publishing is disabled
804
+ * */
837
805
  permissions: {
838
806
  [key: string]: components$1["schemas"]["WorkflowStagePermission"];
839
807
  };
840
- /**
841
- * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
842
- * 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.
843
- * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
844
- * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
845
- */
808
+ /** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
809
+ * 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.
810
+ * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
811
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
812
+ * */
846
813
  autoPublish?: boolean;
847
- /**
848
- * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
849
- * If the entity is not valid, the transition will not be allowed.
850
- * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
851
- */
814
+ /** @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
815
+ * If the entity is not valid, the transition will not be allowed.
816
+ * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
817
+ * */
852
818
  requireValidity?: boolean;
853
- /**
854
- * @description Defines transitions to other stages
855
- * Every stage must define at least one transition, to avoid creating a workflow that
856
- * has a stage that can never be escaped
857
- */
819
+ /** @description Defines transitions to other stages
820
+ * Every stage must define at least one transition, to avoid creating a workflow that
821
+ * has a stage that can never be escaped
822
+ * */
858
823
  transitions: components$1["schemas"]["WorkflowStageTransition"][];
859
824
  /**
860
825
  * @description Icon name for the stage (e.g. 'chevron-double-right-o')
@@ -871,15 +836,13 @@ interface components$1 {
871
836
  * @description The target stage to transition to
872
837
  */
873
838
  to: string;
874
- /**
875
- * @description Name shown to the user when they execute this transition.
876
- * If not provided, a default name will be assigned automatically based on the target stage
877
- */
839
+ /** @description Name shown to the user when they execute this transition.
840
+ * If not provided, a default name will be assigned automatically based on the target stage
841
+ * */
878
842
  name: string;
879
- /**
880
- * @description Permissions for the stage transition.
881
- * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
882
- */
843
+ /** @description Permissions for the stage transition.
844
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
845
+ * */
883
846
  permissions: {
884
847
  [key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
885
848
  };
@@ -896,526 +859,105 @@ interface components$1 {
896
859
  /** @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 */
897
860
  execute?: boolean;
898
861
  };
899
- };
900
- }
901
- interface external$1 {
902
- "swagger.yml": {
903
- paths: {};
904
- components: {
905
- schemas: {
906
- Error: {
907
- /** @description Error message(s) that occurred while processing the request */
908
- errorMessage?: string[] | string;
909
- };
910
- };
911
- responses: {
912
- /** Request input validation failed */
913
- BadRequestError: {
914
- content: {
915
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
916
- };
917
- };
918
- /** API key or token was not valid */
919
- UnauthorizedError: {
920
- content: {
921
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
922
- };
923
- };
924
- /** Permission was denied */
925
- ForbiddenError: {
926
- content: {
927
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
928
- };
929
- };
930
- /** Resource not found */
931
- NotFoundError: {
932
- content: {
933
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
934
- };
935
- };
936
- /** Too many requests in allowed time period */
937
- RateLimitError: unknown;
938
- /** Execution error occurred */
939
- InternalServerError: unknown;
940
- };
941
- };
942
- operations: {};
943
- };
944
- "v1-project-map-nodes.swagger.yml": {
945
- paths: {
946
- "/api/v1/project-map-nodes": {
947
- /** Called to get a list of nodes belonging to a specific path or Id */
948
- get: {
949
- parameters: {
950
- query: {
951
- /** The project map id that the desired nodes belong */
952
- projectMapId?: string;
953
- /** The project id that contains the project map tree that this node belongs to */
954
- projectId: string;
955
- /**
956
- * The ID of a release to fetch the composition data for.
957
- *
958
- * - When unspecified, composition data is fetched from base.
959
- * - 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.
960
- *
961
- * 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
962
- */
963
- releaseId?: string;
964
- /** The id of the node to retrieve, cannot have both this parameter and `path` */
965
- id?: string;
966
- /** The path of the root node to retrieve, cannot have both this parameter and `id` */
967
- path?: string;
968
- /** Composition id to find associated project map node for */
969
- compositionId?: string;
970
- /** Limit the number or records returned by a number */
971
- limit?: number;
972
- /** Number of records to skip before returning nodes */
973
- offset?: number;
974
- /** Depth of the tree to fetch. This only applies when fetching by path */
975
- depth?: number;
976
- /** State of compositions to fetch. 0 = draft, 64 = published */
977
- state?: number;
978
- /** should the data be returned as a json tree object (or a flat array) */
979
- tree?: boolean;
980
- /** text search filter */
981
- search?: string;
982
- /**
983
- * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
984
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
985
- */
986
- includeAncestors?: boolean;
987
- /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
988
- expanded?: boolean;
989
- /** include basic composition information. ID, type, state, name, and definition id */
990
- withCompositionData?: boolean;
991
- /**
992
- * @deprecated Returns the UI status string of the composition.
993
- * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
994
- */
995
- withCompositionUIStatus?: boolean;
996
- /** Include basic redirect information */
997
- withRedirectData?: boolean;
998
- };
999
- };
1000
- responses: {
1001
- /** OK */
1002
- 200: {
1003
- content: {
1004
- "application/json": {
1005
- nodes?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
1006
- tree?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
1007
- };
1008
- };
1009
- };
1010
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
1011
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1012
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1013
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
1014
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
1015
- };
1016
- };
1017
- /** Called to insert or update a node or nodes */
1018
- put: {
1019
- responses: {
1020
- /** OK */
1021
- 204: never;
1022
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
1023
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1024
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1025
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
1026
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
1027
- };
1028
- requestBody: {
1029
- content: {
1030
- "application/json": {
1031
- /** @description An array of projectMap node objects to be updated or inserted */
1032
- nodes: {
1033
- node: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
1034
- /** @description The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
1035
- previousSibling?: string;
1036
- /** @description The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
1037
- nextSibling?: string;
1038
- }[];
1039
- /**
1040
- * Format: uuid
1041
- * @description The project id of the project that the projectMap belongs to
1042
- */
1043
- projectId: string;
1044
- /**
1045
- * Format: uuid
1046
- * @description The projectMap id that the changing or inserting nodes belong to
1047
- */
1048
- projectMapId?: string;
1049
- };
1050
- };
1051
- };
1052
- };
1053
- /** Called to delete a particular projectMap node by id or path */
1054
- delete: {
1055
- responses: {
1056
- /** OK */
1057
- 204: never;
1058
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
1059
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1060
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1061
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
1062
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
1063
- };
1064
- requestBody: {
1065
- content: {
1066
- "application/json": {
1067
- /**
1068
- * Format: uuid
1069
- * @description Id of the projectMap node to delete
1070
- */
1071
- nodeId?: string;
1072
- /** @description Path to the projectMap node to delete */
1073
- path: string;
1074
- /**
1075
- * Format: uuid
1076
- * @description Project map id that the node to delete belongs to
1077
- */
1078
- projectMapId?: string;
1079
- /**
1080
- * Format: uuid
1081
- * @description Project id that the project map belongs to
1082
- */
1083
- projectId: string;
1084
- } | {
1085
- /**
1086
- * Format: uuid
1087
- * @description Id of the projectMap node to delete
1088
- */
1089
- nodeId: string;
1090
- /** @description Path to the projectMap node to delete */
1091
- path?: string;
1092
- /**
1093
- * Format: uuid
1094
- * @description Project map id that the node to delete belongs to
1095
- */
1096
- projectMapId?: string;
1097
- /**
1098
- * Format: uuid
1099
- * @description Project id that the project map belongs to
1100
- */
1101
- projectId: string;
1102
- };
1103
- };
1104
- };
1105
- };
1106
- /** Handles preflight requests. This endpoint allows CORS */
1107
- options: {
1108
- responses: {
1109
- /** OK */
1110
- 204: never;
1111
- };
1112
- };
1113
- };
1114
- };
1115
- components: {
1116
- schemas: {
1117
- ProjectMapNodeDefinition: {
1118
- /**
1119
- * Format: uuid
1120
- * @description The id of the projectMap entry
1121
- */
1122
- id: string;
1123
- /** @description Path representing the path to the current node */
1124
- path: string;
1125
- /** @description Ordering of the node, higher numbers go after lower numbers */
1126
- order?: number;
1127
- data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1128
- /** @description The name of the projectMap entry */
1129
- name: string;
1130
- /**
1131
- * @description The type of the projectMap entry
1132
- * @enum {string}
1133
- */
1134
- type: "composition" | "placeholder";
1135
- /**
1136
- * Format: uuid
1137
- * @description The composition id related to the projectMap entry
1138
- */
1139
- compositionId?: string;
1140
- /** @description Description of the projectMap node */
1141
- description?: string;
1142
- /** @description Parent path of the current node, only included if requested with the expanded flag */
1143
- parentPath?: string;
1144
- /** @description Last segment of the url */
1145
- pathSegment?: string;
1146
- /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
1147
- isLeaf?: boolean;
1148
- compositionData?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
1149
- sourceRedirects?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
1150
- targetRedirects?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
1151
- locales?: {
1152
- [key: string]: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
1153
- };
1154
- };
1155
- ProjectMapNodeLocale: {
1156
- /** @description Name of node in the locale */
1157
- name?: string;
1158
- /** @description Full path to the current node in this locale, only included if requested with the expanded flag */
1159
- path?: string;
1160
- /** @description Last segment of the url in this locale */
1161
- pathSegment: string;
1162
- /**
1163
- * @description When false, the node explicitly defines a locale-specific path segment.
1164
- *
1165
- * When true, an ancestor defines a locale-specific path segment,
1166
- * which makes its descendants resolvable using that segment.
1167
- * This node does not define a locale-specific path segment.
1168
- *
1169
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
1170
- */
1171
- inherited?: boolean;
1172
- };
1173
- ProjectMapSourceRedirectData: {
1174
- /**
1175
- * Format: uuid
1176
- * @description The public UUID of the source redirect
1177
- */
1178
- id?: string;
1179
- }[];
1180
- ProjectMapTargetRedirectData: {
1181
- /**
1182
- * Format: uuid
1183
- * @description The public UUID of the target redirect
1184
- */
1185
- id?: string;
1186
- }[];
1187
- /**
1188
- * @description Basic information about the linked composition from the context of a project map node.
1189
- * If the linked composition has editions, the editions are included in the `editions` property.
1190
- */
1191
- ProjectMapNodeCompositionData: {
1192
- /** @description Type of the linked composition (id of its definition) */
1193
- type: string;
1194
- /**
1195
- * Format: uuid
1196
- * @description The UUID of the linked composition
1197
- */
1198
- id: string;
1199
- /**
1200
- * Format: uuid
1201
- * @description The edition UUID underneath the linked composition
1202
- * This is only present if the composition has not been published, but an edition has
1203
- */
1204
- editionId?: string;
1205
- /** @description Slug pattern of the linked composition or edition */
1206
- slug?: string | null;
1207
- /** @description Friendly name of this composition or edition */
1208
- name: string;
1209
- /**
1210
- * @deprecated
1211
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1212
- * @enum {string}
1213
- */
1214
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1215
- /**
1216
- * @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
1217
- * @default screen
1218
- */
1219
- icon?: string;
1220
- /** @description Friendly name of this Composition's Definition */
1221
- typeName?: string;
1222
- /**
1223
- * @description List of locales that the composition _or any of its editions_ is available in.
1224
- * If empty, available in all locales.
1225
- */
1226
- locales: string[];
1227
- /** @description Priority of the composition relative to any editions */
1228
- editionPriority?: number;
1229
- /** @description Friendly name of the edition */
1230
- editionName?: string;
1231
- /**
1232
- * @deprecated
1233
- * @description List of editions available for this composition. The composition is included in the list, it is the edition
1234
- * where the editionID equals the node's compositionID.
1235
- */
1236
- editions?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
1237
- };
1238
- /**
1239
- * @deprecated
1240
- * @description Basic information about a composition edition from the context of a project map node
1241
- */
1242
- ProjectMapNodeCompositionEditionData: {
1243
- /**
1244
- * Format: uuid
1245
- * @description The UUID of the linked composition
1246
- */
1247
- id: string;
1248
- /** @description Type of the edition instance (public_id of its definition) */
1249
- type: string;
1250
- /**
1251
- * Format: uuid
1252
- * @description The edition UUID underneath the linked composition
1253
- */
1254
- editionId?: string;
1255
- /** @description Slug pattern of this edition */
1256
- slug?: string | null;
1257
- /** @description Friendly name of the linked composition */
1258
- name: string;
1259
- /** @description Friendly name of the edition */
1260
- editionName?: string;
1261
- /** @description Priority of the edition */
1262
- editionPriority?: number;
1263
- /**
1264
- * @deprecated
1265
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
1266
- * @enum {string}
1267
- */
1268
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1269
- /**
1270
- * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
1271
- * @default screen
1272
- */
1273
- icon?: string;
1274
- /** @description Friendly name of this edition's definition */
1275
- typeName?: string;
1276
- /** @description List of locales that the edition is available in. If empty, available in all locales */
1277
- locales: string[];
1278
- /**
1279
- * Format: date-time
1280
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
1281
- */
1282
- modified?: string;
1283
- };
1284
- ProjectMapNodeUpdate: {
1285
- /**
1286
- * Format: uuid
1287
- * @description The id of the projectMap entry
1288
- */
1289
- id?: string;
1290
- /** @description Path representing the path to the current node */
1291
- path: string;
1292
- /** @description Ordering of the node, higher numbers go after lower numbers */
1293
- order?: number;
1294
- data?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1295
- /** @description The name of the projectMap entry */
1296
- name: string;
1297
- /**
1298
- * @description The type of the projectMap entry
1299
- * @enum {string}
1300
- */
1301
- type: "composition" | "placeholder";
1302
- /**
1303
- * Format: uuid
1304
- * @description The composition id related to the projectMap entry
1305
- */
1306
- compositionId?: string;
1307
- /** @description Description of the projectMap node */
1308
- description?: string;
1309
- locales?: {
1310
- [key: string]: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
1311
- };
1312
- };
1313
- ProjectMapNodeLocaleUpdate: {
1314
- /** @description Name of node in the locale */
1315
- name?: string;
1316
- /** @description Locale specific path segment for this node (not a full path) */
1317
- pathSegment: string;
1318
- };
1319
- ProjectMapNodeData: {
1320
- /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
1321
- isSearchHit?: boolean;
1322
- /** @description Query strings that are allowed to be passed to the node */
1323
- queryStrings?: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
1324
- /**
1325
- * @description For dynamic nodes, this is the preview value for the dynamic value.
1326
- * The preview value is used when editing a connected composition, and is the default
1327
- * dynamic node value unless the author has explicitly chosen a different value
1328
- */
1329
- previewValue?: string;
1330
- };
1331
- ProjectMapNodeAllowedQueryString: {
1332
- /** @description The name of the query string parameter */
1333
- name: string;
1334
- /** @description The default value of the query string if it is not provided by an incoming route path */
1335
- value?: string;
1336
- /** @description Help text for authors who might be setting up a preview value for this query string */
1337
- helpText?: string;
1338
- };
1339
- };
862
+ ProjectMapNodeAllowedQueryString: {
863
+ /** @description The name of the query string parameter */
864
+ name: string;
865
+ /** @description The default value of the query string if it is not provided by an incoming route path */
866
+ value?: string;
867
+ /** @description Help text for authors who might be setting up a preview value for this query string */
868
+ helpText?: string;
1340
869
  };
1341
- operations: {};
1342
- };
1343
- "v1-project-map-tree.swagger.yml": {
1344
- paths: {};
1345
- components: {
1346
- schemas: {
1347
- ProjectMapTreeNodeDefinition: external$1["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
1348
- /** @description Children of the node */
1349
- children?: external$1["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
1350
- } & {
1351
- name: unknown;
1352
- };
1353
- };
870
+ ProjectMapNodeData: {
871
+ /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
872
+ isSearchHit?: boolean;
873
+ /** @description Query strings that are allowed to be passed to the node */
874
+ queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
875
+ /** @description For dynamic nodes, this is the preview value for the dynamic value.
876
+ * The preview value is used when editing a connected composition, and is the default
877
+ * dynamic node value unless the author has explicitly chosen a different value
878
+ * */
879
+ previewValue?: string;
1354
880
  };
1355
- operations: {};
1356
881
  };
882
+ responses: never;
883
+ parameters: never;
884
+ requestBodies: never;
885
+ headers: never;
886
+ pathItems: never;
1357
887
  }
1358
888
 
1359
- /**
1360
- * This file was auto-generated by openapi-typescript.
1361
- * Do not make direct changes to the file.
1362
- */
1363
889
  interface paths {
1364
890
  "/api/v1/assets": {
891
+ parameters: {
892
+ query?: never;
893
+ header?: never;
894
+ path?: never;
895
+ cookie?: never;
896
+ };
1365
897
  get: {
1366
898
  parameters: {
1367
899
  query: {
1368
- /** Specify a single asset ID to fetch */
900
+ /** @description Specify a single asset ID to fetch */
1369
901
  assetId?: components["parameters"]["assetId"];
1370
- /** Specify multiple asset IDs to fetch. Response type will be a list */
902
+ /** @description Specify multiple asset IDs to fetch. Response type will be a list */
1371
903
  assetIDs?: components["parameters"]["assetIDs"];
1372
- /** Filters asset lists by the user who created them. The user is specified by their identity subject */
904
+ /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
905
+ * */
1373
906
  createdBy?: components["parameters"]["createdBy"];
1374
- /**
1375
- * Matches assets where their name or description contains the specified keyword.
1376
- * This is a list query parameter, and cannot be used with any primary query parameters
1377
- */
907
+ /** @description Matches assets where their name or description contains the specified keyword.
908
+ * This is a list query parameter, and cannot be used with any primary query parameters
909
+ * */
1378
910
  keyword?: components["parameters"]["keyword"];
1379
- /** Max number of records to return */
911
+ /** @description Max number of records to return */
1380
912
  limit?: components["parameters"]["limit"];
1381
- /** Number of records to skip */
913
+ /** @description Number of records to skip */
1382
914
  offset?: components["parameters"]["offset"];
1383
- /** Sets the sorting of the results. If unspecified, results are sorted by name ascending */
915
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
916
+ * */
1384
917
  orderBy?: components["parameters"]["orderBy"];
1385
- /** The project the asset/assets are on */
918
+ /** @description The project the asset/assets are on */
1386
919
  projectId: components["parameters"]["projectId"];
1387
- /** The asset type ID to filter by */
920
+ /** @description The asset type ID to filter by */
1388
921
  type?: components["parameters"]["type"];
1389
- /** Filters asset lists by the user who last updated them. The user is specified by their identity subject */
922
+ /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
923
+ * */
1390
924
  updatedBy?: components["parameters"]["updatedBy"];
1391
- /**
1392
- * Controls whether the total count of results will be returned along with the current results page in a list.
1393
- * Has no effect when not fetching a list. This does impact performance when enabled
1394
- */
925
+ /** @description Controls whether the total count of results will be returned along with the current results page in a list.
926
+ * Has no effect when not fetching a list. This does impact performance when enabled
927
+ * */
1395
928
  withTotalCount?: components["parameters"]["withTotalCount"];
1396
- /**
1397
- * The ID of a release to fetch the content for.
929
+ /** @description The ID of a release to fetch the content for.
1398
930
  *
1399
- * - When unspecified, all release content is excluded from the result(s).
1400
- * - 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.
931
+ * - When unspecified, all release content is excluded from the result(s).
932
+ * - 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.
1401
933
  *
1402
- * 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
1403
- */
934
+ * 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
935
+ * */
1404
936
  releaseId?: components["parameters"]["releaseId"];
1405
937
  };
938
+ header?: never;
939
+ path?: never;
940
+ cookie?: never;
1406
941
  };
942
+ requestBody?: never;
1407
943
  responses: {
1408
- /** OK */
944
+ /** @description OK */
1409
945
  200: {
946
+ headers: {
947
+ [name: string]: unknown;
948
+ };
1410
949
  content: {
1411
950
  "application/json": components["schemas"]["AssetListResponse"] | components["schemas"]["AssetApiResponse"];
1412
951
  };
1413
952
  };
1414
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1415
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1416
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1417
- /** Asset not found */
953
+ 400: components["responses"]["BadRequestError"];
954
+ 401: components["responses"]["UnauthorizedError"];
955
+ 403: components["responses"]["ForbiddenError"];
956
+ /** @description Asset not found */
1418
957
  404: {
958
+ headers: {
959
+ [name: string]: unknown;
960
+ };
1419
961
  content: {
1420
962
  "application/json": {
1421
963
  /** @description The error message */
@@ -1423,20 +965,17 @@ interface paths {
1423
965
  };
1424
966
  };
1425
967
  };
1426
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1427
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
968
+ 429: components["responses"]["RateLimitError"];
969
+ 500: components["responses"]["InternalServerError"];
1428
970
  };
1429
971
  };
1430
- /** Upserts an asset */
972
+ /** @description Upserts an asset */
1431
973
  put: {
1432
- responses: {
1433
- /** OK */
1434
- 204: never;
1435
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1436
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1437
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1438
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1439
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
974
+ parameters: {
975
+ query?: never;
976
+ header?: never;
977
+ path?: never;
978
+ cookie?: never;
1440
979
  };
1441
980
  requestBody: {
1442
981
  content: {
@@ -1456,17 +995,29 @@ interface paths {
1456
995
  };
1457
996
  };
1458
997
  };
998
+ responses: {
999
+ /** @description OK */
1000
+ 204: {
1001
+ headers: {
1002
+ [name: string]: unknown;
1003
+ };
1004
+ content?: never;
1005
+ };
1006
+ 400: components["responses"]["BadRequestError"];
1007
+ 401: components["responses"]["UnauthorizedError"];
1008
+ 403: components["responses"]["ForbiddenError"];
1009
+ 429: components["responses"]["RateLimitError"];
1010
+ 500: components["responses"]["InternalServerError"];
1011
+ };
1459
1012
  };
1460
- /** Deletes or unpublishes an asset */
1013
+ post?: never;
1014
+ /** @description Deletes or unpublishes an asset */
1461
1015
  delete: {
1462
- responses: {
1463
- /** OK */
1464
- 204: never;
1465
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1466
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1467
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1468
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1469
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1016
+ parameters: {
1017
+ query?: never;
1018
+ header?: never;
1019
+ path?: never;
1020
+ cookie?: never;
1470
1021
  };
1471
1022
  requestBody: {
1472
1023
  content: {
@@ -1484,20 +1035,50 @@ interface paths {
1484
1035
  /**
1485
1036
  * Format: uuid
1486
1037
  * @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
1487
- * Note: deleting an asset from a release will not delete the asset from the base
1038
+ * Note: deleting an asset from a release will not delete the asset from the base
1039
+ *
1488
1040
  */
1489
1041
  releaseId?: string;
1490
1042
  };
1491
1043
  };
1492
1044
  };
1045
+ responses: {
1046
+ /** @description OK */
1047
+ 204: {
1048
+ headers: {
1049
+ [name: string]: unknown;
1050
+ };
1051
+ content?: never;
1052
+ };
1053
+ 400: components["responses"]["BadRequestError"];
1054
+ 401: components["responses"]["UnauthorizedError"];
1055
+ 403: components["responses"]["ForbiddenError"];
1056
+ 429: components["responses"]["RateLimitError"];
1057
+ 500: components["responses"]["InternalServerError"];
1058
+ };
1493
1059
  };
1494
- /** Handles preflight requests. This endpoint allows CORS */
1060
+ /** @description Handles preflight requests. This endpoint allows CORS */
1495
1061
  options: {
1062
+ parameters: {
1063
+ query?: never;
1064
+ header?: never;
1065
+ path?: never;
1066
+ cookie?: never;
1067
+ };
1068
+ requestBody?: never;
1496
1069
  responses: {
1497
- /** OK */
1498
- 204: never;
1070
+ /** @description OK */
1071
+ 204: {
1072
+ headers: {
1073
+ [name: string]: unknown;
1074
+ };
1075
+ content?: never;
1076
+ };
1499
1077
  };
1500
1078
  };
1079
+ head?: never;
1080
+ patch?: never;
1081
+ trace?: never;
1501
1082
  };
1502
1083
  }
1503
1084
  interface components {
@@ -1559,10 +1140,10 @@ interface components {
1559
1140
  };
1560
1141
  /** @description Asset field values */
1561
1142
  custom?: {
1562
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1143
+ [key: string]: components["schemas"]["ComponentParameter"];
1563
1144
  };
1564
1145
  };
1565
- _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1146
+ _dataResources?: components["schemas"]["DataResourceDefinitions"];
1566
1147
  };
1567
1148
  /** @description Defines the shape of the asset input */
1568
1149
  AssetInput: {
@@ -1593,7 +1174,7 @@ interface components {
1593
1174
  type: "file";
1594
1175
  };
1595
1176
  };
1596
- _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1177
+ _dataResources?: components["schemas"]["DataResourceDefinitions"];
1597
1178
  };
1598
1179
  AssetApiResponse: {
1599
1180
  /**
@@ -1623,6 +1204,191 @@ interface components {
1623
1204
  /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
1624
1205
  totalCount?: number;
1625
1206
  };
1207
+ /** @description Defines a connection to a dynamic token on a data resource
1208
+ * */
1209
+ DataElementConnectionDefinition: {
1210
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value */
1211
+ pointer: string;
1212
+ /**
1213
+ * @description The syntax used to select the dynamic token to bind to
1214
+ * @enum {string}
1215
+ */
1216
+ syntax: "jptr";
1217
+ /**
1218
+ * @description The action to take if the dynamic token cannot be resolved
1219
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
1220
+ * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
1221
+ * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
1222
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
1223
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
1224
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
1225
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
1226
+ * it is treated as an 'a' failure because removing the root means we must remove all
1227
+ * - 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
1228
+ *
1229
+ * @enum {string}
1230
+ */
1231
+ failureAction?: "t" | "p" | "c" | "a";
1232
+ /**
1233
+ * @description How to report when the dynamic token cannot be resolved
1234
+ * - e: ERROR: Report an error message (this will prevent publishing)
1235
+ * - w: WARNING: Report a warning message [default]
1236
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
1237
+ *
1238
+ * @enum {string}
1239
+ */
1240
+ failureLogLevel?: "e" | "w" | "i";
1241
+ /** @description The default value to use if the dynamic token cannot be resolved.
1242
+ * This is only used if the failureAction is the default (undefined, or explicitly token)
1243
+ * */
1244
+ failureDefault?: string;
1245
+ };
1246
+ /**
1247
+ * @deprecated
1248
+ * @description beta functionality subject to change
1249
+ */
1250
+ VisibilityCriteria: {
1251
+ /** @description The rule type to execute */
1252
+ rule: string;
1253
+ /** @description The source value of the rule.
1254
+ * For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
1255
+ * */
1256
+ source?: string;
1257
+ /** @description The rule-definition-specific operator to test against */
1258
+ op: string;
1259
+ /** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
1260
+ value: string | string[];
1261
+ };
1262
+ /**
1263
+ * @deprecated
1264
+ * @description beta functionality subject to change
1265
+ */
1266
+ VisibilityCriteriaGroup: {
1267
+ /**
1268
+ * @description The boolean operator to join the clauses with. Defaults to & if not specified.
1269
+ * @enum {string}
1270
+ */
1271
+ op?: "&" | "|";
1272
+ clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
1273
+ };
1274
+ /** @description Defines a conditional value for a component parameter
1275
+ * */
1276
+ ComponentParameterConditionalValue: {
1277
+ when: components["schemas"]["VisibilityCriteriaGroup"];
1278
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable.
1279
+ * A value of `null` will cause the parameter value to be removed, if it matches.
1280
+ * */
1281
+ value: unknown;
1282
+ /** @description Unique sequence identifier of the conditional value within the component parameter.
1283
+ * This value must be unique within the conditional values array, and it should not change after a condition is created.
1284
+ * */
1285
+ id: number;
1286
+ };
1287
+ /** @description Array of alternate values which are based on conditions.
1288
+ *
1289
+ * When requested with an explicit locale parameter, or via the route API:
1290
+ * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
1291
+ * * If no conditions match, the `value` property is used.
1292
+ * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
1293
+ *
1294
+ * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
1295
+ * */
1296
+ ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
1297
+ /** @description Defines an editable parameter on a component */
1298
+ ComponentParameter: {
1299
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable */
1300
+ value?: unknown;
1301
+ /** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
1302
+ type: string;
1303
+ /** @deprecated */
1304
+ connectedData?: components["schemas"]["DataElementConnectionDefinition"];
1305
+ /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1306
+ * Note that locales must be registered on the entry/composition `_locales` before being used
1307
+ * */
1308
+ locales?: {
1309
+ [key: string]: unknown;
1310
+ };
1311
+ conditions?: components["schemas"]["ComponentParameterConditions"];
1312
+ /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
1313
+ * */
1314
+ localesConditions?: {
1315
+ [key: string]: components["schemas"]["ComponentParameterConditions"];
1316
+ };
1317
+ };
1318
+ /** @description Variable values for a data resource */
1319
+ DataResourceVariables: {
1320
+ [key: string]: string;
1321
+ };
1322
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
1323
+ DataResourceDefinition: {
1324
+ /** @description Public ID of the data type that provides this data */
1325
+ type: string;
1326
+ /** @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 */
1327
+ isPatternParameter?: boolean;
1328
+ /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
1329
+ * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
1330
+ * If isPatternParameter is false or undefined, this has no meaning
1331
+ * */
1332
+ ignorePatternParameterDefault?: boolean;
1333
+ /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
1334
+ * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1335
+ * */
1336
+ optionalPatternParameter?: boolean;
1337
+ variables?: components["schemas"]["DataResourceVariables"];
1338
+ };
1339
+ /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
1340
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
1341
+ * */
1342
+ DataResourceDefinitions: {
1343
+ [key: string]: components["schemas"]["DataResourceDefinition"];
1344
+ };
1345
+ Error: {
1346
+ /** @description Error message(s) that occurred while processing the request */
1347
+ errorMessage?: string[] | string;
1348
+ };
1349
+ };
1350
+ responses: {
1351
+ /** @description Request input validation failed */
1352
+ BadRequestError: {
1353
+ headers: {
1354
+ [name: string]: unknown;
1355
+ };
1356
+ content: {
1357
+ "application/json": components["schemas"]["Error"];
1358
+ };
1359
+ };
1360
+ /** @description API key or token was not valid */
1361
+ UnauthorizedError: {
1362
+ headers: {
1363
+ [name: string]: unknown;
1364
+ };
1365
+ content: {
1366
+ "application/json": components["schemas"]["Error"];
1367
+ };
1368
+ };
1369
+ /** @description Permission was denied */
1370
+ ForbiddenError: {
1371
+ headers: {
1372
+ [name: string]: unknown;
1373
+ };
1374
+ content: {
1375
+ "application/json": components["schemas"]["Error"];
1376
+ };
1377
+ };
1378
+ /** @description Too many requests in allowed time period */
1379
+ RateLimitError: {
1380
+ headers: {
1381
+ [name: string]: unknown;
1382
+ };
1383
+ content?: never;
1384
+ };
1385
+ /** @description Execution error occurred */
1386
+ InternalServerError: {
1387
+ headers: {
1388
+ [name: string]: unknown;
1389
+ };
1390
+ content?: never;
1391
+ };
1626
1392
  };
1627
1393
  parameters: {
1628
1394
  /** @description The project the asset/assets are on */
@@ -1637,1391 +1403,35 @@ interface components {
1637
1403
  offset: number;
1638
1404
  /** @description Max number of records to return */
1639
1405
  limit: number;
1640
- /**
1641
- * @description Matches assets where their name or description contains the specified keyword.
1642
- * This is a list query parameter, and cannot be used with any primary query parameters
1643
- */
1406
+ /** @description Matches assets where their name or description contains the specified keyword.
1407
+ * This is a list query parameter, and cannot be used with any primary query parameters
1408
+ * */
1644
1409
  keyword: string;
1645
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending */
1410
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
1411
+ * */
1646
1412
  orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
1647
- /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
1413
+ /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
1414
+ * */
1648
1415
  createdBy: string;
1649
- /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
1416
+ /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
1417
+ * */
1650
1418
  updatedBy: string;
1651
- /**
1652
- * @description Controls whether the total count of results will be returned along with the current results page in a list.
1653
- * Has no effect when not fetching a list. This does impact performance when enabled
1654
- */
1419
+ /** @description Controls whether the total count of results will be returned along with the current results page in a list.
1420
+ * Has no effect when not fetching a list. This does impact performance when enabled
1421
+ * */
1655
1422
  withTotalCount: boolean;
1656
- /**
1657
- * @description The ID of a release to fetch the content for.
1423
+ /** @description The ID of a release to fetch the content for.
1658
1424
  *
1659
- * - When unspecified, all release content is excluded from the result(s).
1660
- * - 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.
1425
+ * - When unspecified, all release content is excluded from the result(s).
1426
+ * - 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.
1661
1427
  *
1662
- * 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
1663
- */
1428
+ * 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
1429
+ * */
1664
1430
  releaseId: string;
1665
1431
  };
1666
- }
1667
- interface external {
1668
- "swagger.yml": {
1669
- paths: {};
1670
- components: {
1671
- schemas: {
1672
- Error: {
1673
- /** @description Error message(s) that occurred while processing the request */
1674
- errorMessage?: string[] | string;
1675
- };
1676
- };
1677
- responses: {
1678
- /** Request input validation failed */
1679
- BadRequestError: {
1680
- content: {
1681
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1682
- };
1683
- };
1684
- /** API key or token was not valid */
1685
- UnauthorizedError: {
1686
- content: {
1687
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1688
- };
1689
- };
1690
- /** Permission was denied */
1691
- ForbiddenError: {
1692
- content: {
1693
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1694
- };
1695
- };
1696
- /** Resource not found */
1697
- NotFoundError: {
1698
- content: {
1699
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1700
- };
1701
- };
1702
- /** Too many requests in allowed time period */
1703
- RateLimitError: unknown;
1704
- /** Execution error occurred */
1705
- InternalServerError: unknown;
1706
- };
1707
- };
1708
- operations: {};
1709
- };
1710
- "uniform-canvas-types.swagger.yml": {
1711
- paths: {};
1712
- components: {
1713
- schemas: {
1714
- /** @description Public ID (used in code). Do not change after creation */
1715
- PublicIdProperty: string;
1716
- /** @description The definition of a component parameter */
1717
- ComponentDefinitionParameter: {
1718
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1719
- /** @description Friendly name of the parameter */
1720
- name: string;
1721
- /** @description Appears next to the parameter in the Composition editor */
1722
- helpText?: string;
1723
- /** @description Type name of the parameter (provided by a Uniform integration) */
1724
- type: string;
1725
- /**
1726
- * @description If true, this property can have locale-specific values. If false or not defined,
1727
- * this property will have a single value that is shared for all locales
1728
- */
1729
- localizable?: boolean;
1730
- /**
1731
- * @description When `localizable` is true, this property controls the default localizability of the property.
1732
- * true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
1733
- * false/undefined - when the property has no existing value, it will store separate values for each enabled locale
1734
- *
1735
- * If `localized` is false, this has no effect.
1736
- */
1737
- notLocalizedByDefault?: boolean;
1738
- /**
1739
- * @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
1740
- * When combined with a localized value, each locale has independent conditional values.
1741
- *
1742
- * When not defined, conditional values are not allowed.
1743
- */
1744
- allowConditionalValues?: boolean;
1745
- /** @description The configuration object for the type (type-specific) */
1746
- typeConfig?: unknown;
1747
- };
1748
- /** @description The definition of a named component slot that can contain other components */
1749
- ComponentDefinitionSlot: {
1750
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1751
- /** @description Friendly name of the slot */
1752
- name: string;
1753
- /** @description A list of component definition public IDs that are allowed in this named slot */
1754
- allowedComponents: string[];
1755
- /**
1756
- * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
1757
- * If `allowAllComponents` is true, this value is ignored
1758
- *
1759
- * @default false
1760
- */
1761
- inheritAllowedComponents: boolean;
1762
- /**
1763
- * @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.
1764
- * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
1765
- */
1766
- allowAllComponents?: boolean;
1767
- /**
1768
- * @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
1769
- * When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
1770
- */
1771
- patternsInAllowedComponents?: boolean;
1772
- /** @description Minimum valid number of components in this slot */
1773
- minComponents?: number;
1774
- /** @description Maximum valid number of components in this slot */
1775
- maxComponents?: number;
1776
- };
1777
- /** @description The definition of a composition's slug settings */
1778
- ComponentDefinitionSlugSettings: {
1779
- /**
1780
- * @description Whether the slug is required
1781
- * no: slug is optional
1782
- * yes: slug is required
1783
- * disabled: slug is disabled and will not be shown in the editor
1784
- *
1785
- * @default no
1786
- * @enum {string}
1787
- */
1788
- required?: "no" | "yes" | "disabled";
1789
- /**
1790
- * @description Slug uniqueness configuration.
1791
- * no = no unique constraint
1792
- * local = must be unique within this component type
1793
- * global = must be unique across all component types
1794
- *
1795
- * @enum {string}
1796
- */
1797
- unique?: "no" | "local" | "global";
1798
- /** @description Regular expression slugs must match */
1799
- regularExpression?: string;
1800
- /**
1801
- * @description Custom error message when regular expression validation fails.
1802
- * Has no effect if `regularExpression` is not set
1803
- */
1804
- regularExpressionMessage?: string;
1805
- };
1806
- /** @description The definition of a component variant */
1807
- ComponentDefinitionVariant: {
1808
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1809
- /** @description Friendly name of the variant */
1810
- name: string;
1811
- };
1812
- /** @description Permission set for a component definition */
1813
- ComponentDefinitionPermission: {
1814
- roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1815
- /**
1816
- * @description Permission type for this permission ComponentDefinition:
1817
- * read | write | create | delete
1818
- *
1819
- * @enum {string}
1820
- */
1821
- permission: "read" | "write" | "create" | "delete";
1822
- /** @description State of the component that this permission applies to */
1823
- state: number;
1824
- };
1825
- /** @description Defines a component type that can live on a Composition */
1826
- ComponentDefinition: {
1827
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1828
- /** @description Friendly name of the component definition */
1829
- name: string;
1830
- /**
1831
- * @description Icon name for the component definition (e.g. 'screen')
1832
- * @default screen
1833
- */
1834
- icon?: string;
1835
- /**
1836
- * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
1837
- * The parameter type must support being used as a title parameter for this to work
1838
- *
1839
- * @default null
1840
- */
1841
- titleParameter?: string | null;
1842
- /**
1843
- * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
1844
- *
1845
- * @default null
1846
- */
1847
- thumbnailParameter?: string | null;
1848
- /**
1849
- * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components
1850
- * @default false
1851
- */
1852
- canBeComposition?: boolean;
1853
- /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
1854
- parameters?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1855
- /**
1856
- * Format: uuid
1857
- * @description Reference to the category this component definition belongs to
1858
- * @default null
1859
- */
1860
- categoryId?: string | null;
1861
- /** @description Description of the component definition */
1862
- description?: string;
1863
- /** @description Description of the component definition */
1864
- previewImageUrl?: string;
1865
- /**
1866
- * @description if this component uses team permissions or custom permissions
1867
- * @default true
1868
- */
1869
- useTeamPermissions?: boolean;
1870
- /** @description Custom role permissions for this component definition */
1871
- permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1872
- /** @description The named slots for this component; placement areas where arrays of other components can be added */
1873
- slots?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1874
- slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1875
- /** @description Default component instance value */
1876
- defaults?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1877
- /** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
1878
- variants?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1879
- /** @description Created date string for this definition (ignored for writes) */
1880
- created?: string;
1881
- /** @description Last modified date string for this definition (ignored for writes) */
1882
- updated?: string;
1883
- /**
1884
- * Format: uuid
1885
- * @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached
1886
- */
1887
- workflowId?: string;
1888
- };
1889
- /** @description Defines a content type */
1890
- ContentType: {
1891
- id: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1892
- /** @description Friendly name of the content type */
1893
- name: string;
1894
- /**
1895
- * @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.
1896
- * The field type must support being used as an entry name for this to work
1897
- */
1898
- entryName?: string | null;
1899
- /**
1900
- * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
1901
- *
1902
- * @default null
1903
- */
1904
- thumbnailField?: string | null;
1905
- /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
1906
- fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1907
- /** @description Description of the content type */
1908
- description?: string;
1909
- /**
1910
- * @description Icon name for the content type (e.g. 'screen')
1911
- * @default file-document
1912
- */
1913
- icon?: string;
1914
- /** @description Created date string for this content type (ignored for writes) */
1915
- created?: string;
1916
- /** @description Last modified date string for this content type (ignored for writes) */
1917
- updated?: string;
1918
- slugSettings?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1919
- /**
1920
- * @description The definition type of this content type (block or content type)
1921
- * @default contentType
1922
- * @enum {string}
1923
- */
1924
- type?: "contentType" | "block";
1925
- /**
1926
- * @description if this content type uses team permissions or custom permissions
1927
- * @default true
1928
- */
1929
- useTeamPermissions?: boolean;
1930
- /** @description Custom role permissions for this content type */
1931
- permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1932
- /**
1933
- * Format: uuid
1934
- * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
1935
- */
1936
- workflowId?: string;
1937
- };
1938
- /** @description Defines an editable parameter on a component */
1939
- ComponentParameter: {
1940
- /** @description The value of the parameter. Any JSON-serializable value is acceptable */
1941
- value?: unknown;
1942
- /** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
1943
- type: string;
1944
- /** @deprecated */
1945
- connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1946
- /**
1947
- * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1948
- * Note that locales must be registered on the entry/composition `_locales` before being used
1949
- */
1950
- locales?: {
1951
- [key: string]: unknown;
1952
- };
1953
- conditions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
1954
- /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
1955
- localesConditions?: {
1956
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
1957
- };
1958
- };
1959
- /**
1960
- * @description Array of alternate values which are based on conditions.
1961
- *
1962
- * When requested with an explicit locale parameter, or via the route API:
1963
- * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
1964
- * * If no conditions match, the `value` property is used.
1965
- * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
1966
- *
1967
- * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
1968
- */
1969
- ComponentParameterConditions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
1970
- /** @description Defines a conditional value for a component parameter */
1971
- ComponentParameterConditionalValue: {
1972
- when: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
1973
- /**
1974
- * @description The value of the parameter. Any JSON-serializable value is acceptable.
1975
- * A value of `null` will cause the parameter value to be removed, if it matches.
1976
- */
1977
- value: unknown;
1978
- /**
1979
- * @description Unique sequence identifier of the conditional value within the component parameter.
1980
- * This value must be unique within the conditional values array, and it should not change after a condition is created.
1981
- */
1982
- id: number;
1983
- };
1984
- /**
1985
- * @deprecated
1986
- * @description beta functionality subject to change
1987
- */
1988
- VisibilityCriteriaGroup: {
1989
- /**
1990
- * @description The boolean operator to join the clauses with. Defaults to & if not specified.
1991
- * @enum {string}
1992
- */
1993
- op?: "&" | "|";
1994
- clauses: (external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
1995
- };
1996
- /**
1997
- * @deprecated
1998
- * @description beta functionality subject to change
1999
- */
2000
- VisibilityCriteria: {
2001
- /** @description The rule type to execute */
2002
- rule: string;
2003
- /**
2004
- * @description The source value of the rule.
2005
- * For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
2006
- */
2007
- source?: string;
2008
- /** @description The rule-definition-specific operator to test against */
2009
- op: string;
2010
- /** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
2011
- value: string | string[];
2012
- };
2013
- /** @description Defines a connection to a dynamic token on a data resource */
2014
- DataElementConnectionDefinition: {
2015
- /** @description A JSON Pointer expression that defines the data resource dynamic token value */
2016
- pointer: string;
2017
- /**
2018
- * @description The syntax used to select the dynamic token to bind to
2019
- * @enum {string}
2020
- */
2021
- syntax: "jptr";
2022
- /**
2023
- * @description The action to take if the dynamic token cannot be resolved
2024
- * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
2025
- * NOTE: If the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
2026
- * NOTE: If the _failureDefault_ property is also set, that default value will be used instead of removing the token.
2027
- * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored
2028
- * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
2029
- * - c: COMPONENT: Removes the whole parent component or block that contains the property.
2030
- * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
2031
- * it is treated as an 'a' failure because removing the root means we must remove all
2032
- * - 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
2033
- *
2034
- * @enum {string}
2035
- */
2036
- failureAction?: "t" | "p" | "c" | "a";
2037
- /**
2038
- * @description How to report when the dynamic token cannot be resolved
2039
- * - e: ERROR: Report an error message (this will prevent publishing)
2040
- * - w: WARNING: Report a warning message [default]
2041
- * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
2042
- *
2043
- * @enum {string}
2044
- */
2045
- failureLogLevel?: "e" | "w" | "i";
2046
- /**
2047
- * @description The default value to use if the dynamic token cannot be resolved.
2048
- * This is only used if the failureAction is the default (undefined, or explicitly token)
2049
- */
2050
- failureDefault?: string;
2051
- };
2052
- /** @description Defines the shape of a component instance served by the composition API */
2053
- ComponentInstance: {
2054
- /** @description Type of the component instance (public_id of its definition) */
2055
- type: string;
2056
- /** @description Component parameter values for the component instance */
2057
- parameters?: {
2058
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2059
- };
2060
- /** @description Public ID of alternate visual appearance for this component, if any selected */
2061
- variant?: string;
2062
- /** @description Slots containing any child components */
2063
- slots?: {
2064
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2065
- };
2066
- /**
2067
- * @description Unique identifier of the component within the composition.
2068
- * No assumptions should be made about the format of this value other than "it will be unique."
2069
- * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
2070
- * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
2071
- */
2072
- _id?: string;
2073
- /** @description Indicates this component instance should be sourced from a pattern library pattern */
2074
- _pattern?: string;
2075
- _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2076
- /**
2077
- * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2078
- * Means nothing for PUTs; it will be ignored
2079
- */
2080
- _patternDataResources?: {
2081
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2082
- };
2083
- _patternError?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PatternError"];
2084
- /**
2085
- * @description Defines patch overrides to component IDs that live in the composition.
2086
- * This can be used to override parameters that are defined on patterns,
2087
- * including nested patterns, with values that are specific to this composition.
2088
- * The keys in this object are component IDs.
2089
- * Overrides are applied from the top down, so for example if both the composition
2090
- * and a pattern on the composition define an override on a nested pattern,
2091
- * the composition's override replaces the pattern's.
2092
- *
2093
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2094
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2095
- */
2096
- _overrides?: {
2097
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2098
- };
2099
- /**
2100
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
2101
- * by consumers of the pattern.
2102
- *
2103
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2104
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2105
- */
2106
- _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2107
- /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
2108
- _locales?: string[];
2109
- };
2110
- /** @description Defines the shape of the root component in a composition */
2111
- RootComponentInstance: {
2112
- /** @description Type of the component instance (public_id of its definition) */
2113
- type: string;
2114
- /** @description Component parameter values for the component instance */
2115
- parameters?: {
2116
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2117
- };
2118
- /** @description Public ID of alternate visual appearance for this component, if any selected */
2119
- variant?: string;
2120
- /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
2121
- projectMapNodes?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
2122
- /** @description Slots containing any child components */
2123
- slots?: {
2124
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2125
- };
2126
- /** @description The ID of the composition */
2127
- _id: string;
2128
- /** @description Slug pattern of this component */
2129
- _slug?: string | null;
2130
- /** @description Friendly name of this component */
2131
- _name: string;
2132
- /** @description Name of the author of the most recent change */
2133
- _author?: string;
2134
- /** @description Identity subject of the author of the most recent change */
2135
- _authorSubject?: string;
2136
- /** @description Name of the original creator */
2137
- _creator?: string;
2138
- /** @description Identity subject of the original creator */
2139
- _creatorSubject?: string;
2140
- /** @description Indicates this component instance should be sourced from a pattern library pattern */
2141
- _pattern?: string;
2142
- /**
2143
- * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2144
- * Means nothing for PUTs; it will be ignored
2145
- */
2146
- _patternDataResources?: {
2147
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2148
- };
2149
- _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2150
- _patternError?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PatternError"];
2151
- /**
2152
- * @description Defines patch overrides to component IDs that live in the composition.
2153
- * This can be used to override parameters that are defined on patterns,
2154
- * including nested patterns, with values that are specific to this composition.
2155
- * The keys in this object are component IDs.
2156
- * Overrides are applied from the top down, so for example if both the composition
2157
- * and a pattern on the composition define an override on a nested pattern,
2158
- * the composition's override replaces the pattern's.
2159
- *
2160
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2161
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2162
- */
2163
- _overrides?: {
2164
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2165
- };
2166
- /**
2167
- * @description When used on a pattern, defines how the pattern's parameters may be overridden
2168
- * by consumers of the pattern.
2169
- *
2170
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2171
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2172
- */
2173
- _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2174
- /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
2175
- _locales?: string[];
2176
- };
2177
- /**
2178
- * @description Defines how to override a specific component.
2179
- *
2180
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2181
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2182
- */
2183
- ComponentOverride: {
2184
- parameters?: {
2185
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2186
- };
2187
- slots?: {
2188
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2189
- };
2190
- variant?: string;
2191
- };
2192
- /**
2193
- * @description Defines how a component on a pattern may have its values overridden.
2194
- * NOTE: Data resources' overridability is defined in the data resource definition, not here.
2195
- *
2196
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2197
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2198
- */
2199
- ComponentOverridability: {
2200
- /** @description Defines component parameter value overrides. Keys are the parameter public ID */
2201
- parameters?: {
2202
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2203
- };
2204
- /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
2205
- variants?: boolean;
2206
- /**
2207
- * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
2208
- * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
2209
- * If not set, the default is false
2210
- */
2211
- hideLockedParameters?: boolean;
2212
- };
2213
- /**
2214
- * @description Whether a parameter is overridable
2215
- *
2216
- * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2217
- * Future updates that do not break the overrides-applied state of a composition may be made without notice
2218
- *
2219
- * @enum {string}
2220
- */
2221
- OverrideOptions: "yes" | "no";
2222
- /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
2223
- AlternativeDataSourceData: {
2224
- /** @description Base resource URL of the data source. No trailing slash */
2225
- baseUrl: string;
2226
- /** @description HTTP headers to pass with requests to the data source */
2227
- headers?: {
2228
- key: string;
2229
- value: string;
2230
- omitIfEmpty?: boolean;
2231
- }[];
2232
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
2233
- parameters?: {
2234
- key: string;
2235
- value: string;
2236
- omitIfEmpty?: boolean;
2237
- }[];
2238
- /** @description Variables needed to make calls to the data source */
2239
- variables?: {
2240
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2241
- };
2242
- };
2243
- /**
2244
- * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
2245
- * These are created in the UI and shared across a whole project.
2246
- * NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
2247
- * for all header, parameter, and variable values to obscure the actual encrypted secret value
2248
- */
2249
- DataSource: {
2250
- /** @description Public ID of the data source */
2251
- id: string;
2252
- /** @description Display name of the data source */
2253
- displayName: string;
2254
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
2255
- connectorType: string;
2256
- /** @description Base resource URL of the data source. No trailing slash */
2257
- baseUrl: string;
2258
- /** @description HTTP headers to pass with requests to the data source */
2259
- headers?: {
2260
- key: string;
2261
- value: string;
2262
- }[];
2263
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
2264
- parameters?: {
2265
- key: string;
2266
- value: string;
2267
- }[];
2268
- /** @description Variables needed to make calls to the data source */
2269
- variables?: {
2270
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2271
- };
2272
- /**
2273
- * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
2274
- * If a locale is not mapped, it will be passed through to the data source as-is
2275
- */
2276
- localeMapping?: {
2277
- [key: string]: string;
2278
- };
2279
- /**
2280
- * @description If true, data source will require additional credentials to access unpublished data.
2281
- * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
2282
- */
2283
- enableUnpublishedMode?: boolean;
2284
- /** @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 */
2285
- customPublic?: {
2286
- [key: string]: unknown;
2287
- };
2288
- /** @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 */
2289
- custom?: {
2290
- [key: string]: unknown;
2291
- };
2292
- /** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
2293
- variants?: {
2294
- unpublished?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["AlternativeDataSourceData"];
2295
- };
2296
- };
2297
- /** @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 */
2298
- DataType: {
2299
- /** @description Public ID of the data type */
2300
- id: string;
2301
- /** @description Display name of the data type */
2302
- displayName: string;
2303
- /** @description Public ID of the associated data source */
2304
- dataSourceId: string;
2305
- /**
2306
- * @description A connector-specific archetype for this data type; used to select UI as well as perform any
2307
- * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
2308
- * no special UI or processing is required
2309
- */
2310
- archetype?: string;
2311
- allowedOnComponents?: string[];
2312
- /** @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 */
2313
- path: string;
2314
- /** @description Time-to-live (in seconds) for the resource data cache */
2315
- ttl?: number;
2316
- /** @description A key for the resource data cache purging */
2317
- purgeKey?: string;
2318
- /** @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 */
2319
- badgeIconUrl?: string;
2320
- /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
2321
- headers?: {
2322
- key: string;
2323
- value: string;
2324
- omitIfEmpty?: boolean;
2325
- }[];
2326
- /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
2327
- parameters?: {
2328
- key: string;
2329
- value: string;
2330
- omitIfEmpty?: boolean;
2331
- }[];
2332
- /** @description Body to pass with requests to the data type (ignored unless the method is POST) */
2333
- body?: string;
2334
- /**
2335
- * @description HTTP method to use with requests to the data type
2336
- * @default GET
2337
- * @enum {string}
2338
- */
2339
- method: "GET" | "POST" | "HEAD";
2340
- /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
2341
- variables?: {
2342
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2343
- };
2344
- /** @description Custom configuration specific to the data source being defined */
2345
- custom?: {
2346
- [key: string]: unknown;
2347
- };
2348
- };
2349
- /** @description Defines the shape of a data variable on a Data Source or Data Type */
2350
- DataVariableDefinition: {
2351
- /** @description Display name of the data variable */
2352
- displayName?: string;
2353
- /** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
2354
- helpText?: string;
2355
- /**
2356
- * @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
2357
- * @default text
2358
- */
2359
- type?: string;
2360
- /** @description Default value of the data variable */
2361
- default: string;
2362
- /** @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 */
2363
- order?: number;
2364
- /**
2365
- * @description An optional arbitrary human readable source identifier to describe where this variable is from.
2366
- * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
2367
- */
2368
- source?: string;
2369
- };
2370
- /**
2371
- * @description Data definitions attached to this component. The property name is the key of the data in the data document.
2372
- * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
2373
- */
2374
- DataResourceDefinitions: {
2375
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2376
- };
2377
- /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
2378
- DataResourceDefinition: {
2379
- /** @description Public ID of the data type that provides this data */
2380
- type: string;
2381
- /** @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 */
2382
- isPatternParameter?: boolean;
2383
- /**
2384
- * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
2385
- * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
2386
- * If isPatternParameter is false or undefined, this has no meaning
2387
- */
2388
- ignorePatternParameterDefault?: boolean;
2389
- /**
2390
- * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
2391
- * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
2392
- */
2393
- optionalPatternParameter?: boolean;
2394
- variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2395
- };
2396
- /** @description Variable values for a data resource */
2397
- DataResourceVariables: {
2398
- [key: string]: string;
2399
- };
2400
- /**
2401
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
2402
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
2403
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
2404
- * Means nothing for PUTs; it will be ignored
2405
- *
2406
- * @enum {string}
2407
- */
2408
- PatternError: "NOTFOUND" | "CYCLIC";
2409
- HistoryApiResponse: {
2410
- /**
2411
- * @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.
2412
- * If this is undefined then no more results are available
2413
- */
2414
- cursor?: string;
2415
- /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
2416
- truncated?: boolean;
2417
- /** @description Version history entries */
2418
- results?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
2419
- };
2420
- HistoryEntry: {
2421
- /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
2422
- versionId: string;
2423
- /** @description The timestamp when the version was created in epoch milliseconds */
2424
- timestamp: number;
2425
- /** @description The name (full name) of the user who created the version */
2426
- authorName: string;
2427
- authorIsApiKey: boolean;
2428
- /** @description The state of the entity when the history entry was made */
2429
- state: number;
2430
- };
2431
- /** @description Category for tagging canvas entities */
2432
- Category: {
2433
- /**
2434
- * Format: uuid
2435
- * @description Unique identifier for the category
2436
- */
2437
- id: string;
2438
- /** @description Display name of the category */
2439
- name: string;
2440
- /**
2441
- * @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
2442
- * @default 0
2443
- */
2444
- order?: number;
2445
- };
2446
- /** @description Project map node information related to a component */
2447
- CompositionProjectMapNodeInfo: {
2448
- /**
2449
- * Format: uuid
2450
- * @description Unique identifier for the project map node
2451
- */
2452
- id: string;
2453
- /**
2454
- * @description Fallback path of the project map node.
2455
- * Note that the node may have matched via a locale-specific path which is in the `locales` object
2456
- */
2457
- path: string;
2458
- /**
2459
- * Format: uuid
2460
- * @description Unique identifier for the project map that this node belongs to
2461
- */
2462
- projectMapId: string;
2463
- data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
2464
- /**
2465
- * @description Locale-specific paths of the project map node.
2466
- * Keys are locale codes
2467
- */
2468
- locales?: {
2469
- [key: string]: {
2470
- /** @description Locale-specific path of the project map node */
2471
- path: string;
2472
- /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
2473
- inherited: boolean;
2474
- };
2475
- };
2476
- };
2477
- /** @description AI Prompt definition */
2478
- Prompt: {
2479
- /**
2480
- * Format: uuid
2481
- * @description Unique identifier for the prompt
2482
- */
2483
- id: string;
2484
- /** @description Unique identifier for the integration that this prompt belongs to */
2485
- integrationType: string;
2486
- /** @description Name for the prompt */
2487
- name?: string | null;
2488
- /** @description Text for the prompt */
2489
- text?: string | null;
2490
- /** @description Data for the prompt */
2491
- data?: {
2492
- [key: string]: unknown;
2493
- } | null;
2494
- /** @description Turn off/on prompt */
2495
- enabled?: boolean | null;
2496
- /** @description Integration default prompt */
2497
- builtIn?: boolean | null;
2498
- /** @description Supported parameter types */
2499
- parameterTypes?: string[] | null;
2500
- };
2501
- /** @description Definition of a workflow that can be assigned to entities */
2502
- WorkflowDefinition: {
2503
- /**
2504
- * Format: uuid
2505
- * @description Unique identifier of the workflow definition
2506
- */
2507
- id: string;
2508
- /** @description Workflow name */
2509
- name: string;
2510
- /**
2511
- * Format: uuid
2512
- * @description The ID of the initial stage in the stages object.
2513
- */
2514
- initialStage: string;
2515
- /** @description All stages of the workflow */
2516
- stages: {
2517
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
2518
- };
2519
- /** @description Last modified ISO date string for this definition (ignored for writes) */
2520
- modified?: string;
2521
- /** @description Created ISO date string for this definition (ignored for writes) */
2522
- created?: string;
2523
- /**
2524
- * @description Name of the original creator of the workflow.
2525
- * If undefined, the user has been removed from the team.
2526
- * Ignored for writes
2527
- */
2528
- createdBy?: string;
2529
- /**
2530
- * @description Name of the last modifier of the workflow.
2531
- * If undefined, the user has been removed from the team.
2532
- * Ignored for writes
2533
- */
2534
- modifiedBy?: string;
2535
- };
2536
- /** @description Definition of a stage in a workflow */
2537
- WorkflowStage: {
2538
- /** @description Name of the stage */
2539
- name: string;
2540
- /**
2541
- * @description Defines roles which have permissions to this workflow stage
2542
- * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
2543
- * 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
2544
- * listed here, the stage is read-only and publishing is disabled
2545
- */
2546
- permissions: {
2547
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
2548
- };
2549
- /**
2550
- * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
2551
- * 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.
2552
- * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
2553
- * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
2554
- */
2555
- autoPublish?: boolean;
2556
- /**
2557
- * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
2558
- * If the entity is not valid, the transition will not be allowed.
2559
- * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
2560
- */
2561
- requireValidity?: boolean;
2562
- /**
2563
- * @description Defines transitions to other stages
2564
- * Every stage must define at least one transition, to avoid creating a workflow that
2565
- * has a stage that can never be escaped
2566
- */
2567
- transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
2568
- /**
2569
- * @description Icon name for the stage (e.g. 'chevron-double-right-o')
2570
- * @default chevron-double-right-o
2571
- */
2572
- icon?: string;
2573
- /** @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 */
2574
- order?: number;
2575
- };
2576
- /** @description Definition of a transition from one stage to another in a workflow */
2577
- WorkflowStageTransition: {
2578
- /**
2579
- * Format: uuid
2580
- * @description The target stage to transition to
2581
- */
2582
- to: string;
2583
- /**
2584
- * @description Name shown to the user when they execute this transition.
2585
- * If not provided, a default name will be assigned automatically based on the target stage
2586
- */
2587
- name: string;
2588
- /**
2589
- * @description Permissions for the stage transition.
2590
- * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
2591
- */
2592
- permissions: {
2593
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
2594
- };
2595
- };
2596
- /** @description Permissions for a workflow stage */
2597
- WorkflowStagePermission: {
2598
- /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
2599
- write?: boolean;
2600
- /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
2601
- publish?: boolean;
2602
- };
2603
- /** @description Permissions for a workflow stage transition */
2604
- WorkflowStageTransitionPermission: {
2605
- /** @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 */
2606
- execute?: boolean;
2607
- };
2608
- };
2609
- };
2610
- operations: {};
2611
- };
2612
- "v1-project-map-nodes.swagger.yml": {
2613
- paths: {
2614
- "/api/v1/project-map-nodes": {
2615
- /** Called to get a list of nodes belonging to a specific path or Id */
2616
- get: {
2617
- parameters: {
2618
- query: {
2619
- /** The project map id that the desired nodes belong */
2620
- projectMapId?: string;
2621
- /** The project id that contains the project map tree that this node belongs to */
2622
- projectId: string;
2623
- /**
2624
- * The ID of a release to fetch the composition data for.
2625
- *
2626
- * - When unspecified, composition data is fetched from base.
2627
- * - 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.
2628
- *
2629
- * 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
2630
- */
2631
- releaseId?: string;
2632
- /** The id of the node to retrieve, cannot have both this parameter and `path` */
2633
- id?: string;
2634
- /** The path of the root node to retrieve, cannot have both this parameter and `id` */
2635
- path?: string;
2636
- /** Composition id to find associated project map node for */
2637
- compositionId?: string;
2638
- /** Limit the number or records returned by a number */
2639
- limit?: number;
2640
- /** Number of records to skip before returning nodes */
2641
- offset?: number;
2642
- /** Depth of the tree to fetch. This only applies when fetching by path */
2643
- depth?: number;
2644
- /** State of compositions to fetch. 0 = draft, 64 = published */
2645
- state?: number;
2646
- /** should the data be returned as a json tree object (or a flat array) */
2647
- tree?: boolean;
2648
- /** text search filter */
2649
- search?: string;
2650
- /**
2651
- * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
2652
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
2653
- */
2654
- includeAncestors?: boolean;
2655
- /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
2656
- expanded?: boolean;
2657
- /** include basic composition information. ID, type, state, name, and definition id */
2658
- withCompositionData?: boolean;
2659
- /**
2660
- * @deprecated Returns the UI status string of the composition.
2661
- * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
2662
- */
2663
- withCompositionUIStatus?: boolean;
2664
- /** Include basic redirect information */
2665
- withRedirectData?: boolean;
2666
- };
2667
- };
2668
- responses: {
2669
- /** OK */
2670
- 200: {
2671
- content: {
2672
- "application/json": {
2673
- nodes?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
2674
- tree?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
2675
- };
2676
- };
2677
- };
2678
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
2679
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2680
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2681
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
2682
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
2683
- };
2684
- };
2685
- /** Called to insert or update a node or nodes */
2686
- put: {
2687
- responses: {
2688
- /** OK */
2689
- 204: never;
2690
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
2691
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2692
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2693
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
2694
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
2695
- };
2696
- requestBody: {
2697
- content: {
2698
- "application/json": {
2699
- /** @description An array of projectMap node objects to be updated or inserted */
2700
- nodes: {
2701
- node: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
2702
- /** @description The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
2703
- previousSibling?: string;
2704
- /** @description The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
2705
- nextSibling?: string;
2706
- }[];
2707
- /**
2708
- * Format: uuid
2709
- * @description The project id of the project that the projectMap belongs to
2710
- */
2711
- projectId: string;
2712
- /**
2713
- * Format: uuid
2714
- * @description The projectMap id that the changing or inserting nodes belong to
2715
- */
2716
- projectMapId?: string;
2717
- };
2718
- };
2719
- };
2720
- };
2721
- /** Called to delete a particular projectMap node by id or path */
2722
- delete: {
2723
- responses: {
2724
- /** OK */
2725
- 204: never;
2726
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
2727
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2728
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2729
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
2730
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
2731
- };
2732
- requestBody: {
2733
- content: {
2734
- "application/json": {
2735
- /**
2736
- * Format: uuid
2737
- * @description Id of the projectMap node to delete
2738
- */
2739
- nodeId?: string;
2740
- /** @description Path to the projectMap node to delete */
2741
- path: string;
2742
- /**
2743
- * Format: uuid
2744
- * @description Project map id that the node to delete belongs to
2745
- */
2746
- projectMapId?: string;
2747
- /**
2748
- * Format: uuid
2749
- * @description Project id that the project map belongs to
2750
- */
2751
- projectId: string;
2752
- } | {
2753
- /**
2754
- * Format: uuid
2755
- * @description Id of the projectMap node to delete
2756
- */
2757
- nodeId: string;
2758
- /** @description Path to the projectMap node to delete */
2759
- path?: string;
2760
- /**
2761
- * Format: uuid
2762
- * @description Project map id that the node to delete belongs to
2763
- */
2764
- projectMapId?: string;
2765
- /**
2766
- * Format: uuid
2767
- * @description Project id that the project map belongs to
2768
- */
2769
- projectId: string;
2770
- };
2771
- };
2772
- };
2773
- };
2774
- /** Handles preflight requests. This endpoint allows CORS */
2775
- options: {
2776
- responses: {
2777
- /** OK */
2778
- 204: never;
2779
- };
2780
- };
2781
- };
2782
- };
2783
- components: {
2784
- schemas: {
2785
- ProjectMapNodeDefinition: {
2786
- /**
2787
- * Format: uuid
2788
- * @description The id of the projectMap entry
2789
- */
2790
- id: string;
2791
- /** @description Path representing the path to the current node */
2792
- path: string;
2793
- /** @description Ordering of the node, higher numbers go after lower numbers */
2794
- order?: number;
2795
- data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
2796
- /** @description The name of the projectMap entry */
2797
- name: string;
2798
- /**
2799
- * @description The type of the projectMap entry
2800
- * @enum {string}
2801
- */
2802
- type: "composition" | "placeholder";
2803
- /**
2804
- * Format: uuid
2805
- * @description The composition id related to the projectMap entry
2806
- */
2807
- compositionId?: string;
2808
- /** @description Description of the projectMap node */
2809
- description?: string;
2810
- /** @description Parent path of the current node, only included if requested with the expanded flag */
2811
- parentPath?: string;
2812
- /** @description Last segment of the url */
2813
- pathSegment?: string;
2814
- /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
2815
- isLeaf?: boolean;
2816
- compositionData?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
2817
- sourceRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
2818
- targetRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
2819
- locales?: {
2820
- [key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
2821
- };
2822
- };
2823
- ProjectMapNodeLocale: {
2824
- /** @description Name of node in the locale */
2825
- name?: string;
2826
- /** @description Full path to the current node in this locale, only included if requested with the expanded flag */
2827
- path?: string;
2828
- /** @description Last segment of the url in this locale */
2829
- pathSegment: string;
2830
- /**
2831
- * @description When false, the node explicitly defines a locale-specific path segment.
2832
- *
2833
- * When true, an ancestor defines a locale-specific path segment,
2834
- * which makes its descendants resolvable using that segment.
2835
- * This node does not define a locale-specific path segment.
2836
- *
2837
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
2838
- */
2839
- inherited?: boolean;
2840
- };
2841
- ProjectMapSourceRedirectData: {
2842
- /**
2843
- * Format: uuid
2844
- * @description The public UUID of the source redirect
2845
- */
2846
- id?: string;
2847
- }[];
2848
- ProjectMapTargetRedirectData: {
2849
- /**
2850
- * Format: uuid
2851
- * @description The public UUID of the target redirect
2852
- */
2853
- id?: string;
2854
- }[];
2855
- /**
2856
- * @description Basic information about the linked composition from the context of a project map node.
2857
- * If the linked composition has editions, the editions are included in the `editions` property.
2858
- */
2859
- ProjectMapNodeCompositionData: {
2860
- /** @description Type of the linked composition (id of its definition) */
2861
- type: string;
2862
- /**
2863
- * Format: uuid
2864
- * @description The UUID of the linked composition
2865
- */
2866
- id: string;
2867
- /**
2868
- * Format: uuid
2869
- * @description The edition UUID underneath the linked composition
2870
- * This is only present if the composition has not been published, but an edition has
2871
- */
2872
- editionId?: string;
2873
- /** @description Slug pattern of the linked composition or edition */
2874
- slug?: string | null;
2875
- /** @description Friendly name of this composition or edition */
2876
- name: string;
2877
- /**
2878
- * @deprecated
2879
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
2880
- * @enum {string}
2881
- */
2882
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
2883
- /**
2884
- * @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
2885
- * @default screen
2886
- */
2887
- icon?: string;
2888
- /** @description Friendly name of this Composition's Definition */
2889
- typeName?: string;
2890
- /**
2891
- * @description List of locales that the composition _or any of its editions_ is available in.
2892
- * If empty, available in all locales.
2893
- */
2894
- locales: string[];
2895
- /** @description Priority of the composition relative to any editions */
2896
- editionPriority?: number;
2897
- /** @description Friendly name of the edition */
2898
- editionName?: string;
2899
- /**
2900
- * @deprecated
2901
- * @description List of editions available for this composition. The composition is included in the list, it is the edition
2902
- * where the editionID equals the node's compositionID.
2903
- */
2904
- editions?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionEditionData"][];
2905
- };
2906
- /**
2907
- * @deprecated
2908
- * @description Basic information about a composition edition from the context of a project map node
2909
- */
2910
- ProjectMapNodeCompositionEditionData: {
2911
- /**
2912
- * Format: uuid
2913
- * @description The UUID of the linked composition
2914
- */
2915
- id: string;
2916
- /** @description Type of the edition instance (public_id of its definition) */
2917
- type: string;
2918
- /**
2919
- * Format: uuid
2920
- * @description The edition UUID underneath the linked composition
2921
- */
2922
- editionId?: string;
2923
- /** @description Slug pattern of this edition */
2924
- slug?: string | null;
2925
- /** @description Friendly name of the linked composition */
2926
- name: string;
2927
- /** @description Friendly name of the edition */
2928
- editionName?: string;
2929
- /** @description Priority of the edition */
2930
- editionPriority?: number;
2931
- /**
2932
- * @deprecated
2933
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
2934
- * @enum {string}
2935
- */
2936
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
2937
- /**
2938
- * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
2939
- * @default screen
2940
- */
2941
- icon?: string;
2942
- /** @description Friendly name of this edition's definition */
2943
- typeName?: string;
2944
- /** @description List of locales that the edition is available in. If empty, available in all locales */
2945
- locales: string[];
2946
- /**
2947
- * Format: date-time
2948
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
2949
- */
2950
- modified?: string;
2951
- };
2952
- ProjectMapNodeUpdate: {
2953
- /**
2954
- * Format: uuid
2955
- * @description The id of the projectMap entry
2956
- */
2957
- id?: string;
2958
- /** @description Path representing the path to the current node */
2959
- path: string;
2960
- /** @description Ordering of the node, higher numbers go after lower numbers */
2961
- order?: number;
2962
- data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
2963
- /** @description The name of the projectMap entry */
2964
- name: string;
2965
- /**
2966
- * @description The type of the projectMap entry
2967
- * @enum {string}
2968
- */
2969
- type: "composition" | "placeholder";
2970
- /**
2971
- * Format: uuid
2972
- * @description The composition id related to the projectMap entry
2973
- */
2974
- compositionId?: string;
2975
- /** @description Description of the projectMap node */
2976
- description?: string;
2977
- locales?: {
2978
- [key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
2979
- };
2980
- };
2981
- ProjectMapNodeLocaleUpdate: {
2982
- /** @description Name of node in the locale */
2983
- name?: string;
2984
- /** @description Locale specific path segment for this node (not a full path) */
2985
- pathSegment: string;
2986
- };
2987
- ProjectMapNodeData: {
2988
- /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
2989
- isSearchHit?: boolean;
2990
- /** @description Query strings that are allowed to be passed to the node */
2991
- queryStrings?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
2992
- /**
2993
- * @description For dynamic nodes, this is the preview value for the dynamic value.
2994
- * The preview value is used when editing a connected composition, and is the default
2995
- * dynamic node value unless the author has explicitly chosen a different value
2996
- */
2997
- previewValue?: string;
2998
- };
2999
- ProjectMapNodeAllowedQueryString: {
3000
- /** @description The name of the query string parameter */
3001
- name: string;
3002
- /** @description The default value of the query string if it is not provided by an incoming route path */
3003
- value?: string;
3004
- /** @description Help text for authors who might be setting up a preview value for this query string */
3005
- helpText?: string;
3006
- };
3007
- };
3008
- };
3009
- operations: {};
3010
- };
3011
- "v1-project-map-tree.swagger.yml": {
3012
- paths: {};
3013
- components: {
3014
- schemas: {
3015
- ProjectMapTreeNodeDefinition: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
3016
- /** @description Children of the node */
3017
- children?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
3018
- } & {
3019
- name: unknown;
3020
- };
3021
- };
3022
- };
3023
- operations: {};
3024
- };
1432
+ requestBodies: never;
1433
+ headers: never;
1434
+ pathItems: never;
3025
1435
  }
3026
1436
 
3027
1437
  type AssetUpsertRequest = paths['/api/v1/assets']['put']['requestBody']['content']['application/json'];