@uniformdev/canvas 20.81.1-alpha.42.sha-7be2128ed3 → 20.81.1-alpha.48.sha-cbf88ea400
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +751 -707
- package/dist/index.d.ts +751 -707
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +7 -6
package/dist/index.d.mts
CHANGED
|
@@ -2,7 +2,6 @@ import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@unifor
|
|
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
|
3
3
|
import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
4
4
|
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
5
|
-
import { EndpointOut, EndpointHeadersOut, EndpointTransformationOut } from 'svix';
|
|
6
5
|
import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
|
|
7
6
|
import { Options as Options$1 } from 'p-retry';
|
|
8
7
|
import { Options } from 'p-throttle';
|
|
@@ -2218,6 +2217,8 @@ interface components$p {
|
|
|
2218
2217
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
2219
2218
|
*/
|
|
2220
2219
|
deletedAt?: string;
|
|
2220
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
2221
|
+
publishedWhenTrashed?: boolean;
|
|
2221
2222
|
/**
|
|
2222
2223
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
2223
2224
|
* @defaultValue false
|
|
@@ -4161,6 +4162,8 @@ interface components$n {
|
|
|
4161
4162
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
4162
4163
|
*/
|
|
4163
4164
|
deletedAt?: string;
|
|
4165
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
4166
|
+
publishedWhenTrashed?: boolean;
|
|
4164
4167
|
/**
|
|
4165
4168
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
4166
4169
|
* @defaultValue false
|
|
@@ -6099,301 +6102,17 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
6099
6102
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
6100
6103
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
6101
6104
|
|
|
6102
|
-
interface paths$d {
|
|
6103
|
-
"/api/v1/views": {
|
|
6104
|
-
parameters: {
|
|
6105
|
-
query?: never;
|
|
6106
|
-
header?: never;
|
|
6107
|
-
path?: never;
|
|
6108
|
-
cookie?: never;
|
|
6109
|
-
};
|
|
6110
|
-
/** Lists saved views for a project + resource type. */
|
|
6111
|
-
get: {
|
|
6112
|
-
parameters: {
|
|
6113
|
-
query: {
|
|
6114
|
-
/** Project the views belong to. */
|
|
6115
|
-
projectId: string;
|
|
6116
|
-
/** Resource type these views apply to (e.g. "entry"). */
|
|
6117
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6118
|
-
/** Number of records to skip. */
|
|
6119
|
-
offset?: number | null;
|
|
6120
|
-
/** Maximum number of records to return. */
|
|
6121
|
-
limit?: number;
|
|
6122
|
-
};
|
|
6123
|
-
header?: never;
|
|
6124
|
-
path?: never;
|
|
6125
|
-
cookie?: never;
|
|
6126
|
-
};
|
|
6127
|
-
requestBody?: never;
|
|
6128
|
-
responses: {
|
|
6129
|
-
/** OK */
|
|
6130
|
-
200: {
|
|
6131
|
-
headers: {
|
|
6132
|
-
[name: string]: unknown;
|
|
6133
|
-
};
|
|
6134
|
-
content: {
|
|
6135
|
-
"application/json": {
|
|
6136
|
-
views: {
|
|
6137
|
-
name: string;
|
|
6138
|
-
description?: string;
|
|
6139
|
-
searchTerm?: string;
|
|
6140
|
-
filters: {
|
|
6141
|
-
field: string;
|
|
6142
|
-
dynamicField?: string;
|
|
6143
|
-
operator: string;
|
|
6144
|
-
value: string | string[];
|
|
6145
|
-
}[];
|
|
6146
|
-
sort?: string[];
|
|
6147
|
-
shared: boolean;
|
|
6148
|
-
icon?: string;
|
|
6149
|
-
id: string;
|
|
6150
|
-
projectId: string;
|
|
6151
|
-
/** @enum {string} */
|
|
6152
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6153
|
-
createdBy: string | null;
|
|
6154
|
-
/** Format: date-time */
|
|
6155
|
-
created: string;
|
|
6156
|
-
/** Format: date-time */
|
|
6157
|
-
modified: string;
|
|
6158
|
-
}[];
|
|
6159
|
-
totalCount: number;
|
|
6160
|
-
};
|
|
6161
|
-
};
|
|
6162
|
-
};
|
|
6163
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6164
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6165
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6166
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6167
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6168
|
-
};
|
|
6169
|
-
};
|
|
6170
|
-
/** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `projectId` and `resourceType` are immutable after create. */
|
|
6171
|
-
put: {
|
|
6172
|
-
parameters: {
|
|
6173
|
-
query?: never;
|
|
6174
|
-
header?: never;
|
|
6175
|
-
path?: never;
|
|
6176
|
-
cookie?: never;
|
|
6177
|
-
};
|
|
6178
|
-
requestBody: {
|
|
6179
|
-
content: {
|
|
6180
|
-
"application/json": {
|
|
6181
|
-
name: string;
|
|
6182
|
-
description?: string;
|
|
6183
|
-
searchTerm?: string;
|
|
6184
|
-
filters: {
|
|
6185
|
-
field: string;
|
|
6186
|
-
dynamicField?: string;
|
|
6187
|
-
operator: string;
|
|
6188
|
-
value: string | string[];
|
|
6189
|
-
}[];
|
|
6190
|
-
sort?: string[];
|
|
6191
|
-
shared: boolean;
|
|
6192
|
-
icon?: string;
|
|
6193
|
-
id: string;
|
|
6194
|
-
projectId: string;
|
|
6195
|
-
/** @enum {string} */
|
|
6196
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6197
|
-
};
|
|
6198
|
-
};
|
|
6199
|
-
};
|
|
6200
|
-
responses: {
|
|
6201
|
-
/** OK */
|
|
6202
|
-
200: {
|
|
6203
|
-
headers: {
|
|
6204
|
-
[name: string]: unknown;
|
|
6205
|
-
};
|
|
6206
|
-
content: {
|
|
6207
|
-
"application/json": {
|
|
6208
|
-
name: string;
|
|
6209
|
-
description?: string;
|
|
6210
|
-
searchTerm?: string;
|
|
6211
|
-
filters: {
|
|
6212
|
-
field: string;
|
|
6213
|
-
dynamicField?: string;
|
|
6214
|
-
operator: string;
|
|
6215
|
-
value: string | string[];
|
|
6216
|
-
}[];
|
|
6217
|
-
sort?: string[];
|
|
6218
|
-
shared: boolean;
|
|
6219
|
-
icon?: string;
|
|
6220
|
-
id: string;
|
|
6221
|
-
projectId: string;
|
|
6222
|
-
/** @enum {string} */
|
|
6223
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6224
|
-
createdBy: string | null;
|
|
6225
|
-
/** Format: date-time */
|
|
6226
|
-
created: string;
|
|
6227
|
-
/** Format: date-time */
|
|
6228
|
-
modified: string;
|
|
6229
|
-
};
|
|
6230
|
-
};
|
|
6231
|
-
};
|
|
6232
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6233
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6234
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6235
|
-
/** View not found (or belongs to another project). */
|
|
6236
|
-
404: {
|
|
6237
|
-
headers: {
|
|
6238
|
-
[name: string]: unknown;
|
|
6239
|
-
};
|
|
6240
|
-
content?: never;
|
|
6241
|
-
};
|
|
6242
|
-
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
6243
|
-
409: {
|
|
6244
|
-
headers: {
|
|
6245
|
-
[name: string]: unknown;
|
|
6246
|
-
};
|
|
6247
|
-
content?: never;
|
|
6248
|
-
};
|
|
6249
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6250
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6251
|
-
};
|
|
6252
|
-
};
|
|
6253
|
-
post?: never;
|
|
6254
|
-
/** Deletes a saved view by id. */
|
|
6255
|
-
delete: {
|
|
6256
|
-
parameters: {
|
|
6257
|
-
query?: never;
|
|
6258
|
-
header?: never;
|
|
6259
|
-
path?: never;
|
|
6260
|
-
cookie?: never;
|
|
6261
|
-
};
|
|
6262
|
-
requestBody: {
|
|
6263
|
-
content: {
|
|
6264
|
-
"application/json": {
|
|
6265
|
-
id: string;
|
|
6266
|
-
projectId: string;
|
|
6267
|
-
};
|
|
6268
|
-
};
|
|
6269
|
-
};
|
|
6270
|
-
responses: {
|
|
6271
|
-
/** No Content */
|
|
6272
|
-
204: {
|
|
6273
|
-
headers: {
|
|
6274
|
-
[name: string]: unknown;
|
|
6275
|
-
};
|
|
6276
|
-
content: {
|
|
6277
|
-
"application/json": string;
|
|
6278
|
-
};
|
|
6279
|
-
};
|
|
6280
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6281
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6282
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6283
|
-
/** View not found. */
|
|
6284
|
-
404: {
|
|
6285
|
-
headers: {
|
|
6286
|
-
[name: string]: unknown;
|
|
6287
|
-
};
|
|
6288
|
-
content?: never;
|
|
6289
|
-
};
|
|
6290
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6291
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6292
|
-
};
|
|
6293
|
-
};
|
|
6294
|
-
/** Handles preflight requests. This endpoint allows CORS. */
|
|
6295
|
-
options: {
|
|
6296
|
-
parameters: {
|
|
6297
|
-
query?: never;
|
|
6298
|
-
header?: never;
|
|
6299
|
-
path?: never;
|
|
6300
|
-
cookie?: never;
|
|
6301
|
-
};
|
|
6302
|
-
requestBody?: never;
|
|
6303
|
-
responses: {
|
|
6304
|
-
/** ok */
|
|
6305
|
-
204: {
|
|
6306
|
-
headers: {
|
|
6307
|
-
[name: string]: unknown;
|
|
6308
|
-
};
|
|
6309
|
-
content?: never;
|
|
6310
|
-
};
|
|
6311
|
-
};
|
|
6312
|
-
};
|
|
6313
|
-
head?: never;
|
|
6314
|
-
patch?: never;
|
|
6315
|
-
trace?: never;
|
|
6316
|
-
};
|
|
6317
|
-
}
|
|
6318
6105
|
interface components$f {
|
|
6319
6106
|
schemas: {
|
|
6320
|
-
|
|
6321
|
-
/** Error message(s) that occurred while processing the request */
|
|
6322
|
-
errorMessage?: string[] | string;
|
|
6323
|
-
};
|
|
6324
|
-
};
|
|
6325
|
-
responses: {
|
|
6326
|
-
/** Request input validation failed */
|
|
6327
|
-
BadRequestError: {
|
|
6328
|
-
headers: {
|
|
6329
|
-
[name: string]: unknown;
|
|
6330
|
-
};
|
|
6331
|
-
content: {
|
|
6332
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6333
|
-
};
|
|
6334
|
-
};
|
|
6335
|
-
/** API key or token was not valid */
|
|
6336
|
-
UnauthorizedError: {
|
|
6337
|
-
headers: {
|
|
6338
|
-
[name: string]: unknown;
|
|
6339
|
-
};
|
|
6340
|
-
content: {
|
|
6341
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6342
|
-
};
|
|
6343
|
-
};
|
|
6344
|
-
/** Permission was denied */
|
|
6345
|
-
ForbiddenError: {
|
|
6346
|
-
headers: {
|
|
6347
|
-
[name: string]: unknown;
|
|
6348
|
-
};
|
|
6349
|
-
content: {
|
|
6350
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6351
|
-
};
|
|
6352
|
-
};
|
|
6353
|
-
/** Too many requests in allowed time period */
|
|
6354
|
-
RateLimitError: {
|
|
6355
|
-
headers: {
|
|
6356
|
-
[name: string]: unknown;
|
|
6357
|
-
};
|
|
6358
|
-
content?: never;
|
|
6359
|
-
};
|
|
6360
|
-
/** Execution error occurred */
|
|
6361
|
-
InternalServerError: {
|
|
6362
|
-
headers: {
|
|
6363
|
-
[name: string]: unknown;
|
|
6364
|
-
};
|
|
6365
|
-
content?: never;
|
|
6366
|
-
};
|
|
6367
|
-
};
|
|
6368
|
-
parameters: never;
|
|
6369
|
-
requestBodies: never;
|
|
6370
|
-
headers: never;
|
|
6371
|
-
pathItems: never;
|
|
6372
|
-
}
|
|
6373
|
-
|
|
6374
|
-
type ViewsApi = paths$d['/api/v1/views'];
|
|
6375
|
-
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
6376
|
-
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
6377
|
-
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
6378
|
-
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
6379
|
-
type View = ViewsResponse['views'][number];
|
|
6380
|
-
/**
|
|
6381
|
-
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
6382
|
-
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
6383
|
-
*/
|
|
6384
|
-
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
6385
|
-
|
|
6386
|
-
interface components$e {
|
|
6387
|
-
schemas: {
|
|
6388
|
-
RouteResponse: components$e["schemas"]["RouteResponseRedirect"] | components$e["schemas"]["RouteResponseComposition"] | components$e["schemas"]["RouteResponseNotFound"];
|
|
6107
|
+
RouteResponse: components$f["schemas"]["RouteResponseRedirect"] | components$f["schemas"]["RouteResponseComposition"] | components$f["schemas"]["RouteResponseNotFound"];
|
|
6389
6108
|
/** The route matches a redirection configured in Uniform */
|
|
6390
6109
|
RouteResponseRedirect: {
|
|
6391
6110
|
/** The route that was matched in the redirects */
|
|
6392
6111
|
matchedRoute: string;
|
|
6393
|
-
dynamicInputs?: components$
|
|
6112
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6394
6113
|
/** @enum {string} */
|
|
6395
6114
|
type: "redirect";
|
|
6396
|
-
redirect: components$
|
|
6115
|
+
redirect: components$f["schemas"]["Redirect"];
|
|
6397
6116
|
};
|
|
6398
6117
|
/**
|
|
6399
6118
|
* The route matches a composition.
|
|
@@ -6402,7 +6121,7 @@ interface components$e {
|
|
|
6402
6121
|
RouteResponseComposition: {
|
|
6403
6122
|
/** The route that was matched in the project map */
|
|
6404
6123
|
matchedRoute: string;
|
|
6405
|
-
dynamicInputs?: components$
|
|
6124
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6406
6125
|
/**
|
|
6407
6126
|
* Indicates the data variant that was fetched for data resources.
|
|
6408
6127
|
* undefined: Data resources were resolved using published data from their data source
|
|
@@ -6412,7 +6131,7 @@ interface components$e {
|
|
|
6412
6131
|
dataResourcesVariant?: "unpublished";
|
|
6413
6132
|
/** @enum {string} */
|
|
6414
6133
|
type: "composition";
|
|
6415
|
-
compositionApiResponse: components$
|
|
6134
|
+
compositionApiResponse: components$f["schemas"]["CompositionApiResponse"];
|
|
6416
6135
|
};
|
|
6417
6136
|
/**
|
|
6418
6137
|
* The route does not match any configured redirections or compositions.
|
|
@@ -6530,11 +6249,11 @@ interface components$e {
|
|
|
6530
6249
|
|
|
6531
6250
|
*/
|
|
6532
6251
|
op?: "&" | "|";
|
|
6533
|
-
clauses: (components$
|
|
6252
|
+
clauses: (components$f["schemas"]["VisibilityCriteria"] | components$f["schemas"]["VisibilityCriteriaGroup"])[];
|
|
6534
6253
|
};
|
|
6535
6254
|
/** Defines a conditional value for a component parameter */
|
|
6536
6255
|
ComponentParameterConditionalValue: {
|
|
6537
|
-
when: components$
|
|
6256
|
+
when: components$f["schemas"]["VisibilityCriteriaGroup"];
|
|
6538
6257
|
/**
|
|
6539
6258
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
6540
6259
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -6556,7 +6275,7 @@ interface components$e {
|
|
|
6556
6275
|
*
|
|
6557
6276
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
6558
6277
|
*/
|
|
6559
|
-
ComponentParameterConditions: components$
|
|
6278
|
+
ComponentParameterConditions: components$f["schemas"]["ComponentParameterConditionalValue"][];
|
|
6560
6279
|
/** Defines an editable parameter on a component */
|
|
6561
6280
|
ComponentParameter: {
|
|
6562
6281
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -6564,7 +6283,7 @@ interface components$e {
|
|
|
6564
6283
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
6565
6284
|
type: string;
|
|
6566
6285
|
/** @deprecated */
|
|
6567
|
-
connectedData?: components$
|
|
6286
|
+
connectedData?: components$f["schemas"]["DataElementConnectionDefinition"];
|
|
6568
6287
|
/**
|
|
6569
6288
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
6570
6289
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -6572,10 +6291,10 @@ interface components$e {
|
|
|
6572
6291
|
locales?: {
|
|
6573
6292
|
[key: string]: unknown;
|
|
6574
6293
|
};
|
|
6575
|
-
conditions?: components$
|
|
6294
|
+
conditions?: components$f["schemas"]["ComponentParameterConditions"];
|
|
6576
6295
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
6577
6296
|
localesConditions?: {
|
|
6578
|
-
[key: string]: components$
|
|
6297
|
+
[key: string]: components$f["schemas"]["ComponentParameterConditions"];
|
|
6579
6298
|
};
|
|
6580
6299
|
};
|
|
6581
6300
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -6610,7 +6329,7 @@ interface components$e {
|
|
|
6610
6329
|
/** 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 */
|
|
6611
6330
|
isSearchHit?: boolean;
|
|
6612
6331
|
/** Query strings that are allowed to be passed to the node */
|
|
6613
|
-
queryStrings?: components$
|
|
6332
|
+
queryStrings?: components$f["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
6614
6333
|
/**
|
|
6615
6334
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
6616
6335
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -6635,7 +6354,7 @@ interface components$e {
|
|
|
6635
6354
|
* Unique identifier for the project map that this node belongs to
|
|
6636
6355
|
*/
|
|
6637
6356
|
projectMapId: string;
|
|
6638
|
-
data?: components$
|
|
6357
|
+
data?: components$f["schemas"]["ProjectMapNodeData"];
|
|
6639
6358
|
/**
|
|
6640
6359
|
* Locale-specific paths of the project map node.
|
|
6641
6360
|
* Keys are locale codes
|
|
@@ -6655,13 +6374,13 @@ interface components$e {
|
|
|
6655
6374
|
type: string;
|
|
6656
6375
|
/** Component parameter values for the component instance */
|
|
6657
6376
|
parameters?: {
|
|
6658
|
-
[key: string]: components$
|
|
6377
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6659
6378
|
};
|
|
6660
6379
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6661
6380
|
variant?: string;
|
|
6662
6381
|
/** Slots containing any child components */
|
|
6663
6382
|
slots?: {
|
|
6664
|
-
[key: string]: components$
|
|
6383
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6665
6384
|
};
|
|
6666
6385
|
/**
|
|
6667
6386
|
* Unique identifier of the component within the composition.
|
|
@@ -6672,20 +6391,20 @@ interface components$e {
|
|
|
6672
6391
|
_id?: string;
|
|
6673
6392
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
6674
6393
|
_pattern?: string;
|
|
6675
|
-
_dataResources?: components$
|
|
6394
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6676
6395
|
/**
|
|
6677
6396
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
6678
6397
|
* Means nothing for PUTs; it will be ignored
|
|
6679
6398
|
*/
|
|
6680
6399
|
_patternDataResources?: {
|
|
6681
|
-
[key: string]: components$
|
|
6400
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6682
6401
|
};
|
|
6683
6402
|
/**
|
|
6684
6403
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6685
6404
|
* Means nothing for PUTs; it will be ignored
|
|
6686
6405
|
*/
|
|
6687
6406
|
_patternOptedInQueryStrings?: string[];
|
|
6688
|
-
_patternError?: components$
|
|
6407
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6689
6408
|
/**
|
|
6690
6409
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6691
6410
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6699,14 +6418,14 @@ interface components$e {
|
|
|
6699
6418
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6700
6419
|
*/
|
|
6701
6420
|
_overrides?: {
|
|
6702
|
-
[key: string]: components$
|
|
6421
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6703
6422
|
};
|
|
6704
6423
|
/**
|
|
6705
6424
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6706
6425
|
* Means nothing for PUTs; it will be ignored
|
|
6707
6426
|
*/
|
|
6708
6427
|
_patternOverrides?: {
|
|
6709
|
-
[key: string]: components$
|
|
6428
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6710
6429
|
};
|
|
6711
6430
|
/**
|
|
6712
6431
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6715,7 +6434,7 @@ interface components$e {
|
|
|
6715
6434
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6716
6435
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6717
6436
|
*/
|
|
6718
|
-
_overridability?: components$
|
|
6437
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6719
6438
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
6720
6439
|
_locales?: string[];
|
|
6721
6440
|
};
|
|
@@ -6740,14 +6459,14 @@ interface components$e {
|
|
|
6740
6459
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
6741
6460
|
*/
|
|
6742
6461
|
optionalPatternParameter?: boolean;
|
|
6743
|
-
variables?: components$
|
|
6462
|
+
variables?: components$f["schemas"]["DataResourceVariables"];
|
|
6744
6463
|
};
|
|
6745
6464
|
/**
|
|
6746
6465
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
6747
6466
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
6748
6467
|
*/
|
|
6749
6468
|
DataResourceDefinitions: {
|
|
6750
|
-
[key: string]: components$
|
|
6469
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6751
6470
|
};
|
|
6752
6471
|
/**
|
|
6753
6472
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -6765,10 +6484,10 @@ interface components$e {
|
|
|
6765
6484
|
*/
|
|
6766
6485
|
ComponentOverride: {
|
|
6767
6486
|
parameters?: {
|
|
6768
|
-
[key: string]: components$
|
|
6487
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6769
6488
|
};
|
|
6770
6489
|
slots?: {
|
|
6771
|
-
[key: string]: components$
|
|
6490
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6772
6491
|
};
|
|
6773
6492
|
variant?: string;
|
|
6774
6493
|
/**
|
|
@@ -6777,7 +6496,7 @@ interface components$e {
|
|
|
6777
6496
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
6778
6497
|
*/
|
|
6779
6498
|
dataResources?: {
|
|
6780
|
-
[key: string]: components$
|
|
6499
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6781
6500
|
};
|
|
6782
6501
|
};
|
|
6783
6502
|
/**
|
|
@@ -6798,7 +6517,7 @@ interface components$e {
|
|
|
6798
6517
|
ComponentOverridability: {
|
|
6799
6518
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
6800
6519
|
parameters?: {
|
|
6801
|
-
[key: string]: components$
|
|
6520
|
+
[key: string]: components$f["schemas"]["OverrideOptions"];
|
|
6802
6521
|
};
|
|
6803
6522
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
6804
6523
|
variants?: boolean;
|
|
@@ -6815,15 +6534,15 @@ interface components$e {
|
|
|
6815
6534
|
type: string;
|
|
6816
6535
|
/** Component parameter values for the component instance */
|
|
6817
6536
|
parameters?: {
|
|
6818
|
-
[key: string]: components$
|
|
6537
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6819
6538
|
};
|
|
6820
6539
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6821
6540
|
variant?: string;
|
|
6822
6541
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
6823
|
-
projectMapNodes?: components$
|
|
6542
|
+
projectMapNodes?: components$f["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
6824
6543
|
/** Slots containing any child components */
|
|
6825
6544
|
slots?: {
|
|
6826
|
-
[key: string]: components$
|
|
6545
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6827
6546
|
};
|
|
6828
6547
|
/** The ID of the composition */
|
|
6829
6548
|
_id: string;
|
|
@@ -6846,15 +6565,15 @@ interface components$e {
|
|
|
6846
6565
|
* Means nothing for PUTs; it will be ignored
|
|
6847
6566
|
*/
|
|
6848
6567
|
_patternDataResources?: {
|
|
6849
|
-
[key: string]: components$
|
|
6568
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6850
6569
|
};
|
|
6851
6570
|
/**
|
|
6852
6571
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6853
6572
|
* Means nothing for PUTs; it will be ignored
|
|
6854
6573
|
*/
|
|
6855
6574
|
_patternOptedInQueryStrings?: string[];
|
|
6856
|
-
_dataResources?: components$
|
|
6857
|
-
_patternError?: components$
|
|
6575
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6576
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6858
6577
|
/**
|
|
6859
6578
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6860
6579
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6868,14 +6587,14 @@ interface components$e {
|
|
|
6868
6587
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6869
6588
|
*/
|
|
6870
6589
|
_overrides?: {
|
|
6871
|
-
[key: string]: components$
|
|
6590
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6872
6591
|
};
|
|
6873
6592
|
/**
|
|
6874
6593
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6875
6594
|
* Means nothing for PUTs; it will be ignored
|
|
6876
6595
|
*/
|
|
6877
6596
|
_patternOverrides?: {
|
|
6878
|
-
[key: string]: components$
|
|
6597
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6879
6598
|
};
|
|
6880
6599
|
/**
|
|
6881
6600
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6884,7 +6603,7 @@ interface components$e {
|
|
|
6884
6603
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6885
6604
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6886
6605
|
*/
|
|
6887
|
-
_overridability?: components$
|
|
6606
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6888
6607
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
6889
6608
|
_locales?: string[];
|
|
6890
6609
|
/**
|
|
@@ -6923,7 +6642,7 @@ interface components$e {
|
|
|
6923
6642
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
6924
6643
|
*/
|
|
6925
6644
|
permissions: {
|
|
6926
|
-
[key: string]: components$
|
|
6645
|
+
[key: string]: components$f["schemas"]["WorkflowStageTransitionPermission"];
|
|
6927
6646
|
};
|
|
6928
6647
|
};
|
|
6929
6648
|
/** Definition of a stage in a workflow */
|
|
@@ -6937,7 +6656,7 @@ interface components$e {
|
|
|
6937
6656
|
* listed here, the stage is read-only and publishing is disabled
|
|
6938
6657
|
*/
|
|
6939
6658
|
permissions: {
|
|
6940
|
-
[key: string]: components$
|
|
6659
|
+
[key: string]: components$f["schemas"]["WorkflowStagePermission"];
|
|
6941
6660
|
};
|
|
6942
6661
|
/**
|
|
6943
6662
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -6957,7 +6676,7 @@ interface components$e {
|
|
|
6957
6676
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
6958
6677
|
* has a stage that can never be escaped
|
|
6959
6678
|
*/
|
|
6960
|
-
transitions: components$
|
|
6679
|
+
transitions: components$f["schemas"]["WorkflowStageTransition"][];
|
|
6961
6680
|
/**
|
|
6962
6681
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
6963
6682
|
* @defaultValue chevron-double-right-o
|
|
@@ -6982,7 +6701,7 @@ interface components$e {
|
|
|
6982
6701
|
initialStage: string;
|
|
6983
6702
|
/** All stages of the workflow */
|
|
6984
6703
|
stages: {
|
|
6985
|
-
[key: string]: components$
|
|
6704
|
+
[key: string]: components$f["schemas"]["WorkflowStage"];
|
|
6986
6705
|
};
|
|
6987
6706
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
6988
6707
|
modified?: string;
|
|
@@ -7030,6 +6749,8 @@ interface components$e {
|
|
|
7030
6749
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7031
6750
|
*/
|
|
7032
6751
|
deletedAt?: string;
|
|
6752
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
6753
|
+
publishedWhenTrashed?: boolean;
|
|
7033
6754
|
/** User name of the creator of this composition */
|
|
7034
6755
|
creator?: string;
|
|
7035
6756
|
/** User name of the last editor of this composition */
|
|
@@ -7055,7 +6776,7 @@ interface components$e {
|
|
|
7055
6776
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7056
6777
|
*/
|
|
7057
6778
|
releaseId?: string;
|
|
7058
|
-
composition: components$
|
|
6779
|
+
composition: components$f["schemas"]["RootComponentInstance"];
|
|
7059
6780
|
/**
|
|
7060
6781
|
* Format: uuid
|
|
7061
6782
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7073,7 +6794,7 @@ interface components$e {
|
|
|
7073
6794
|
*/
|
|
7074
6795
|
instanceWorkflowId?: string;
|
|
7075
6796
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7076
|
-
workflowDefinition?: components$
|
|
6797
|
+
workflowDefinition?: components$f["schemas"]["WorkflowDefinition"];
|
|
7077
6798
|
/**
|
|
7078
6799
|
* Format: uuid
|
|
7079
6800
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7184,7 +6905,7 @@ interface components$e {
|
|
|
7184
6905
|
pathItems: never;
|
|
7185
6906
|
}
|
|
7186
6907
|
|
|
7187
|
-
interface paths$
|
|
6908
|
+
interface paths$d {
|
|
7188
6909
|
"/api/v1/canvas": {
|
|
7189
6910
|
parameters: {
|
|
7190
6911
|
query?: never;
|
|
@@ -7306,56 +7027,56 @@ interface paths$c {
|
|
|
7306
7027
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7307
7028
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7308
7029
|
*/
|
|
7309
|
-
compositionId?: components$
|
|
7030
|
+
compositionId?: components$e["parameters"]["compositionId"];
|
|
7310
7031
|
/**
|
|
7311
7032
|
* Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
7312
7033
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7313
7034
|
*/
|
|
7314
|
-
componentId?: components$
|
|
7035
|
+
componentId?: components$e["parameters"]["componentId"];
|
|
7315
7036
|
/**
|
|
7316
7037
|
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
7317
7038
|
* Must be used with the `compositionId` parameter
|
|
7318
7039
|
*/
|
|
7319
|
-
versionId?: components$
|
|
7040
|
+
versionId?: components$e["parameters"]["versionId"];
|
|
7320
7041
|
/**
|
|
7321
7042
|
* Specify multiple composition IDs to fetch. The response type will be a list.
|
|
7322
7043
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7323
7044
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7324
7045
|
*/
|
|
7325
|
-
compositionIDs?: components$
|
|
7046
|
+
compositionIDs?: components$e["parameters"]["compositionIDs"];
|
|
7326
7047
|
/**
|
|
7327
7048
|
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
7328
7049
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7329
7050
|
*/
|
|
7330
|
-
createdBy?: components$
|
|
7051
|
+
createdBy?: components$e["parameters"]["createdBy"];
|
|
7331
7052
|
/**
|
|
7332
7053
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
7333
7054
|
* NOT a full-text search; does not match composition contents.
|
|
7334
7055
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7335
7056
|
*/
|
|
7336
|
-
keyword?: components$
|
|
7057
|
+
keyword?: components$e["parameters"]["keyword"];
|
|
7337
7058
|
/**
|
|
7338
7059
|
* Maximum number of records to return
|
|
7339
7060
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7340
7061
|
*/
|
|
7341
|
-
limit?: components$
|
|
7062
|
+
limit?: components$e["parameters"]["limit"];
|
|
7342
7063
|
/**
|
|
7343
7064
|
* Number of records to skip
|
|
7344
7065
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7345
7066
|
*/
|
|
7346
|
-
offset?: components$
|
|
7067
|
+
offset?: components$e["parameters"]["offset"];
|
|
7347
7068
|
/**
|
|
7348
7069
|
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
7349
7070
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
7350
7071
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
7351
7072
|
* When using primary query parameters, this parameter is ignored
|
|
7352
7073
|
*/
|
|
7353
|
-
orderBy?: components$
|
|
7074
|
+
orderBy?: components$e["parameters"]["orderBy"];
|
|
7354
7075
|
/**
|
|
7355
7076
|
* @deprecated
|
|
7356
7077
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
7357
7078
|
*/
|
|
7358
|
-
facetBy?: components$
|
|
7079
|
+
facetBy?: components$e["parameters"]["facetBy"];
|
|
7359
7080
|
/**
|
|
7360
7081
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
7361
7082
|
* If true, only pattern compositions will be returned.
|
|
@@ -7363,44 +7084,44 @@ interface paths$c {
|
|
|
7363
7084
|
* If omitted or 'any', both pattern and regular compositions will be returned.
|
|
7364
7085
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7365
7086
|
*/
|
|
7366
|
-
pattern?: components$
|
|
7087
|
+
pattern?: components$e["parameters"]["pattern"];
|
|
7367
7088
|
/**
|
|
7368
7089
|
* This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
7369
7090
|
* * `all` - Returns all pattern instances
|
|
7370
7091
|
* * `component` - Returns only component patterns
|
|
7371
7092
|
* * `composition` - Returns only composition patterns
|
|
7372
7093
|
*/
|
|
7373
|
-
patternType?: components$
|
|
7094
|
+
patternType?: components$e["parameters"]["patternType"];
|
|
7374
7095
|
/**
|
|
7375
7096
|
* @deprecated
|
|
7376
7097
|
* Includes the `patternType` attribute in the response
|
|
7377
7098
|
*/
|
|
7378
|
-
withPatternType?: components$
|
|
7099
|
+
withPatternType?: components$e["parameters"]["withPatternType"];
|
|
7379
7100
|
/** The project the composition(s) belong to */
|
|
7380
|
-
projectId: components$
|
|
7101
|
+
projectId: components$e["parameters"]["projectId"];
|
|
7381
7102
|
/**
|
|
7382
7103
|
* Specify a project map ID to fetch by path or node ID from.
|
|
7383
7104
|
* If not specified, the default project map for the projectId is used.
|
|
7384
7105
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
7385
7106
|
*/
|
|
7386
|
-
projectMapId?: components$
|
|
7107
|
+
projectMapId?: components$e["parameters"]["projectMapId"];
|
|
7387
7108
|
/**
|
|
7388
7109
|
* Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
7389
7110
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7390
7111
|
*/
|
|
7391
|
-
projectMapNodeId?: components$
|
|
7112
|
+
projectMapNodeId?: components$e["parameters"]["projectMapNodeId"];
|
|
7392
7113
|
/**
|
|
7393
7114
|
* Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
7394
7115
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7395
7116
|
*/
|
|
7396
|
-
projectMapNodePath?: components$
|
|
7117
|
+
projectMapNodePath?: components$e["parameters"]["projectMapNodePath"];
|
|
7397
7118
|
/**
|
|
7398
7119
|
* @deprecated
|
|
7399
7120
|
* Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
7400
7121
|
* This improves performance if you do not require enhanced component data.
|
|
7401
7122
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
7402
7123
|
*/
|
|
7403
|
-
skipEnhance?: components$
|
|
7124
|
+
skipEnhance?: components$e["parameters"]["skipEnhance"];
|
|
7404
7125
|
/**
|
|
7405
7126
|
* If true, any pattern references in the composition will be left unresolved.
|
|
7406
7127
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -7408,12 +7129,12 @@ interface paths$c {
|
|
|
7408
7129
|
* Default: true when `format` is canonical. False otherwise.
|
|
7409
7130
|
* Prefer selecting a `format` rather than using this option.
|
|
7410
7131
|
*/
|
|
7411
|
-
skipPatternResolution?: components$
|
|
7132
|
+
skipPatternResolution?: components$e["parameters"]["skipPatternResolution"];
|
|
7412
7133
|
/**
|
|
7413
7134
|
* @deprecated
|
|
7414
7135
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
7415
7136
|
*/
|
|
7416
|
-
skipParameterResolution?: components$
|
|
7137
|
+
skipParameterResolution?: components$e["parameters"]["skipParameterResolution"];
|
|
7417
7138
|
/**
|
|
7418
7139
|
* If true, any pattern override data is not resolved by the API.
|
|
7419
7140
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
@@ -7421,69 +7142,69 @@ interface paths$c {
|
|
|
7421
7142
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7422
7143
|
* Prefer selecting a `format` rather than using this option.
|
|
7423
7144
|
*/
|
|
7424
|
-
skipOverridesResolution?: components$
|
|
7145
|
+
skipOverridesResolution?: components$e["parameters"]["skipOverridesResolution"];
|
|
7425
7146
|
/**
|
|
7426
7147
|
* Specify a single composition to fetch by slug. The response will be a single composition.
|
|
7427
7148
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7428
7149
|
*/
|
|
7429
|
-
slug?: components$
|
|
7150
|
+
slug?: components$e["parameters"]["slug"];
|
|
7430
7151
|
/** Filtration by category ID. An empty string can be used to include records without a category. */
|
|
7431
|
-
categories?: components$
|
|
7152
|
+
categories?: components$e["parameters"]["categories"];
|
|
7432
7153
|
/**
|
|
7433
7154
|
* Publishing state to fetch. 0 = draft, 64 = published.
|
|
7434
7155
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7435
7156
|
*/
|
|
7436
|
-
state?: components$
|
|
7157
|
+
state?: components$e["parameters"]["state"];
|
|
7437
7158
|
/**
|
|
7438
7159
|
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
|
7439
7160
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7440
7161
|
*/
|
|
7441
|
-
type?: components$
|
|
7162
|
+
type?: components$e["parameters"]["type"];
|
|
7442
7163
|
/**
|
|
7443
7164
|
* @deprecated
|
|
7444
7165
|
* Filters composition lists by the UI status of the composition.
|
|
7445
7166
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data.
|
|
7446
7167
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7447
7168
|
*/
|
|
7448
|
-
uiStatus?: components$
|
|
7169
|
+
uiStatus?: components$e["parameters"]["uiStatus"];
|
|
7449
7170
|
/**
|
|
7450
7171
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
|
7451
7172
|
* if set to false. If not specified, no filtration is applied.
|
|
7452
7173
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7453
7174
|
*/
|
|
7454
|
-
attachedToProjectMap?: components$
|
|
7175
|
+
attachedToProjectMap?: components$e["parameters"]["attachedToProjectMap"];
|
|
7455
7176
|
/**
|
|
7456
7177
|
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
7457
7178
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7458
7179
|
*/
|
|
7459
|
-
updatedBy?: components$
|
|
7180
|
+
updatedBy?: components$e["parameters"]["updatedBy"];
|
|
7460
7181
|
/**
|
|
7461
7182
|
* If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
7462
7183
|
* If false, the `_id` will not be present in the API response.
|
|
7463
7184
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7464
7185
|
* Prefer selecting a `format` rather than using this option.
|
|
7465
7186
|
*/
|
|
7466
|
-
withComponentIDs?: components$
|
|
7187
|
+
withComponentIDs?: components$e["parameters"]["withComponentIDs"];
|
|
7467
7188
|
/**
|
|
7468
7189
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
7469
7190
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
7470
7191
|
*/
|
|
7471
|
-
withTotalCount?: components$
|
|
7192
|
+
withTotalCount?: components$e["parameters"]["withTotalCount"];
|
|
7472
7193
|
/**
|
|
7473
7194
|
* @deprecated
|
|
7474
7195
|
* Returns the UI status string of the composition.
|
|
7475
7196
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
7476
7197
|
*/
|
|
7477
|
-
withUIStatus?: components$
|
|
7198
|
+
withUIStatus?: components$e["parameters"]["withUIStatus"];
|
|
7478
7199
|
/** Returns the definition of any attached workflow along with the composition data */
|
|
7479
|
-
withWorkflowDefinition?: components$
|
|
7200
|
+
withWorkflowDefinition?: components$e["parameters"]["withWorkflowDefinition"];
|
|
7480
7201
|
/** Includes project map node information in the composition results */
|
|
7481
|
-
withProjectMapNodes?: components$
|
|
7202
|
+
withProjectMapNodes?: components$e["parameters"]["withProjectMapNodes"];
|
|
7482
7203
|
/**
|
|
7483
7204
|
* @deprecated
|
|
7484
7205
|
* Has no effect.
|
|
7485
7206
|
*/
|
|
7486
|
-
withContentSourceMap?: components$
|
|
7207
|
+
withContentSourceMap?: components$e["parameters"]["withContentSourceMap"];
|
|
7487
7208
|
/**
|
|
7488
7209
|
* One or more locales to filter and localize by.
|
|
7489
7210
|
* For list responses, only compositions that enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
|
|
@@ -7497,7 +7218,7 @@ interface paths$c {
|
|
|
7497
7218
|
* When this parameter is not passed, all locales' data will be returned.
|
|
7498
7219
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
7499
7220
|
*/
|
|
7500
|
-
locale?: components$
|
|
7221
|
+
locale?: components$e["parameters"]["locale"];
|
|
7501
7222
|
/**
|
|
7502
7223
|
* The ID of a release to fetch the content for.
|
|
7503
7224
|
*
|
|
@@ -7506,7 +7227,7 @@ interface paths$c {
|
|
|
7506
7227
|
*
|
|
7507
7228
|
* 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 null
|
|
7508
7229
|
*/
|
|
7509
|
-
releaseId?: components$
|
|
7230
|
+
releaseId?: components$e["parameters"]["releaseId"];
|
|
7510
7231
|
/**
|
|
7511
7232
|
* Search on textual fields of a composition.
|
|
7512
7233
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -7514,7 +7235,7 @@ interface paths$c {
|
|
|
7514
7235
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
7515
7236
|
* Example: ?search=hello
|
|
7516
7237
|
*/
|
|
7517
|
-
search?: components$
|
|
7238
|
+
search?: components$e["parameters"]["search"];
|
|
7518
7239
|
/**
|
|
7519
7240
|
* @deprecated
|
|
7520
7241
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -7522,7 +7243,7 @@ interface paths$c {
|
|
|
7522
7243
|
* Use this for "where is this content defined" queries.
|
|
7523
7244
|
* Requires AI credits.
|
|
7524
7245
|
*/
|
|
7525
|
-
searchSemantic?: components$
|
|
7246
|
+
searchSemantic?: components$e["parameters"]["searchSemantic"];
|
|
7526
7247
|
/**
|
|
7527
7248
|
* Controls the edition resolution behavior.
|
|
7528
7249
|
*
|
|
@@ -7537,7 +7258,7 @@ interface paths$c {
|
|
|
7537
7258
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
7538
7259
|
* If versionId is passed, this is always enabled.
|
|
7539
7260
|
*/
|
|
7540
|
-
editions?: components$
|
|
7261
|
+
editions?: components$e["parameters"]["editions"];
|
|
7541
7262
|
/**
|
|
7542
7263
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7543
7264
|
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
@@ -7550,7 +7271,7 @@ interface paths$c {
|
|
|
7550
7271
|
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7551
7272
|
* and component `_id`s removed.
|
|
7552
7273
|
*/
|
|
7553
|
-
format?: components$
|
|
7274
|
+
format?: components$e["parameters"]["format"];
|
|
7554
7275
|
/**
|
|
7555
7276
|
* Controls filtering of trashed items.
|
|
7556
7277
|
*
|
|
@@ -7558,7 +7279,7 @@ interface paths$c {
|
|
|
7558
7279
|
* only: Only return trashed items (for trash view).
|
|
7559
7280
|
* include: Return both trashed and non-trashed items.
|
|
7560
7281
|
*/
|
|
7561
|
-
deleted?: components$
|
|
7282
|
+
deleted?: components$e["parameters"]["deleted"];
|
|
7562
7283
|
};
|
|
7563
7284
|
header?: never;
|
|
7564
7285
|
path?: never;
|
|
@@ -7572,12 +7293,12 @@ interface paths$c {
|
|
|
7572
7293
|
[name: string]: unknown;
|
|
7573
7294
|
};
|
|
7574
7295
|
content: {
|
|
7575
|
-
"application/json": components$
|
|
7296
|
+
"application/json": components$e["schemas"]["CompositionListResponse"] | components$e["schemas"]["CompositionApiResponse"];
|
|
7576
7297
|
};
|
|
7577
7298
|
};
|
|
7578
|
-
400: components$
|
|
7579
|
-
401: components$
|
|
7580
|
-
403: components$
|
|
7299
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7300
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7301
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7581
7302
|
/** Composition not found */
|
|
7582
7303
|
404: {
|
|
7583
7304
|
headers: {
|
|
@@ -7587,8 +7308,8 @@ interface paths$c {
|
|
|
7587
7308
|
"text/plain": string;
|
|
7588
7309
|
};
|
|
7589
7310
|
};
|
|
7590
|
-
429: components$
|
|
7591
|
-
500: components$
|
|
7311
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7312
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7592
7313
|
};
|
|
7593
7314
|
};
|
|
7594
7315
|
/** Upserts a composition */
|
|
@@ -7616,7 +7337,7 @@ interface paths$c {
|
|
|
7616
7337
|
projectId: string;
|
|
7617
7338
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
7618
7339
|
state: number;
|
|
7619
|
-
composition: components$
|
|
7340
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7620
7341
|
/**
|
|
7621
7342
|
* Indicates if the composition is a pattern that can be referenced in other compositions
|
|
7622
7343
|
* @defaultValue false
|
|
@@ -7692,9 +7413,9 @@ interface paths$c {
|
|
|
7692
7413
|
};
|
|
7693
7414
|
content?: never;
|
|
7694
7415
|
};
|
|
7695
|
-
400: components$
|
|
7696
|
-
401: components$
|
|
7697
|
-
403: components$
|
|
7416
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7417
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7418
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7698
7419
|
/** Conflict - Composition has been changed since being loaded */
|
|
7699
7420
|
409: {
|
|
7700
7421
|
headers: {
|
|
@@ -7704,8 +7425,8 @@ interface paths$c {
|
|
|
7704
7425
|
"text/plain": string;
|
|
7705
7426
|
};
|
|
7706
7427
|
};
|
|
7707
|
-
429: components$
|
|
7708
|
-
500: components$
|
|
7428
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7429
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7709
7430
|
};
|
|
7710
7431
|
};
|
|
7711
7432
|
post?: never;
|
|
@@ -7758,11 +7479,11 @@ interface paths$c {
|
|
|
7758
7479
|
};
|
|
7759
7480
|
content?: never;
|
|
7760
7481
|
};
|
|
7761
|
-
400: components$
|
|
7762
|
-
401: components$
|
|
7763
|
-
403: components$
|
|
7764
|
-
429: components$
|
|
7765
|
-
500: components$
|
|
7482
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7483
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7484
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7485
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7486
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7766
7487
|
};
|
|
7767
7488
|
};
|
|
7768
7489
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -7789,7 +7510,7 @@ interface paths$c {
|
|
|
7789
7510
|
trace?: never;
|
|
7790
7511
|
};
|
|
7791
7512
|
}
|
|
7792
|
-
interface components$
|
|
7513
|
+
interface components$e {
|
|
7793
7514
|
schemas: {
|
|
7794
7515
|
CompositionApiResponse: {
|
|
7795
7516
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -7820,6 +7541,8 @@ interface components$d {
|
|
|
7820
7541
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7821
7542
|
*/
|
|
7822
7543
|
deletedAt?: string;
|
|
7544
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
7545
|
+
publishedWhenTrashed?: boolean;
|
|
7823
7546
|
/** User name of the creator of this composition */
|
|
7824
7547
|
creator?: string;
|
|
7825
7548
|
/** User name of the last editor of this composition */
|
|
@@ -7845,7 +7568,7 @@ interface components$d {
|
|
|
7845
7568
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7846
7569
|
*/
|
|
7847
7570
|
releaseId?: string;
|
|
7848
|
-
composition: components$
|
|
7571
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7849
7572
|
/**
|
|
7850
7573
|
* Format: uuid
|
|
7851
7574
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7863,7 +7586,7 @@ interface components$d {
|
|
|
7863
7586
|
*/
|
|
7864
7587
|
instanceWorkflowId?: string;
|
|
7865
7588
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7866
|
-
workflowDefinition?: components$
|
|
7589
|
+
workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
|
|
7867
7590
|
/**
|
|
7868
7591
|
* Format: uuid
|
|
7869
7592
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7881,7 +7604,7 @@ interface components$d {
|
|
|
7881
7604
|
editionPriority?: number;
|
|
7882
7605
|
};
|
|
7883
7606
|
CompositionListResponse: {
|
|
7884
|
-
compositions: components$
|
|
7607
|
+
compositions: components$e["schemas"]["CompositionApiResponse"][];
|
|
7885
7608
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
7886
7609
|
totalCount?: number;
|
|
7887
7610
|
/** Per-field counts for distinct values */
|
|
@@ -7955,11 +7678,11 @@ interface components$d {
|
|
|
7955
7678
|
|
|
7956
7679
|
*/
|
|
7957
7680
|
op?: "&" | "|";
|
|
7958
|
-
clauses: (components$
|
|
7681
|
+
clauses: (components$e["schemas"]["VisibilityCriteria"] | components$e["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7959
7682
|
};
|
|
7960
7683
|
/** Defines a conditional value for a component parameter */
|
|
7961
7684
|
ComponentParameterConditionalValue: {
|
|
7962
|
-
when: components$
|
|
7685
|
+
when: components$e["schemas"]["VisibilityCriteriaGroup"];
|
|
7963
7686
|
/**
|
|
7964
7687
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7965
7688
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -7981,7 +7704,7 @@ interface components$d {
|
|
|
7981
7704
|
*
|
|
7982
7705
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7983
7706
|
*/
|
|
7984
|
-
ComponentParameterConditions: components$
|
|
7707
|
+
ComponentParameterConditions: components$e["schemas"]["ComponentParameterConditionalValue"][];
|
|
7985
7708
|
/** Defines an editable parameter on a component */
|
|
7986
7709
|
ComponentParameter: {
|
|
7987
7710
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7989,7 +7712,7 @@ interface components$d {
|
|
|
7989
7712
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7990
7713
|
type: string;
|
|
7991
7714
|
/** @deprecated */
|
|
7992
|
-
connectedData?: components$
|
|
7715
|
+
connectedData?: components$e["schemas"]["DataElementConnectionDefinition"];
|
|
7993
7716
|
/**
|
|
7994
7717
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
7995
7718
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -7997,10 +7720,10 @@ interface components$d {
|
|
|
7997
7720
|
locales?: {
|
|
7998
7721
|
[key: string]: unknown;
|
|
7999
7722
|
};
|
|
8000
|
-
conditions?: components$
|
|
7723
|
+
conditions?: components$e["schemas"]["ComponentParameterConditions"];
|
|
8001
7724
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
8002
7725
|
localesConditions?: {
|
|
8003
|
-
[key: string]: components$
|
|
7726
|
+
[key: string]: components$e["schemas"]["ComponentParameterConditions"];
|
|
8004
7727
|
};
|
|
8005
7728
|
};
|
|
8006
7729
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -8035,7 +7758,7 @@ interface components$d {
|
|
|
8035
7758
|
/** 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 */
|
|
8036
7759
|
isSearchHit?: boolean;
|
|
8037
7760
|
/** Query strings that are allowed to be passed to the node */
|
|
8038
|
-
queryStrings?: components$
|
|
7761
|
+
queryStrings?: components$e["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
8039
7762
|
/**
|
|
8040
7763
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
8041
7764
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -8060,7 +7783,7 @@ interface components$d {
|
|
|
8060
7783
|
* Unique identifier for the project map that this node belongs to
|
|
8061
7784
|
*/
|
|
8062
7785
|
projectMapId: string;
|
|
8063
|
-
data?: components$
|
|
7786
|
+
data?: components$e["schemas"]["ProjectMapNodeData"];
|
|
8064
7787
|
/**
|
|
8065
7788
|
* Locale-specific paths of the project map node.
|
|
8066
7789
|
* Keys are locale codes
|
|
@@ -8080,13 +7803,13 @@ interface components$d {
|
|
|
8080
7803
|
type: string;
|
|
8081
7804
|
/** Component parameter values for the component instance */
|
|
8082
7805
|
parameters?: {
|
|
8083
|
-
[key: string]: components$
|
|
7806
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8084
7807
|
};
|
|
8085
7808
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8086
7809
|
variant?: string;
|
|
8087
7810
|
/** Slots containing any child components */
|
|
8088
7811
|
slots?: {
|
|
8089
|
-
[key: string]: components$
|
|
7812
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8090
7813
|
};
|
|
8091
7814
|
/**
|
|
8092
7815
|
* Unique identifier of the component within the composition.
|
|
@@ -8097,20 +7820,20 @@ interface components$d {
|
|
|
8097
7820
|
_id?: string;
|
|
8098
7821
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
8099
7822
|
_pattern?: string;
|
|
8100
|
-
_dataResources?: components$
|
|
7823
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8101
7824
|
/**
|
|
8102
7825
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8103
7826
|
* Means nothing for PUTs; it will be ignored
|
|
8104
7827
|
*/
|
|
8105
7828
|
_patternDataResources?: {
|
|
8106
|
-
[key: string]: components$
|
|
7829
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8107
7830
|
};
|
|
8108
7831
|
/**
|
|
8109
7832
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8110
7833
|
* Means nothing for PUTs; it will be ignored
|
|
8111
7834
|
*/
|
|
8112
7835
|
_patternOptedInQueryStrings?: string[];
|
|
8113
|
-
_patternError?: components$
|
|
7836
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8114
7837
|
/**
|
|
8115
7838
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8116
7839
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8124,14 +7847,14 @@ interface components$d {
|
|
|
8124
7847
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8125
7848
|
*/
|
|
8126
7849
|
_overrides?: {
|
|
8127
|
-
[key: string]: components$
|
|
7850
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8128
7851
|
};
|
|
8129
7852
|
/**
|
|
8130
7853
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8131
7854
|
* Means nothing for PUTs; it will be ignored
|
|
8132
7855
|
*/
|
|
8133
7856
|
_patternOverrides?: {
|
|
8134
|
-
[key: string]: components$
|
|
7857
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8135
7858
|
};
|
|
8136
7859
|
/**
|
|
8137
7860
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8140,7 +7863,7 @@ interface components$d {
|
|
|
8140
7863
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8141
7864
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8142
7865
|
*/
|
|
8143
|
-
_overridability?: components$
|
|
7866
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8144
7867
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
8145
7868
|
_locales?: string[];
|
|
8146
7869
|
};
|
|
@@ -8165,14 +7888,14 @@ interface components$d {
|
|
|
8165
7888
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
8166
7889
|
*/
|
|
8167
7890
|
optionalPatternParameter?: boolean;
|
|
8168
|
-
variables?: components$
|
|
7891
|
+
variables?: components$e["schemas"]["DataResourceVariables"];
|
|
8169
7892
|
};
|
|
8170
7893
|
/**
|
|
8171
7894
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
8172
7895
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
8173
7896
|
*/
|
|
8174
7897
|
DataResourceDefinitions: {
|
|
8175
|
-
[key: string]: components$
|
|
7898
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8176
7899
|
};
|
|
8177
7900
|
/**
|
|
8178
7901
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8190,10 +7913,10 @@ interface components$d {
|
|
|
8190
7913
|
*/
|
|
8191
7914
|
ComponentOverride: {
|
|
8192
7915
|
parameters?: {
|
|
8193
|
-
[key: string]: components$
|
|
7916
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8194
7917
|
};
|
|
8195
7918
|
slots?: {
|
|
8196
|
-
[key: string]: components$
|
|
7919
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8197
7920
|
};
|
|
8198
7921
|
variant?: string;
|
|
8199
7922
|
/**
|
|
@@ -8202,7 +7925,7 @@ interface components$d {
|
|
|
8202
7925
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
8203
7926
|
*/
|
|
8204
7927
|
dataResources?: {
|
|
8205
|
-
[key: string]: components$
|
|
7928
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8206
7929
|
};
|
|
8207
7930
|
};
|
|
8208
7931
|
/**
|
|
@@ -8223,7 +7946,7 @@ interface components$d {
|
|
|
8223
7946
|
ComponentOverridability: {
|
|
8224
7947
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
8225
7948
|
parameters?: {
|
|
8226
|
-
[key: string]: components$
|
|
7949
|
+
[key: string]: components$e["schemas"]["OverrideOptions"];
|
|
8227
7950
|
};
|
|
8228
7951
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
8229
7952
|
variants?: boolean;
|
|
@@ -8240,15 +7963,15 @@ interface components$d {
|
|
|
8240
7963
|
type: string;
|
|
8241
7964
|
/** Component parameter values for the component instance */
|
|
8242
7965
|
parameters?: {
|
|
8243
|
-
[key: string]: components$
|
|
7966
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8244
7967
|
};
|
|
8245
7968
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8246
7969
|
variant?: string;
|
|
8247
7970
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
8248
|
-
projectMapNodes?: components$
|
|
7971
|
+
projectMapNodes?: components$e["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
8249
7972
|
/** Slots containing any child components */
|
|
8250
7973
|
slots?: {
|
|
8251
|
-
[key: string]: components$
|
|
7974
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8252
7975
|
};
|
|
8253
7976
|
/** The ID of the composition */
|
|
8254
7977
|
_id: string;
|
|
@@ -8271,15 +7994,15 @@ interface components$d {
|
|
|
8271
7994
|
* Means nothing for PUTs; it will be ignored
|
|
8272
7995
|
*/
|
|
8273
7996
|
_patternDataResources?: {
|
|
8274
|
-
[key: string]: components$
|
|
7997
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8275
7998
|
};
|
|
8276
7999
|
/**
|
|
8277
8000
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8278
8001
|
* Means nothing for PUTs; it will be ignored
|
|
8279
8002
|
*/
|
|
8280
8003
|
_patternOptedInQueryStrings?: string[];
|
|
8281
|
-
_dataResources?: components$
|
|
8282
|
-
_patternError?: components$
|
|
8004
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8005
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8283
8006
|
/**
|
|
8284
8007
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8285
8008
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8293,14 +8016,14 @@ interface components$d {
|
|
|
8293
8016
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8294
8017
|
*/
|
|
8295
8018
|
_overrides?: {
|
|
8296
|
-
[key: string]: components$
|
|
8019
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8297
8020
|
};
|
|
8298
8021
|
/**
|
|
8299
8022
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8300
8023
|
* Means nothing for PUTs; it will be ignored
|
|
8301
8024
|
*/
|
|
8302
8025
|
_patternOverrides?: {
|
|
8303
|
-
[key: string]: components$
|
|
8026
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8304
8027
|
};
|
|
8305
8028
|
/**
|
|
8306
8029
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8309,7 +8032,7 @@ interface components$d {
|
|
|
8309
8032
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8310
8033
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8311
8034
|
*/
|
|
8312
|
-
_overridability?: components$
|
|
8035
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8313
8036
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
8314
8037
|
_locales?: string[];
|
|
8315
8038
|
/**
|
|
@@ -8348,7 +8071,7 @@ interface components$d {
|
|
|
8348
8071
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8349
8072
|
*/
|
|
8350
8073
|
permissions: {
|
|
8351
|
-
[key: string]: components$
|
|
8074
|
+
[key: string]: components$e["schemas"]["WorkflowStageTransitionPermission"];
|
|
8352
8075
|
};
|
|
8353
8076
|
};
|
|
8354
8077
|
/** Definition of a stage in a workflow */
|
|
@@ -8362,7 +8085,7 @@ interface components$d {
|
|
|
8362
8085
|
* listed here, the stage is read-only and publishing is disabled
|
|
8363
8086
|
*/
|
|
8364
8087
|
permissions: {
|
|
8365
|
-
[key: string]: components$
|
|
8088
|
+
[key: string]: components$e["schemas"]["WorkflowStagePermission"];
|
|
8366
8089
|
};
|
|
8367
8090
|
/**
|
|
8368
8091
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -8382,7 +8105,7 @@ interface components$d {
|
|
|
8382
8105
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8383
8106
|
* has a stage that can never be escaped
|
|
8384
8107
|
*/
|
|
8385
|
-
transitions: components$
|
|
8108
|
+
transitions: components$e["schemas"]["WorkflowStageTransition"][];
|
|
8386
8109
|
/**
|
|
8387
8110
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8388
8111
|
* @defaultValue chevron-double-right-o
|
|
@@ -8407,7 +8130,7 @@ interface components$d {
|
|
|
8407
8130
|
initialStage: string;
|
|
8408
8131
|
/** All stages of the workflow */
|
|
8409
8132
|
stages: {
|
|
8410
|
-
[key: string]: components$
|
|
8133
|
+
[key: string]: components$e["schemas"]["WorkflowStage"];
|
|
8411
8134
|
};
|
|
8412
8135
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
8413
8136
|
modified?: string;
|
|
@@ -8438,7 +8161,7 @@ interface components$d {
|
|
|
8438
8161
|
[name: string]: unknown;
|
|
8439
8162
|
};
|
|
8440
8163
|
content: {
|
|
8441
|
-
"application/json": components$
|
|
8164
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8442
8165
|
};
|
|
8443
8166
|
};
|
|
8444
8167
|
/** API key or token was not valid */
|
|
@@ -8447,7 +8170,7 @@ interface components$d {
|
|
|
8447
8170
|
[name: string]: unknown;
|
|
8448
8171
|
};
|
|
8449
8172
|
content: {
|
|
8450
|
-
"application/json": components$
|
|
8173
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8451
8174
|
};
|
|
8452
8175
|
};
|
|
8453
8176
|
/** Permission was denied */
|
|
@@ -8456,7 +8179,7 @@ interface components$d {
|
|
|
8456
8179
|
[name: string]: unknown;
|
|
8457
8180
|
};
|
|
8458
8181
|
content: {
|
|
8459
|
-
"application/json": components$
|
|
8182
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8460
8183
|
};
|
|
8461
8184
|
};
|
|
8462
8185
|
/** Too many requests in allowed time period */
|
|
@@ -8739,7 +8462,7 @@ interface components$d {
|
|
|
8739
8462
|
pathItems: never;
|
|
8740
8463
|
}
|
|
8741
8464
|
|
|
8742
|
-
interface paths$
|
|
8465
|
+
interface paths$c {
|
|
8743
8466
|
"/api/v1/canvas-history": {
|
|
8744
8467
|
parameters: {
|
|
8745
8468
|
query?: never;
|
|
@@ -8773,12 +8496,12 @@ interface paths$b {
|
|
|
8773
8496
|
[name: string]: unknown;
|
|
8774
8497
|
};
|
|
8775
8498
|
content: {
|
|
8776
|
-
"application/json": components$
|
|
8499
|
+
"application/json": components$d["schemas"]["HistoryApiResponse"];
|
|
8777
8500
|
};
|
|
8778
8501
|
};
|
|
8779
|
-
400: components$
|
|
8780
|
-
401: components$
|
|
8781
|
-
403: components$
|
|
8502
|
+
400: components$d["responses"]["BadRequestError"];
|
|
8503
|
+
401: components$d["responses"]["UnauthorizedError"];
|
|
8504
|
+
403: components$d["responses"]["ForbiddenError"];
|
|
8782
8505
|
/** Composition not found */
|
|
8783
8506
|
404: {
|
|
8784
8507
|
headers: {
|
|
@@ -8788,8 +8511,8 @@ interface paths$b {
|
|
|
8788
8511
|
"text/plain": string;
|
|
8789
8512
|
};
|
|
8790
8513
|
};
|
|
8791
|
-
429: components$
|
|
8792
|
-
500: components$
|
|
8514
|
+
429: components$d["responses"]["RateLimitError"];
|
|
8515
|
+
500: components$d["responses"]["InternalServerError"];
|
|
8793
8516
|
};
|
|
8794
8517
|
};
|
|
8795
8518
|
put?: never;
|
|
@@ -8801,7 +8524,7 @@ interface paths$b {
|
|
|
8801
8524
|
trace?: never;
|
|
8802
8525
|
};
|
|
8803
8526
|
}
|
|
8804
|
-
interface components$
|
|
8527
|
+
interface components$d {
|
|
8805
8528
|
schemas: {
|
|
8806
8529
|
HistoryEntry: {
|
|
8807
8530
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -8825,7 +8548,7 @@ interface components$c {
|
|
|
8825
8548
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
8826
8549
|
truncated?: boolean;
|
|
8827
8550
|
/** Version history entries */
|
|
8828
|
-
results?: components$
|
|
8551
|
+
results?: components$d["schemas"]["HistoryEntry"][];
|
|
8829
8552
|
};
|
|
8830
8553
|
Error: {
|
|
8831
8554
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -8839,7 +8562,7 @@ interface components$c {
|
|
|
8839
8562
|
[name: string]: unknown;
|
|
8840
8563
|
};
|
|
8841
8564
|
content: {
|
|
8842
|
-
"application/json": components$
|
|
8565
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8843
8566
|
};
|
|
8844
8567
|
};
|
|
8845
8568
|
/** API key or token was not valid */
|
|
@@ -8848,7 +8571,7 @@ interface components$c {
|
|
|
8848
8571
|
[name: string]: unknown;
|
|
8849
8572
|
};
|
|
8850
8573
|
content: {
|
|
8851
|
-
"application/json": components$
|
|
8574
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8852
8575
|
};
|
|
8853
8576
|
};
|
|
8854
8577
|
/** Permission was denied */
|
|
@@ -8857,7 +8580,7 @@ interface components$c {
|
|
|
8857
8580
|
[name: string]: unknown;
|
|
8858
8581
|
};
|
|
8859
8582
|
content: {
|
|
8860
|
-
"application/json": components$
|
|
8583
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8861
8584
|
};
|
|
8862
8585
|
};
|
|
8863
8586
|
/** Too many requests in allowed time period */
|
|
@@ -8881,41 +8604,41 @@ interface components$c {
|
|
|
8881
8604
|
pathItems: never;
|
|
8882
8605
|
}
|
|
8883
8606
|
|
|
8884
|
-
interface components$
|
|
8607
|
+
interface components$c {
|
|
8885
8608
|
schemas: {
|
|
8886
|
-
CompositionResolvedGetResponse: components$
|
|
8609
|
+
CompositionResolvedGetResponse: components$c["schemas"]["EdgehancersResolutionInfo"] & components$c["schemas"]["CompositionApiResponse"];
|
|
8887
8610
|
CompositionResolvedListResponse: {
|
|
8888
|
-
diagnostics?: components$
|
|
8611
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8889
8612
|
data?: {
|
|
8890
|
-
[key: string]: components$
|
|
8613
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8891
8614
|
};
|
|
8892
8615
|
};
|
|
8893
8616
|
errors?: {
|
|
8894
|
-
[key: string]: components$
|
|
8617
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8895
8618
|
};
|
|
8896
8619
|
warnings?: {
|
|
8897
|
-
[key: string]: components$
|
|
8620
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8898
8621
|
};
|
|
8899
8622
|
infos?: {
|
|
8900
|
-
[key: string]: components$
|
|
8623
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8901
8624
|
};
|
|
8902
|
-
} & components$
|
|
8625
|
+
} & components$c["schemas"]["CompositionListResponse"];
|
|
8903
8626
|
EntryResolvedListResponse: {
|
|
8904
|
-
diagnostics?: components$
|
|
8627
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8905
8628
|
data?: {
|
|
8906
|
-
[key: string]: components$
|
|
8629
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8907
8630
|
};
|
|
8908
8631
|
};
|
|
8909
8632
|
errors?: {
|
|
8910
|
-
[key: string]: components$
|
|
8633
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8911
8634
|
};
|
|
8912
8635
|
warnings?: {
|
|
8913
|
-
[key: string]: components$
|
|
8636
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8914
8637
|
};
|
|
8915
8638
|
infos?: {
|
|
8916
|
-
[key: string]: components$
|
|
8639
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8917
8640
|
};
|
|
8918
|
-
} & components$
|
|
8641
|
+
} & components$c["schemas"]["EntryListResponse"];
|
|
8919
8642
|
EdgehancersResolutionInfo: {
|
|
8920
8643
|
wholeResponseCacheDiagnostics?: {
|
|
8921
8644
|
info: string;
|
|
@@ -8924,19 +8647,19 @@ interface components$b {
|
|
|
8924
8647
|
edgeLocation?: string;
|
|
8925
8648
|
requestId: string;
|
|
8926
8649
|
};
|
|
8927
|
-
diagnostics?: components$
|
|
8928
|
-
data?: components$
|
|
8650
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8651
|
+
data?: components$c["schemas"]["DataDiagnostic"][];
|
|
8929
8652
|
};
|
|
8930
|
-
errors?: components$
|
|
8931
|
-
warnings?: components$
|
|
8932
|
-
infos?: components$
|
|
8653
|
+
errors?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8654
|
+
warnings?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8655
|
+
infos?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8933
8656
|
};
|
|
8934
8657
|
EdgehancersError: {
|
|
8935
8658
|
message: string;
|
|
8936
8659
|
status: number;
|
|
8937
8660
|
statusText: string;
|
|
8938
8661
|
};
|
|
8939
|
-
UniformError: components$
|
|
8662
|
+
UniformError: components$c["schemas"]["EdgehancersError"] | components$c["schemas"]["Error"];
|
|
8940
8663
|
InvalidationPayload: {
|
|
8941
8664
|
/** List of variables with values to invalidate */
|
|
8942
8665
|
variables?: {
|
|
@@ -8950,7 +8673,7 @@ interface components$b {
|
|
|
8950
8673
|
dataTypeId: string;
|
|
8951
8674
|
/** Format: uuid */
|
|
8952
8675
|
purgeKey: string;
|
|
8953
|
-
conditions?: components$
|
|
8676
|
+
conditions?: components$c["schemas"]["InvalidationPayload"];
|
|
8954
8677
|
}[];
|
|
8955
8678
|
DataDiagnostic: {
|
|
8956
8679
|
componentPath: string;
|
|
@@ -9010,7 +8733,7 @@ interface components$b {
|
|
|
9010
8733
|
message: string;
|
|
9011
8734
|
type: string;
|
|
9012
8735
|
parameterName?: string;
|
|
9013
|
-
expression?: components$
|
|
8736
|
+
expression?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9014
8737
|
dataName?: string;
|
|
9015
8738
|
dataType?: string;
|
|
9016
8739
|
inputName?: string;
|
|
@@ -9085,11 +8808,11 @@ interface components$b {
|
|
|
9085
8808
|
|
|
9086
8809
|
*/
|
|
9087
8810
|
op?: "&" | "|";
|
|
9088
|
-
clauses: (components$
|
|
8811
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
9089
8812
|
};
|
|
9090
8813
|
/** Defines a conditional value for a component parameter */
|
|
9091
8814
|
ComponentParameterConditionalValue: {
|
|
9092
|
-
when: components$
|
|
8815
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
9093
8816
|
/**
|
|
9094
8817
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
9095
8818
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -9111,7 +8834,7 @@ interface components$b {
|
|
|
9111
8834
|
*
|
|
9112
8835
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
9113
8836
|
*/
|
|
9114
|
-
ComponentParameterConditions: components$
|
|
8837
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
9115
8838
|
/** Defines an editable parameter on a component */
|
|
9116
8839
|
ComponentParameter: {
|
|
9117
8840
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9119,7 +8842,7 @@ interface components$b {
|
|
|
9119
8842
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9120
8843
|
type: string;
|
|
9121
8844
|
/** @deprecated */
|
|
9122
|
-
connectedData?: components$
|
|
8845
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9123
8846
|
/**
|
|
9124
8847
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9125
8848
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -9127,10 +8850,10 @@ interface components$b {
|
|
|
9127
8850
|
locales?: {
|
|
9128
8851
|
[key: string]: unknown;
|
|
9129
8852
|
};
|
|
9130
|
-
conditions?: components$
|
|
8853
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
9131
8854
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
9132
8855
|
localesConditions?: {
|
|
9133
|
-
[key: string]: components$
|
|
8856
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
9134
8857
|
};
|
|
9135
8858
|
};
|
|
9136
8859
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9165,7 +8888,7 @@ interface components$b {
|
|
|
9165
8888
|
/** 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 */
|
|
9166
8889
|
isSearchHit?: boolean;
|
|
9167
8890
|
/** Query strings that are allowed to be passed to the node */
|
|
9168
|
-
queryStrings?: components$
|
|
8891
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9169
8892
|
/**
|
|
9170
8893
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
9171
8894
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -9190,7 +8913,7 @@ interface components$b {
|
|
|
9190
8913
|
* Unique identifier for the project map that this node belongs to
|
|
9191
8914
|
*/
|
|
9192
8915
|
projectMapId: string;
|
|
9193
|
-
data?: components$
|
|
8916
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
9194
8917
|
/**
|
|
9195
8918
|
* Locale-specific paths of the project map node.
|
|
9196
8919
|
* Keys are locale codes
|
|
@@ -9210,13 +8933,13 @@ interface components$b {
|
|
|
9210
8933
|
type: string;
|
|
9211
8934
|
/** Component parameter values for the component instance */
|
|
9212
8935
|
parameters?: {
|
|
9213
|
-
[key: string]: components$
|
|
8936
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9214
8937
|
};
|
|
9215
8938
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9216
8939
|
variant?: string;
|
|
9217
8940
|
/** Slots containing any child components */
|
|
9218
8941
|
slots?: {
|
|
9219
|
-
[key: string]: components$
|
|
8942
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9220
8943
|
};
|
|
9221
8944
|
/**
|
|
9222
8945
|
* Unique identifier of the component within the composition.
|
|
@@ -9227,20 +8950,20 @@ interface components$b {
|
|
|
9227
8950
|
_id?: string;
|
|
9228
8951
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
9229
8952
|
_pattern?: string;
|
|
9230
|
-
_dataResources?: components$
|
|
8953
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9231
8954
|
/**
|
|
9232
8955
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9233
8956
|
* Means nothing for PUTs; it will be ignored
|
|
9234
8957
|
*/
|
|
9235
8958
|
_patternDataResources?: {
|
|
9236
|
-
[key: string]: components$
|
|
8959
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9237
8960
|
};
|
|
9238
8961
|
/**
|
|
9239
8962
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9240
8963
|
* Means nothing for PUTs; it will be ignored
|
|
9241
8964
|
*/
|
|
9242
8965
|
_patternOptedInQueryStrings?: string[];
|
|
9243
|
-
_patternError?: components$
|
|
8966
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9244
8967
|
/**
|
|
9245
8968
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9246
8969
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9254,14 +8977,14 @@ interface components$b {
|
|
|
9254
8977
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9255
8978
|
*/
|
|
9256
8979
|
_overrides?: {
|
|
9257
|
-
[key: string]: components$
|
|
8980
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9258
8981
|
};
|
|
9259
8982
|
/**
|
|
9260
8983
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9261
8984
|
* Means nothing for PUTs; it will be ignored
|
|
9262
8985
|
*/
|
|
9263
8986
|
_patternOverrides?: {
|
|
9264
|
-
[key: string]: components$
|
|
8987
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9265
8988
|
};
|
|
9266
8989
|
/**
|
|
9267
8990
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9270,7 +8993,7 @@ interface components$b {
|
|
|
9270
8993
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9271
8994
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9272
8995
|
*/
|
|
9273
|
-
_overridability?: components$
|
|
8996
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9274
8997
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9275
8998
|
_locales?: string[];
|
|
9276
8999
|
};
|
|
@@ -9295,14 +9018,14 @@ interface components$b {
|
|
|
9295
9018
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9296
9019
|
*/
|
|
9297
9020
|
optionalPatternParameter?: boolean;
|
|
9298
|
-
variables?: components$
|
|
9021
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
9299
9022
|
};
|
|
9300
9023
|
/**
|
|
9301
9024
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9302
9025
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9303
9026
|
*/
|
|
9304
9027
|
DataResourceDefinitions: {
|
|
9305
|
-
[key: string]: components$
|
|
9028
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9306
9029
|
};
|
|
9307
9030
|
/**
|
|
9308
9031
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9320,10 +9043,10 @@ interface components$b {
|
|
|
9320
9043
|
*/
|
|
9321
9044
|
ComponentOverride: {
|
|
9322
9045
|
parameters?: {
|
|
9323
|
-
[key: string]: components$
|
|
9046
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9324
9047
|
};
|
|
9325
9048
|
slots?: {
|
|
9326
|
-
[key: string]: components$
|
|
9049
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9327
9050
|
};
|
|
9328
9051
|
variant?: string;
|
|
9329
9052
|
/**
|
|
@@ -9332,7 +9055,7 @@ interface components$b {
|
|
|
9332
9055
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9333
9056
|
*/
|
|
9334
9057
|
dataResources?: {
|
|
9335
|
-
[key: string]: components$
|
|
9058
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9336
9059
|
};
|
|
9337
9060
|
};
|
|
9338
9061
|
/**
|
|
@@ -9353,7 +9076,7 @@ interface components$b {
|
|
|
9353
9076
|
ComponentOverridability: {
|
|
9354
9077
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9355
9078
|
parameters?: {
|
|
9356
|
-
[key: string]: components$
|
|
9079
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
9357
9080
|
};
|
|
9358
9081
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9359
9082
|
variants?: boolean;
|
|
@@ -9370,15 +9093,15 @@ interface components$b {
|
|
|
9370
9093
|
type: string;
|
|
9371
9094
|
/** Component parameter values for the component instance */
|
|
9372
9095
|
parameters?: {
|
|
9373
|
-
[key: string]: components$
|
|
9096
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9374
9097
|
};
|
|
9375
9098
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9376
9099
|
variant?: string;
|
|
9377
9100
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9378
|
-
projectMapNodes?: components$
|
|
9101
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9379
9102
|
/** Slots containing any child components */
|
|
9380
9103
|
slots?: {
|
|
9381
|
-
[key: string]: components$
|
|
9104
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9382
9105
|
};
|
|
9383
9106
|
/** The ID of the composition */
|
|
9384
9107
|
_id: string;
|
|
@@ -9401,15 +9124,15 @@ interface components$b {
|
|
|
9401
9124
|
* Means nothing for PUTs; it will be ignored
|
|
9402
9125
|
*/
|
|
9403
9126
|
_patternDataResources?: {
|
|
9404
|
-
[key: string]: components$
|
|
9127
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9405
9128
|
};
|
|
9406
9129
|
/**
|
|
9407
9130
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9408
9131
|
* Means nothing for PUTs; it will be ignored
|
|
9409
9132
|
*/
|
|
9410
9133
|
_patternOptedInQueryStrings?: string[];
|
|
9411
|
-
_dataResources?: components$
|
|
9412
|
-
_patternError?: components$
|
|
9134
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9135
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9413
9136
|
/**
|
|
9414
9137
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9415
9138
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9423,14 +9146,14 @@ interface components$b {
|
|
|
9423
9146
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9424
9147
|
*/
|
|
9425
9148
|
_overrides?: {
|
|
9426
|
-
[key: string]: components$
|
|
9149
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9427
9150
|
};
|
|
9428
9151
|
/**
|
|
9429
9152
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9430
9153
|
* Means nothing for PUTs; it will be ignored
|
|
9431
9154
|
*/
|
|
9432
9155
|
_patternOverrides?: {
|
|
9433
|
-
[key: string]: components$
|
|
9156
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9434
9157
|
};
|
|
9435
9158
|
/**
|
|
9436
9159
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9439,7 +9162,7 @@ interface components$b {
|
|
|
9439
9162
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9440
9163
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9441
9164
|
*/
|
|
9442
|
-
_overridability?: components$
|
|
9165
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9443
9166
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9444
9167
|
_locales?: string[];
|
|
9445
9168
|
/**
|
|
@@ -9478,7 +9201,7 @@ interface components$b {
|
|
|
9478
9201
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9479
9202
|
*/
|
|
9480
9203
|
permissions: {
|
|
9481
|
-
[key: string]: components$
|
|
9204
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
9482
9205
|
};
|
|
9483
9206
|
};
|
|
9484
9207
|
/** Definition of a stage in a workflow */
|
|
@@ -9492,7 +9215,7 @@ interface components$b {
|
|
|
9492
9215
|
* listed here, the stage is read-only and publishing is disabled
|
|
9493
9216
|
*/
|
|
9494
9217
|
permissions: {
|
|
9495
|
-
[key: string]: components$
|
|
9218
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
9496
9219
|
};
|
|
9497
9220
|
/**
|
|
9498
9221
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -9512,7 +9235,7 @@ interface components$b {
|
|
|
9512
9235
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9513
9236
|
* has a stage that can never be escaped
|
|
9514
9237
|
*/
|
|
9515
|
-
transitions: components$
|
|
9238
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
9516
9239
|
/**
|
|
9517
9240
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9518
9241
|
* @defaultValue chevron-double-right-o
|
|
@@ -9537,7 +9260,7 @@ interface components$b {
|
|
|
9537
9260
|
initialStage: string;
|
|
9538
9261
|
/** All stages of the workflow */
|
|
9539
9262
|
stages: {
|
|
9540
|
-
[key: string]: components$
|
|
9263
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
9541
9264
|
};
|
|
9542
9265
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
9543
9266
|
modified?: string;
|
|
@@ -9585,6 +9308,8 @@ interface components$b {
|
|
|
9585
9308
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9586
9309
|
*/
|
|
9587
9310
|
deletedAt?: string;
|
|
9311
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
9312
|
+
publishedWhenTrashed?: boolean;
|
|
9588
9313
|
/** User name of the creator of this composition */
|
|
9589
9314
|
creator?: string;
|
|
9590
9315
|
/** User name of the last editor of this composition */
|
|
@@ -9610,7 +9335,7 @@ interface components$b {
|
|
|
9610
9335
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
9611
9336
|
*/
|
|
9612
9337
|
releaseId?: string;
|
|
9613
|
-
composition: components$
|
|
9338
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
9614
9339
|
/**
|
|
9615
9340
|
* Format: uuid
|
|
9616
9341
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9628,7 +9353,7 @@ interface components$b {
|
|
|
9628
9353
|
*/
|
|
9629
9354
|
instanceWorkflowId?: string;
|
|
9630
9355
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9631
|
-
workflowDefinition?: components$
|
|
9356
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9632
9357
|
/**
|
|
9633
9358
|
* Format: uuid
|
|
9634
9359
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9646,7 +9371,7 @@ interface components$b {
|
|
|
9646
9371
|
editionPriority?: number;
|
|
9647
9372
|
};
|
|
9648
9373
|
CompositionListResponse: {
|
|
9649
|
-
compositions: components$
|
|
9374
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
9650
9375
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
9651
9376
|
totalCount?: number;
|
|
9652
9377
|
/** Per-field counts for distinct values */
|
|
@@ -9707,10 +9432,10 @@ interface components$b {
|
|
|
9707
9432
|
RouteResponseRedirect: {
|
|
9708
9433
|
/** The route that was matched in the redirects */
|
|
9709
9434
|
matchedRoute: string;
|
|
9710
|
-
dynamicInputs?: components$
|
|
9435
|
+
dynamicInputs?: components$c["schemas"]["RouteDynamicInputs"];
|
|
9711
9436
|
/** @enum {string} */
|
|
9712
9437
|
type: "redirect";
|
|
9713
|
-
redirect: components$
|
|
9438
|
+
redirect: components$c["schemas"]["Redirect"];
|
|
9714
9439
|
};
|
|
9715
9440
|
/**
|
|
9716
9441
|
* The route does not match any configured redirections or compositions.
|
|
@@ -9750,15 +9475,15 @@ interface components$b {
|
|
|
9750
9475
|
_locales?: string[];
|
|
9751
9476
|
/** Entry field values */
|
|
9752
9477
|
fields?: {
|
|
9753
|
-
[key: string]: components$
|
|
9478
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9754
9479
|
};
|
|
9755
|
-
_dataResources?: components$
|
|
9480
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9756
9481
|
/**
|
|
9757
9482
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9758
9483
|
* Means nothing for PUTs; it will be ignored
|
|
9759
9484
|
*/
|
|
9760
9485
|
_patternDataResources?: {
|
|
9761
|
-
[key: string]: components$
|
|
9486
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9762
9487
|
};
|
|
9763
9488
|
/**
|
|
9764
9489
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9781,7 +9506,7 @@ interface components$b {
|
|
|
9781
9506
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9782
9507
|
*/
|
|
9783
9508
|
_overrides?: {
|
|
9784
|
-
[key: string]: components$
|
|
9509
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9785
9510
|
};
|
|
9786
9511
|
/**
|
|
9787
9512
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9790,7 +9515,7 @@ interface components$b {
|
|
|
9790
9515
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9791
9516
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9792
9517
|
*/
|
|
9793
|
-
_overridability?: components$
|
|
9518
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9794
9519
|
};
|
|
9795
9520
|
EntryApiResponse: {
|
|
9796
9521
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -9826,12 +9551,14 @@ interface components$b {
|
|
|
9826
9551
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9827
9552
|
*/
|
|
9828
9553
|
deletedAt?: string;
|
|
9554
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
9555
|
+
publishedWhenTrashed?: boolean;
|
|
9829
9556
|
/**
|
|
9830
9557
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
9831
9558
|
* @defaultValue false
|
|
9832
9559
|
*/
|
|
9833
9560
|
pattern?: boolean;
|
|
9834
|
-
entry: components$
|
|
9561
|
+
entry: components$c["schemas"]["Entry"];
|
|
9835
9562
|
/**
|
|
9836
9563
|
* Format: uuid
|
|
9837
9564
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -9849,7 +9576,7 @@ interface components$b {
|
|
|
9849
9576
|
*/
|
|
9850
9577
|
instanceWorkflowId?: string;
|
|
9851
9578
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
9852
|
-
workflowDefinition?: components$
|
|
9579
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9853
9580
|
/**
|
|
9854
9581
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
9855
9582
|
|
|
@@ -9872,7 +9599,7 @@ interface components$b {
|
|
|
9872
9599
|
editionPriority?: number;
|
|
9873
9600
|
};
|
|
9874
9601
|
EntryListResponse: {
|
|
9875
|
-
entries: components$
|
|
9602
|
+
entries: components$c["schemas"]["EntryApiResponse"][];
|
|
9876
9603
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
9877
9604
|
totalCount?: number;
|
|
9878
9605
|
/** Per-field counts for distinct values */
|
|
@@ -9890,7 +9617,7 @@ interface components$b {
|
|
|
9890
9617
|
[name: string]: unknown;
|
|
9891
9618
|
};
|
|
9892
9619
|
content: {
|
|
9893
|
-
"application/json": components$
|
|
9620
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9894
9621
|
};
|
|
9895
9622
|
};
|
|
9896
9623
|
/** Provided token or API key does not have access to the requested resource */
|
|
@@ -9899,7 +9626,7 @@ interface components$b {
|
|
|
9899
9626
|
[name: string]: unknown;
|
|
9900
9627
|
};
|
|
9901
9628
|
content: {
|
|
9902
|
-
"application/json": components$
|
|
9629
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9903
9630
|
};
|
|
9904
9631
|
};
|
|
9905
9632
|
/** Provided token or API key does not allow this action */
|
|
@@ -9908,7 +9635,7 @@ interface components$b {
|
|
|
9908
9635
|
[name: string]: unknown;
|
|
9909
9636
|
};
|
|
9910
9637
|
content: {
|
|
9911
|
-
"application/json": components$
|
|
9638
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9912
9639
|
};
|
|
9913
9640
|
};
|
|
9914
9641
|
/** The requested resource does not exist */
|
|
@@ -9917,7 +9644,7 @@ interface components$b {
|
|
|
9917
9644
|
[name: string]: unknown;
|
|
9918
9645
|
};
|
|
9919
9646
|
content: {
|
|
9920
|
-
"application/json": components$
|
|
9647
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9921
9648
|
};
|
|
9922
9649
|
};
|
|
9923
9650
|
/** Invalid method was used to call the endpoint */
|
|
@@ -9926,7 +9653,7 @@ interface components$b {
|
|
|
9926
9653
|
[name: string]: unknown;
|
|
9927
9654
|
};
|
|
9928
9655
|
content: {
|
|
9929
|
-
"application/json": components$
|
|
9656
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9930
9657
|
};
|
|
9931
9658
|
};
|
|
9932
9659
|
/** The request body could not be parsed or understood */
|
|
@@ -9935,7 +9662,7 @@ interface components$b {
|
|
|
9935
9662
|
[name: string]: unknown;
|
|
9936
9663
|
};
|
|
9937
9664
|
content: {
|
|
9938
|
-
"application/json": components$
|
|
9665
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9939
9666
|
};
|
|
9940
9667
|
};
|
|
9941
9668
|
/** The endpoint is called too often */
|
|
@@ -9944,7 +9671,7 @@ interface components$b {
|
|
|
9944
9671
|
[name: string]: unknown;
|
|
9945
9672
|
};
|
|
9946
9673
|
content: {
|
|
9947
|
-
"application/json": components$
|
|
9674
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9948
9675
|
};
|
|
9949
9676
|
};
|
|
9950
9677
|
/** An unexpected error occurred */
|
|
@@ -9953,7 +9680,7 @@ interface components$b {
|
|
|
9953
9680
|
[name: string]: unknown;
|
|
9954
9681
|
};
|
|
9955
9682
|
content: {
|
|
9956
|
-
"application/json": components$
|
|
9683
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9957
9684
|
};
|
|
9958
9685
|
};
|
|
9959
9686
|
};
|
|
@@ -10263,7 +9990,7 @@ interface components$b {
|
|
|
10263
9990
|
pathItems: never;
|
|
10264
9991
|
}
|
|
10265
9992
|
|
|
10266
|
-
interface paths$
|
|
9993
|
+
interface paths$b {
|
|
10267
9994
|
"/api/v1/route": {
|
|
10268
9995
|
parameters: {
|
|
10269
9996
|
query?: never;
|
|
@@ -10329,7 +10056,7 @@ interface paths$a {
|
|
|
10329
10056
|
parameters: {
|
|
10330
10057
|
query: {
|
|
10331
10058
|
/** The project to fetch a route from */
|
|
10332
|
-
projectId: components$
|
|
10059
|
+
projectId: components$b["parameters"]["projectId"];
|
|
10333
10060
|
/**
|
|
10334
10061
|
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10335
10062
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
@@ -10360,21 +10087,21 @@ interface paths$a {
|
|
|
10360
10087
|
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10361
10088
|
* project map node or redirect would match them.
|
|
10362
10089
|
*/
|
|
10363
|
-
path: components$
|
|
10090
|
+
path: components$b["parameters"]["path"];
|
|
10364
10091
|
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10365
|
-
projectMapId?: components$
|
|
10092
|
+
projectMapId?: components$b["parameters"]["projectMapId"];
|
|
10366
10093
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10367
|
-
state?: components$
|
|
10094
|
+
state?: components$b["parameters"]["state"];
|
|
10368
10095
|
/**
|
|
10369
10096
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10370
10097
|
* If false, the `_id` will not be present in the API response
|
|
10371
10098
|
*/
|
|
10372
|
-
withComponentIDs?: components$
|
|
10099
|
+
withComponentIDs?: components$b["parameters"]["withComponentIDs"];
|
|
10373
10100
|
/**
|
|
10374
10101
|
* @deprecated
|
|
10375
10102
|
* Has no effect.
|
|
10376
10103
|
*/
|
|
10377
|
-
withContentSourceMap?: components$
|
|
10104
|
+
withContentSourceMap?: components$b["parameters"]["withContentSourceMap"];
|
|
10378
10105
|
/**
|
|
10379
10106
|
* One or more locales to localize the response to.
|
|
10380
10107
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
@@ -10391,7 +10118,7 @@ interface paths$a {
|
|
|
10391
10118
|
*
|
|
10392
10119
|
* When the result is a redirect, this parameter has no effect
|
|
10393
10120
|
*/
|
|
10394
|
-
locale?: components$
|
|
10121
|
+
locale?: components$b["parameters"]["locale"];
|
|
10395
10122
|
/**
|
|
10396
10123
|
* The ID of a release to fetch the content for.
|
|
10397
10124
|
*
|
|
@@ -10400,19 +10127,19 @@ interface paths$a {
|
|
|
10400
10127
|
*
|
|
10401
10128
|
* 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 null
|
|
10402
10129
|
*/
|
|
10403
|
-
releaseId?: components$
|
|
10130
|
+
releaseId?: components$b["parameters"]["releaseId"];
|
|
10404
10131
|
/**
|
|
10405
10132
|
* Indicates the data variant that was fetched for data resources.
|
|
10406
10133
|
* undefined: Data resources were resolved using published data from their data source
|
|
10407
10134
|
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
10408
10135
|
*/
|
|
10409
|
-
dataSourceVariant?: components$
|
|
10136
|
+
dataSourceVariant?: components$b["parameters"]["dataSourceVariant"];
|
|
10410
10137
|
/**
|
|
10411
10138
|
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
10412
10139
|
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
10413
10140
|
* that have redirects configured on their paths.
|
|
10414
10141
|
*/
|
|
10415
|
-
ignoreRedirects?: components$
|
|
10142
|
+
ignoreRedirects?: components$b["parameters"]["ignoreRedirects"];
|
|
10416
10143
|
};
|
|
10417
10144
|
header?: never;
|
|
10418
10145
|
path?: never;
|
|
@@ -10426,14 +10153,14 @@ interface paths$a {
|
|
|
10426
10153
|
[name: string]: unknown;
|
|
10427
10154
|
};
|
|
10428
10155
|
content: {
|
|
10429
|
-
"application/json": components$
|
|
10156
|
+
"application/json": components$b["schemas"]["RouteResponse"];
|
|
10430
10157
|
};
|
|
10431
10158
|
};
|
|
10432
|
-
400: components$
|
|
10433
|
-
401: components$
|
|
10434
|
-
403: components$
|
|
10435
|
-
429: components$
|
|
10436
|
-
500: components$
|
|
10159
|
+
400: components$b["responses"]["BadRequestError"];
|
|
10160
|
+
401: components$b["responses"]["UnauthorizedError"];
|
|
10161
|
+
403: components$b["responses"]["ForbiddenError"];
|
|
10162
|
+
429: components$b["responses"]["RateLimitError"];
|
|
10163
|
+
500: components$b["responses"]["InternalServerError"];
|
|
10437
10164
|
};
|
|
10438
10165
|
};
|
|
10439
10166
|
put?: never;
|
|
@@ -10463,7 +10190,7 @@ interface paths$a {
|
|
|
10463
10190
|
trace?: never;
|
|
10464
10191
|
};
|
|
10465
10192
|
}
|
|
10466
|
-
interface components$
|
|
10193
|
+
interface components$b {
|
|
10467
10194
|
schemas: {
|
|
10468
10195
|
RouteDynamicInputs: {
|
|
10469
10196
|
[key: string]: string;
|
|
@@ -10512,10 +10239,10 @@ interface components$a {
|
|
|
10512
10239
|
RouteResponseRedirect: {
|
|
10513
10240
|
/** The route that was matched in the redirects */
|
|
10514
10241
|
matchedRoute: string;
|
|
10515
|
-
dynamicInputs?: components$
|
|
10242
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10516
10243
|
/** @enum {string} */
|
|
10517
10244
|
type: "redirect";
|
|
10518
|
-
redirect: components$
|
|
10245
|
+
redirect: components$b["schemas"]["Redirect"];
|
|
10519
10246
|
};
|
|
10520
10247
|
/** Defines a connection to a dynamic token on a data resource */
|
|
10521
10248
|
DataElementConnectionDefinition: {
|
|
@@ -10581,11 +10308,11 @@ interface components$a {
|
|
|
10581
10308
|
|
|
10582
10309
|
*/
|
|
10583
10310
|
op?: "&" | "|";
|
|
10584
|
-
clauses: (components$
|
|
10311
|
+
clauses: (components$b["schemas"]["VisibilityCriteria"] | components$b["schemas"]["VisibilityCriteriaGroup"])[];
|
|
10585
10312
|
};
|
|
10586
10313
|
/** Defines a conditional value for a component parameter */
|
|
10587
10314
|
ComponentParameterConditionalValue: {
|
|
10588
|
-
when: components$
|
|
10315
|
+
when: components$b["schemas"]["VisibilityCriteriaGroup"];
|
|
10589
10316
|
/**
|
|
10590
10317
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
10591
10318
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -10607,7 +10334,7 @@ interface components$a {
|
|
|
10607
10334
|
*
|
|
10608
10335
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
10609
10336
|
*/
|
|
10610
|
-
ComponentParameterConditions: components$
|
|
10337
|
+
ComponentParameterConditions: components$b["schemas"]["ComponentParameterConditionalValue"][];
|
|
10611
10338
|
/** Defines an editable parameter on a component */
|
|
10612
10339
|
ComponentParameter: {
|
|
10613
10340
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -10615,7 +10342,7 @@ interface components$a {
|
|
|
10615
10342
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
10616
10343
|
type: string;
|
|
10617
10344
|
/** @deprecated */
|
|
10618
|
-
connectedData?: components$
|
|
10345
|
+
connectedData?: components$b["schemas"]["DataElementConnectionDefinition"];
|
|
10619
10346
|
/**
|
|
10620
10347
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
10621
10348
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -10623,10 +10350,10 @@ interface components$a {
|
|
|
10623
10350
|
locales?: {
|
|
10624
10351
|
[key: string]: unknown;
|
|
10625
10352
|
};
|
|
10626
|
-
conditions?: components$
|
|
10353
|
+
conditions?: components$b["schemas"]["ComponentParameterConditions"];
|
|
10627
10354
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
10628
10355
|
localesConditions?: {
|
|
10629
|
-
[key: string]: components$
|
|
10356
|
+
[key: string]: components$b["schemas"]["ComponentParameterConditions"];
|
|
10630
10357
|
};
|
|
10631
10358
|
};
|
|
10632
10359
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -10661,7 +10388,7 @@ interface components$a {
|
|
|
10661
10388
|
/** 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 */
|
|
10662
10389
|
isSearchHit?: boolean;
|
|
10663
10390
|
/** Query strings that are allowed to be passed to the node */
|
|
10664
|
-
queryStrings?: components$
|
|
10391
|
+
queryStrings?: components$b["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
10665
10392
|
/**
|
|
10666
10393
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
10667
10394
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -10686,7 +10413,7 @@ interface components$a {
|
|
|
10686
10413
|
* Unique identifier for the project map that this node belongs to
|
|
10687
10414
|
*/
|
|
10688
10415
|
projectMapId: string;
|
|
10689
|
-
data?: components$
|
|
10416
|
+
data?: components$b["schemas"]["ProjectMapNodeData"];
|
|
10690
10417
|
/**
|
|
10691
10418
|
* Locale-specific paths of the project map node.
|
|
10692
10419
|
* Keys are locale codes
|
|
@@ -10706,13 +10433,13 @@ interface components$a {
|
|
|
10706
10433
|
type: string;
|
|
10707
10434
|
/** Component parameter values for the component instance */
|
|
10708
10435
|
parameters?: {
|
|
10709
|
-
[key: string]: components$
|
|
10436
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10710
10437
|
};
|
|
10711
10438
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10712
10439
|
variant?: string;
|
|
10713
10440
|
/** Slots containing any child components */
|
|
10714
10441
|
slots?: {
|
|
10715
|
-
[key: string]: components$
|
|
10442
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10716
10443
|
};
|
|
10717
10444
|
/**
|
|
10718
10445
|
* Unique identifier of the component within the composition.
|
|
@@ -10723,20 +10450,20 @@ interface components$a {
|
|
|
10723
10450
|
_id?: string;
|
|
10724
10451
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10725
10452
|
_pattern?: string;
|
|
10726
|
-
_dataResources?: components$
|
|
10453
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10727
10454
|
/**
|
|
10728
10455
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10729
10456
|
* Means nothing for PUTs; it will be ignored
|
|
10730
10457
|
*/
|
|
10731
10458
|
_patternDataResources?: {
|
|
10732
|
-
[key: string]: components$
|
|
10459
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10733
10460
|
};
|
|
10734
10461
|
/**
|
|
10735
10462
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10736
10463
|
* Means nothing for PUTs; it will be ignored
|
|
10737
10464
|
*/
|
|
10738
10465
|
_patternOptedInQueryStrings?: string[];
|
|
10739
|
-
_patternError?: components$
|
|
10466
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10740
10467
|
/**
|
|
10741
10468
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10742
10469
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10750,14 +10477,14 @@ interface components$a {
|
|
|
10750
10477
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10751
10478
|
*/
|
|
10752
10479
|
_overrides?: {
|
|
10753
|
-
[key: string]: components$
|
|
10480
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10754
10481
|
};
|
|
10755
10482
|
/**
|
|
10756
10483
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10757
10484
|
* Means nothing for PUTs; it will be ignored
|
|
10758
10485
|
*/
|
|
10759
10486
|
_patternOverrides?: {
|
|
10760
|
-
[key: string]: components$
|
|
10487
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10761
10488
|
};
|
|
10762
10489
|
/**
|
|
10763
10490
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10766,7 +10493,7 @@ interface components$a {
|
|
|
10766
10493
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10767
10494
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10768
10495
|
*/
|
|
10769
|
-
_overridability?: components$
|
|
10496
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10770
10497
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
10771
10498
|
_locales?: string[];
|
|
10772
10499
|
};
|
|
@@ -10791,14 +10518,14 @@ interface components$a {
|
|
|
10791
10518
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
10792
10519
|
*/
|
|
10793
10520
|
optionalPatternParameter?: boolean;
|
|
10794
|
-
variables?: components$
|
|
10521
|
+
variables?: components$b["schemas"]["DataResourceVariables"];
|
|
10795
10522
|
};
|
|
10796
10523
|
/**
|
|
10797
10524
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
10798
10525
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
10799
10526
|
*/
|
|
10800
10527
|
DataResourceDefinitions: {
|
|
10801
|
-
[key: string]: components$
|
|
10528
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10802
10529
|
};
|
|
10803
10530
|
/**
|
|
10804
10531
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -10816,10 +10543,10 @@ interface components$a {
|
|
|
10816
10543
|
*/
|
|
10817
10544
|
ComponentOverride: {
|
|
10818
10545
|
parameters?: {
|
|
10819
|
-
[key: string]: components$
|
|
10546
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10820
10547
|
};
|
|
10821
10548
|
slots?: {
|
|
10822
|
-
[key: string]: components$
|
|
10549
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10823
10550
|
};
|
|
10824
10551
|
variant?: string;
|
|
10825
10552
|
/**
|
|
@@ -10828,7 +10555,7 @@ interface components$a {
|
|
|
10828
10555
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
10829
10556
|
*/
|
|
10830
10557
|
dataResources?: {
|
|
10831
|
-
[key: string]: components$
|
|
10558
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10832
10559
|
};
|
|
10833
10560
|
};
|
|
10834
10561
|
/**
|
|
@@ -10849,7 +10576,7 @@ interface components$a {
|
|
|
10849
10576
|
ComponentOverridability: {
|
|
10850
10577
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
10851
10578
|
parameters?: {
|
|
10852
|
-
[key: string]: components$
|
|
10579
|
+
[key: string]: components$b["schemas"]["OverrideOptions"];
|
|
10853
10580
|
};
|
|
10854
10581
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
10855
10582
|
variants?: boolean;
|
|
@@ -10866,15 +10593,15 @@ interface components$a {
|
|
|
10866
10593
|
type: string;
|
|
10867
10594
|
/** Component parameter values for the component instance */
|
|
10868
10595
|
parameters?: {
|
|
10869
|
-
[key: string]: components$
|
|
10596
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10870
10597
|
};
|
|
10871
10598
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10872
10599
|
variant?: string;
|
|
10873
10600
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
10874
|
-
projectMapNodes?: components$
|
|
10601
|
+
projectMapNodes?: components$b["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
10875
10602
|
/** Slots containing any child components */
|
|
10876
10603
|
slots?: {
|
|
10877
|
-
[key: string]: components$
|
|
10604
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10878
10605
|
};
|
|
10879
10606
|
/** The ID of the composition */
|
|
10880
10607
|
_id: string;
|
|
@@ -10897,15 +10624,15 @@ interface components$a {
|
|
|
10897
10624
|
* Means nothing for PUTs; it will be ignored
|
|
10898
10625
|
*/
|
|
10899
10626
|
_patternDataResources?: {
|
|
10900
|
-
[key: string]: components$
|
|
10627
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10901
10628
|
};
|
|
10902
10629
|
/**
|
|
10903
10630
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10904
10631
|
* Means nothing for PUTs; it will be ignored
|
|
10905
10632
|
*/
|
|
10906
10633
|
_patternOptedInQueryStrings?: string[];
|
|
10907
|
-
_dataResources?: components$
|
|
10908
|
-
_patternError?: components$
|
|
10634
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10635
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10909
10636
|
/**
|
|
10910
10637
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10911
10638
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10919,14 +10646,14 @@ interface components$a {
|
|
|
10919
10646
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10920
10647
|
*/
|
|
10921
10648
|
_overrides?: {
|
|
10922
|
-
[key: string]: components$
|
|
10649
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10923
10650
|
};
|
|
10924
10651
|
/**
|
|
10925
10652
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10926
10653
|
* Means nothing for PUTs; it will be ignored
|
|
10927
10654
|
*/
|
|
10928
10655
|
_patternOverrides?: {
|
|
10929
|
-
[key: string]: components$
|
|
10656
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10930
10657
|
};
|
|
10931
10658
|
/**
|
|
10932
10659
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10935,7 +10662,7 @@ interface components$a {
|
|
|
10935
10662
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10936
10663
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10937
10664
|
*/
|
|
10938
|
-
_overridability?: components$
|
|
10665
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10939
10666
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
10940
10667
|
_locales?: string[];
|
|
10941
10668
|
/**
|
|
@@ -10974,7 +10701,7 @@ interface components$a {
|
|
|
10974
10701
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
10975
10702
|
*/
|
|
10976
10703
|
permissions: {
|
|
10977
|
-
[key: string]: components$
|
|
10704
|
+
[key: string]: components$b["schemas"]["WorkflowStageTransitionPermission"];
|
|
10978
10705
|
};
|
|
10979
10706
|
};
|
|
10980
10707
|
/** Definition of a stage in a workflow */
|
|
@@ -10988,7 +10715,7 @@ interface components$a {
|
|
|
10988
10715
|
* listed here, the stage is read-only and publishing is disabled
|
|
10989
10716
|
*/
|
|
10990
10717
|
permissions: {
|
|
10991
|
-
[key: string]: components$
|
|
10718
|
+
[key: string]: components$b["schemas"]["WorkflowStagePermission"];
|
|
10992
10719
|
};
|
|
10993
10720
|
/**
|
|
10994
10721
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -11008,7 +10735,7 @@ interface components$a {
|
|
|
11008
10735
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
11009
10736
|
* has a stage that can never be escaped
|
|
11010
10737
|
*/
|
|
11011
|
-
transitions: components$
|
|
10738
|
+
transitions: components$b["schemas"]["WorkflowStageTransition"][];
|
|
11012
10739
|
/**
|
|
11013
10740
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
11014
10741
|
* @defaultValue chevron-double-right-o
|
|
@@ -11033,7 +10760,7 @@ interface components$a {
|
|
|
11033
10760
|
initialStage: string;
|
|
11034
10761
|
/** All stages of the workflow */
|
|
11035
10762
|
stages: {
|
|
11036
|
-
[key: string]: components$
|
|
10763
|
+
[key: string]: components$b["schemas"]["WorkflowStage"];
|
|
11037
10764
|
};
|
|
11038
10765
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
11039
10766
|
modified?: string;
|
|
@@ -11081,6 +10808,8 @@ interface components$a {
|
|
|
11081
10808
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
11082
10809
|
*/
|
|
11083
10810
|
deletedAt?: string;
|
|
10811
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
10812
|
+
publishedWhenTrashed?: boolean;
|
|
11084
10813
|
/** User name of the creator of this composition */
|
|
11085
10814
|
creator?: string;
|
|
11086
10815
|
/** User name of the last editor of this composition */
|
|
@@ -11106,7 +10835,7 @@ interface components$a {
|
|
|
11106
10835
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
11107
10836
|
*/
|
|
11108
10837
|
releaseId?: string;
|
|
11109
|
-
composition: components$
|
|
10838
|
+
composition: components$b["schemas"]["RootComponentInstance"];
|
|
11110
10839
|
/**
|
|
11111
10840
|
* Format: uuid
|
|
11112
10841
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -11124,7 +10853,7 @@ interface components$a {
|
|
|
11124
10853
|
*/
|
|
11125
10854
|
instanceWorkflowId?: string;
|
|
11126
10855
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
11127
|
-
workflowDefinition?: components$
|
|
10856
|
+
workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
|
|
11128
10857
|
/**
|
|
11129
10858
|
* Format: uuid
|
|
11130
10859
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -11141,35 +10870,393 @@ interface components$a {
|
|
|
11141
10870
|
*/
|
|
11142
10871
|
editionPriority?: number;
|
|
11143
10872
|
};
|
|
11144
|
-
/**
|
|
11145
|
-
* The route matches a composition.
|
|
11146
|
-
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
11147
|
-
*/
|
|
11148
|
-
RouteResponseComposition: {
|
|
11149
|
-
/** The route that was matched in the project map */
|
|
11150
|
-
matchedRoute: string;
|
|
11151
|
-
dynamicInputs?: components$
|
|
11152
|
-
/**
|
|
11153
|
-
* Indicates the data variant that was fetched for data resources.
|
|
11154
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
11155
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11156
|
-
|
|
11157
|
-
*/
|
|
11158
|
-
dataResourcesVariant?: "unpublished";
|
|
11159
|
-
/** @enum {string} */
|
|
11160
|
-
type: "composition";
|
|
11161
|
-
compositionApiResponse: components$
|
|
10873
|
+
/**
|
|
10874
|
+
* The route matches a composition.
|
|
10875
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
10876
|
+
*/
|
|
10877
|
+
RouteResponseComposition: {
|
|
10878
|
+
/** The route that was matched in the project map */
|
|
10879
|
+
matchedRoute: string;
|
|
10880
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10881
|
+
/**
|
|
10882
|
+
* Indicates the data variant that was fetched for data resources.
|
|
10883
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
10884
|
+
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
10885
|
+
|
|
10886
|
+
*/
|
|
10887
|
+
dataResourcesVariant?: "unpublished";
|
|
10888
|
+
/** @enum {string} */
|
|
10889
|
+
type: "composition";
|
|
10890
|
+
compositionApiResponse: components$b["schemas"]["CompositionApiResponse"];
|
|
10891
|
+
};
|
|
10892
|
+
/**
|
|
10893
|
+
* The route does not match any configured redirections or compositions.
|
|
10894
|
+
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
10895
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
10896
|
+
*/
|
|
10897
|
+
RouteResponseNotFound: {
|
|
10898
|
+
/** @enum {string} */
|
|
10899
|
+
type: "notFound";
|
|
10900
|
+
};
|
|
10901
|
+
RouteResponse: components$b["schemas"]["RouteResponseRedirect"] | components$b["schemas"]["RouteResponseComposition"] | components$b["schemas"]["RouteResponseNotFound"];
|
|
10902
|
+
Error: {
|
|
10903
|
+
/** Error message(s) that occurred while processing the request */
|
|
10904
|
+
errorMessage?: string[] | string;
|
|
10905
|
+
};
|
|
10906
|
+
};
|
|
10907
|
+
responses: {
|
|
10908
|
+
/** Request input validation failed */
|
|
10909
|
+
BadRequestError: {
|
|
10910
|
+
headers: {
|
|
10911
|
+
[name: string]: unknown;
|
|
10912
|
+
};
|
|
10913
|
+
content: {
|
|
10914
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10915
|
+
};
|
|
10916
|
+
};
|
|
10917
|
+
/** API key or token was not valid */
|
|
10918
|
+
UnauthorizedError: {
|
|
10919
|
+
headers: {
|
|
10920
|
+
[name: string]: unknown;
|
|
10921
|
+
};
|
|
10922
|
+
content: {
|
|
10923
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10924
|
+
};
|
|
10925
|
+
};
|
|
10926
|
+
/** Permission was denied */
|
|
10927
|
+
ForbiddenError: {
|
|
10928
|
+
headers: {
|
|
10929
|
+
[name: string]: unknown;
|
|
10930
|
+
};
|
|
10931
|
+
content: {
|
|
10932
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10933
|
+
};
|
|
10934
|
+
};
|
|
10935
|
+
/** Too many requests in allowed time period */
|
|
10936
|
+
RateLimitError: {
|
|
10937
|
+
headers: {
|
|
10938
|
+
[name: string]: unknown;
|
|
10939
|
+
};
|
|
10940
|
+
content?: never;
|
|
10941
|
+
};
|
|
10942
|
+
/** Execution error occurred */
|
|
10943
|
+
InternalServerError: {
|
|
10944
|
+
headers: {
|
|
10945
|
+
[name: string]: unknown;
|
|
10946
|
+
};
|
|
10947
|
+
content?: never;
|
|
10948
|
+
};
|
|
10949
|
+
};
|
|
10950
|
+
parameters: {
|
|
10951
|
+
/** The project to fetch a route from */
|
|
10952
|
+
projectId: string;
|
|
10953
|
+
/**
|
|
10954
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10955
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
10956
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
10957
|
+
* be returned as as dynamic inputs to the composition.
|
|
10958
|
+
*
|
|
10959
|
+
* Examples:
|
|
10960
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
10961
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
10962
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
|
10963
|
+
*
|
|
10964
|
+
* Conflict resolution:
|
|
10965
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
10966
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
|
10967
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
10968
|
+
* * The route with the most path segments wins
|
|
10969
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
10970
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10971
|
+
*
|
|
10972
|
+
* Invalid paths:
|
|
10973
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes:
|
|
10974
|
+
* * contains consecutive slashes (for example "/en//about" or "//en/about")
|
|
10975
|
+
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10976
|
+
* and is generally 150-220 characters per segment.
|
|
10977
|
+
*
|
|
10978
|
+
* Probe paths:
|
|
10979
|
+
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10980
|
+
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10981
|
+
* project map node or redirect would match them.
|
|
10982
|
+
*/
|
|
10983
|
+
path: string;
|
|
10984
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10985
|
+
projectMapId: string;
|
|
10986
|
+
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10987
|
+
state: number;
|
|
10988
|
+
/**
|
|
10989
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10990
|
+
* If false, the `_id` will not be present in the API response
|
|
10991
|
+
*/
|
|
10992
|
+
withComponentIDs: boolean;
|
|
10993
|
+
/**
|
|
10994
|
+
* @deprecated
|
|
10995
|
+
* Has no effect.
|
|
10996
|
+
*/
|
|
10997
|
+
withContentSourceMap: boolean;
|
|
10998
|
+
/**
|
|
10999
|
+
* One or more locales to localize the response to.
|
|
11000
|
+
* When the result is a composition, it includes only the first matching locale's data.
|
|
11001
|
+
* If no matching locale is found, the response will be a not-found result.
|
|
11002
|
+
*
|
|
11003
|
+
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
11004
|
+
* en-US
|
|
11005
|
+
* fr-CA,fr
|
|
11006
|
+
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
11007
|
+
*
|
|
11008
|
+
* When this parameter is not passed:
|
|
11009
|
+
* - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
|
|
11010
|
+
* - Otherwise, all locales' data is returned.
|
|
11011
|
+
*
|
|
11012
|
+
* When the result is a redirect, this parameter has no effect
|
|
11013
|
+
*/
|
|
11014
|
+
locale: string;
|
|
11015
|
+
/**
|
|
11016
|
+
* The ID of a release to fetch the content for.
|
|
11017
|
+
*
|
|
11018
|
+
* - When unspecified, all release content is excluded from the result(s).
|
|
11019
|
+
* - 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.
|
|
11020
|
+
*
|
|
11021
|
+
* 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 null
|
|
11022
|
+
*/
|
|
11023
|
+
releaseId: string;
|
|
11024
|
+
/**
|
|
11025
|
+
* Indicates the data variant that was fetched for data resources.
|
|
11026
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
11027
|
+
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11028
|
+
*/
|
|
11029
|
+
dataSourceVariant: "unpublished";
|
|
11030
|
+
/**
|
|
11031
|
+
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11032
|
+
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11033
|
+
* that have redirects configured on their paths.
|
|
11034
|
+
*/
|
|
11035
|
+
ignoreRedirects: boolean;
|
|
11036
|
+
};
|
|
11037
|
+
requestBodies: never;
|
|
11038
|
+
headers: never;
|
|
11039
|
+
pathItems: never;
|
|
11040
|
+
}
|
|
11041
|
+
|
|
11042
|
+
interface paths$a {
|
|
11043
|
+
"/api/v1/views": {
|
|
11044
|
+
parameters: {
|
|
11045
|
+
query?: never;
|
|
11046
|
+
header?: never;
|
|
11047
|
+
path?: never;
|
|
11048
|
+
cookie?: never;
|
|
11049
|
+
};
|
|
11050
|
+
/** Lists saved views for a project + resource type. */
|
|
11051
|
+
get: {
|
|
11052
|
+
parameters: {
|
|
11053
|
+
query: {
|
|
11054
|
+
/** Project the views belong to. */
|
|
11055
|
+
projectId: string;
|
|
11056
|
+
/** Resource type these views apply to (e.g. "entry"). */
|
|
11057
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11058
|
+
/** Number of records to skip. */
|
|
11059
|
+
offset?: number | null;
|
|
11060
|
+
/** Maximum number of records to return. */
|
|
11061
|
+
limit?: number;
|
|
11062
|
+
};
|
|
11063
|
+
header?: never;
|
|
11064
|
+
path?: never;
|
|
11065
|
+
cookie?: never;
|
|
11066
|
+
};
|
|
11067
|
+
requestBody?: never;
|
|
11068
|
+
responses: {
|
|
11069
|
+
/** OK */
|
|
11070
|
+
200: {
|
|
11071
|
+
headers: {
|
|
11072
|
+
[name: string]: unknown;
|
|
11073
|
+
};
|
|
11074
|
+
content: {
|
|
11075
|
+
"application/json": {
|
|
11076
|
+
views: {
|
|
11077
|
+
name: string;
|
|
11078
|
+
description?: string;
|
|
11079
|
+
searchTerm?: string;
|
|
11080
|
+
filters: {
|
|
11081
|
+
field: string;
|
|
11082
|
+
dynamicField?: string;
|
|
11083
|
+
operator: string;
|
|
11084
|
+
value: string | string[];
|
|
11085
|
+
}[];
|
|
11086
|
+
sort?: string[];
|
|
11087
|
+
shared: boolean;
|
|
11088
|
+
icon?: string;
|
|
11089
|
+
id: string;
|
|
11090
|
+
projectId: string;
|
|
11091
|
+
/** @enum {string} */
|
|
11092
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11093
|
+
createdBy: string | null;
|
|
11094
|
+
/** Format: date-time */
|
|
11095
|
+
created: string;
|
|
11096
|
+
/** Format: date-time */
|
|
11097
|
+
modified: string;
|
|
11098
|
+
}[];
|
|
11099
|
+
totalCount: number;
|
|
11100
|
+
};
|
|
11101
|
+
};
|
|
11102
|
+
};
|
|
11103
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11104
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11105
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11106
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11107
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11108
|
+
};
|
|
11109
|
+
};
|
|
11110
|
+
/** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `projectId` and `resourceType` are immutable after create. */
|
|
11111
|
+
put: {
|
|
11112
|
+
parameters: {
|
|
11113
|
+
query?: never;
|
|
11114
|
+
header?: never;
|
|
11115
|
+
path?: never;
|
|
11116
|
+
cookie?: never;
|
|
11117
|
+
};
|
|
11118
|
+
requestBody: {
|
|
11119
|
+
content: {
|
|
11120
|
+
"application/json": {
|
|
11121
|
+
name: string;
|
|
11122
|
+
description?: string;
|
|
11123
|
+
searchTerm?: string;
|
|
11124
|
+
filters: {
|
|
11125
|
+
field: string;
|
|
11126
|
+
dynamicField?: string;
|
|
11127
|
+
operator: string;
|
|
11128
|
+
value: string | string[];
|
|
11129
|
+
}[];
|
|
11130
|
+
sort?: string[];
|
|
11131
|
+
shared: boolean;
|
|
11132
|
+
icon?: string;
|
|
11133
|
+
id: string;
|
|
11134
|
+
projectId: string;
|
|
11135
|
+
/** @enum {string} */
|
|
11136
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11137
|
+
};
|
|
11138
|
+
};
|
|
11139
|
+
};
|
|
11140
|
+
responses: {
|
|
11141
|
+
/** OK */
|
|
11142
|
+
200: {
|
|
11143
|
+
headers: {
|
|
11144
|
+
[name: string]: unknown;
|
|
11145
|
+
};
|
|
11146
|
+
content: {
|
|
11147
|
+
"application/json": {
|
|
11148
|
+
name: string;
|
|
11149
|
+
description?: string;
|
|
11150
|
+
searchTerm?: string;
|
|
11151
|
+
filters: {
|
|
11152
|
+
field: string;
|
|
11153
|
+
dynamicField?: string;
|
|
11154
|
+
operator: string;
|
|
11155
|
+
value: string | string[];
|
|
11156
|
+
}[];
|
|
11157
|
+
sort?: string[];
|
|
11158
|
+
shared: boolean;
|
|
11159
|
+
icon?: string;
|
|
11160
|
+
id: string;
|
|
11161
|
+
projectId: string;
|
|
11162
|
+
/** @enum {string} */
|
|
11163
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11164
|
+
createdBy: string | null;
|
|
11165
|
+
/** Format: date-time */
|
|
11166
|
+
created: string;
|
|
11167
|
+
/** Format: date-time */
|
|
11168
|
+
modified: string;
|
|
11169
|
+
};
|
|
11170
|
+
};
|
|
11171
|
+
};
|
|
11172
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11173
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11174
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11175
|
+
/** View not found (or belongs to another project). */
|
|
11176
|
+
404: {
|
|
11177
|
+
headers: {
|
|
11178
|
+
[name: string]: unknown;
|
|
11179
|
+
};
|
|
11180
|
+
content?: never;
|
|
11181
|
+
};
|
|
11182
|
+
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
11183
|
+
409: {
|
|
11184
|
+
headers: {
|
|
11185
|
+
[name: string]: unknown;
|
|
11186
|
+
};
|
|
11187
|
+
content?: never;
|
|
11188
|
+
};
|
|
11189
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11190
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11191
|
+
};
|
|
11192
|
+
};
|
|
11193
|
+
post?: never;
|
|
11194
|
+
/** Deletes a saved view by id. */
|
|
11195
|
+
delete: {
|
|
11196
|
+
parameters: {
|
|
11197
|
+
query?: never;
|
|
11198
|
+
header?: never;
|
|
11199
|
+
path?: never;
|
|
11200
|
+
cookie?: never;
|
|
11201
|
+
};
|
|
11202
|
+
requestBody: {
|
|
11203
|
+
content: {
|
|
11204
|
+
"application/json": {
|
|
11205
|
+
id: string;
|
|
11206
|
+
projectId: string;
|
|
11207
|
+
};
|
|
11208
|
+
};
|
|
11209
|
+
};
|
|
11210
|
+
responses: {
|
|
11211
|
+
/** No Content */
|
|
11212
|
+
204: {
|
|
11213
|
+
headers: {
|
|
11214
|
+
[name: string]: unknown;
|
|
11215
|
+
};
|
|
11216
|
+
content: {
|
|
11217
|
+
"application/json": string;
|
|
11218
|
+
};
|
|
11219
|
+
};
|
|
11220
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11221
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11222
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11223
|
+
/** View not found. */
|
|
11224
|
+
404: {
|
|
11225
|
+
headers: {
|
|
11226
|
+
[name: string]: unknown;
|
|
11227
|
+
};
|
|
11228
|
+
content?: never;
|
|
11229
|
+
};
|
|
11230
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11231
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11232
|
+
};
|
|
11162
11233
|
};
|
|
11163
|
-
/**
|
|
11164
|
-
|
|
11165
|
-
|
|
11166
|
-
|
|
11167
|
-
|
|
11168
|
-
|
|
11169
|
-
|
|
11170
|
-
|
|
11234
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
11235
|
+
options: {
|
|
11236
|
+
parameters: {
|
|
11237
|
+
query?: never;
|
|
11238
|
+
header?: never;
|
|
11239
|
+
path?: never;
|
|
11240
|
+
cookie?: never;
|
|
11241
|
+
};
|
|
11242
|
+
requestBody?: never;
|
|
11243
|
+
responses: {
|
|
11244
|
+
/** ok */
|
|
11245
|
+
204: {
|
|
11246
|
+
headers: {
|
|
11247
|
+
[name: string]: unknown;
|
|
11248
|
+
};
|
|
11249
|
+
content?: never;
|
|
11250
|
+
};
|
|
11251
|
+
};
|
|
11171
11252
|
};
|
|
11172
|
-
|
|
11253
|
+
head?: never;
|
|
11254
|
+
patch?: never;
|
|
11255
|
+
trace?: never;
|
|
11256
|
+
};
|
|
11257
|
+
}
|
|
11258
|
+
interface components$a {
|
|
11259
|
+
schemas: {
|
|
11173
11260
|
Error: {
|
|
11174
11261
|
/** Error message(s) that occurred while processing the request */
|
|
11175
11262
|
errorMessage?: string[] | string;
|
|
@@ -11218,102 +11305,28 @@ interface components$a {
|
|
|
11218
11305
|
content?: never;
|
|
11219
11306
|
};
|
|
11220
11307
|
};
|
|
11221
|
-
parameters:
|
|
11222
|
-
/** The project to fetch a route from */
|
|
11223
|
-
projectId: string;
|
|
11224
|
-
/**
|
|
11225
|
-
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
11226
|
-
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
11227
|
-
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
11228
|
-
* be returned as as dynamic inputs to the composition.
|
|
11229
|
-
*
|
|
11230
|
-
* Examples:
|
|
11231
|
-
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
11232
|
-
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
11233
|
-
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
|
11234
|
-
*
|
|
11235
|
-
* Conflict resolution:
|
|
11236
|
-
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
11237
|
-
* * If a redirect matches, it wins over project map nodes in all cases
|
|
11238
|
-
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
11239
|
-
* * The route with the most path segments wins
|
|
11240
|
-
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
11241
|
-
* * If still ambiguous, the first matching route arbitrarily wins
|
|
11242
|
-
*
|
|
11243
|
-
* Invalid paths:
|
|
11244
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes:
|
|
11245
|
-
* * contains consecutive slashes (for example "/en//about" or "//en/about")
|
|
11246
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
11247
|
-
* and is generally 150-220 characters per segment.
|
|
11248
|
-
*
|
|
11249
|
-
* Probe paths:
|
|
11250
|
-
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
11251
|
-
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
11252
|
-
* project map node or redirect would match them.
|
|
11253
|
-
*/
|
|
11254
|
-
path: string;
|
|
11255
|
-
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
11256
|
-
projectMapId: string;
|
|
11257
|
-
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
11258
|
-
state: number;
|
|
11259
|
-
/**
|
|
11260
|
-
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
11261
|
-
* If false, the `_id` will not be present in the API response
|
|
11262
|
-
*/
|
|
11263
|
-
withComponentIDs: boolean;
|
|
11264
|
-
/**
|
|
11265
|
-
* @deprecated
|
|
11266
|
-
* Has no effect.
|
|
11267
|
-
*/
|
|
11268
|
-
withContentSourceMap: boolean;
|
|
11269
|
-
/**
|
|
11270
|
-
* One or more locales to localize the response to.
|
|
11271
|
-
* When the result is a composition, it includes only the first matching locale's data.
|
|
11272
|
-
* If no matching locale is found, the response will be a not-found result.
|
|
11273
|
-
*
|
|
11274
|
-
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
11275
|
-
* en-US
|
|
11276
|
-
* fr-CA,fr
|
|
11277
|
-
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
11278
|
-
*
|
|
11279
|
-
* When this parameter is not passed:
|
|
11280
|
-
* - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
|
|
11281
|
-
* - Otherwise, all locales' data is returned.
|
|
11282
|
-
*
|
|
11283
|
-
* When the result is a redirect, this parameter has no effect
|
|
11284
|
-
*/
|
|
11285
|
-
locale: string;
|
|
11286
|
-
/**
|
|
11287
|
-
* The ID of a release to fetch the content for.
|
|
11288
|
-
*
|
|
11289
|
-
* - When unspecified, all release content is excluded from the result(s).
|
|
11290
|
-
* - 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.
|
|
11291
|
-
*
|
|
11292
|
-
* 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 null
|
|
11293
|
-
*/
|
|
11294
|
-
releaseId: string;
|
|
11295
|
-
/**
|
|
11296
|
-
* Indicates the data variant that was fetched for data resources.
|
|
11297
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
11298
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11299
|
-
*/
|
|
11300
|
-
dataSourceVariant: "unpublished";
|
|
11301
|
-
/**
|
|
11302
|
-
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11303
|
-
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11304
|
-
* that have redirects configured on their paths.
|
|
11305
|
-
*/
|
|
11306
|
-
ignoreRedirects: boolean;
|
|
11307
|
-
};
|
|
11308
|
+
parameters: never;
|
|
11308
11309
|
requestBodies: never;
|
|
11309
11310
|
headers: never;
|
|
11310
11311
|
pathItems: never;
|
|
11311
11312
|
}
|
|
11312
11313
|
|
|
11313
|
-
type
|
|
11314
|
+
type ViewsApi = paths$a['/api/v1/views'];
|
|
11315
|
+
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
11316
|
+
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
11317
|
+
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
11318
|
+
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
11319
|
+
type View = ViewsResponse['views'][number];
|
|
11320
|
+
/**
|
|
11321
|
+
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
11322
|
+
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
11323
|
+
*/
|
|
11324
|
+
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
11325
|
+
|
|
11326
|
+
type Components = components$e['schemas'];
|
|
11314
11327
|
type SharedComponents$1 = components$r['schemas'];
|
|
11315
|
-
type Api = paths$
|
|
11316
|
-
type HistoryApi = paths$
|
|
11328
|
+
type Api = paths$d['/api/v1/canvas'];
|
|
11329
|
+
type HistoryApi = paths$c['/api/v1/canvas-history'];
|
|
11317
11330
|
/** Query parameter options for GET /api/v1/canvas */
|
|
11318
11331
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
11319
11332
|
type?: string | string[];
|
|
@@ -11432,6 +11445,37 @@ type CopiedComponentSubtree = {
|
|
|
11432
11445
|
* Defines how a component on a pattern may have its values overridden
|
|
11433
11446
|
*/
|
|
11434
11447
|
type ComponentOverridability = SharedComponents$1['ComponentOverridability'];
|
|
11448
|
+
interface EndpointOut {
|
|
11449
|
+
channels?: string[] | null;
|
|
11450
|
+
createdAt: Date;
|
|
11451
|
+
description: string;
|
|
11452
|
+
disabled?: boolean;
|
|
11453
|
+
filterTypes?: string[] | null;
|
|
11454
|
+
id: string;
|
|
11455
|
+
metadata: {
|
|
11456
|
+
[key: string]: string;
|
|
11457
|
+
};
|
|
11458
|
+
rateLimit?: number | null;
|
|
11459
|
+
throttleRate?: number | null;
|
|
11460
|
+
uid?: string | null;
|
|
11461
|
+
updatedAt: Date;
|
|
11462
|
+
url: string;
|
|
11463
|
+
version: number;
|
|
11464
|
+
}
|
|
11465
|
+
interface EndpointHeadersOut {
|
|
11466
|
+
headers: {
|
|
11467
|
+
[key: string]: string;
|
|
11468
|
+
};
|
|
11469
|
+
sensitive: string[];
|
|
11470
|
+
}
|
|
11471
|
+
interface EndpointTransformationOut {
|
|
11472
|
+
code?: string | null;
|
|
11473
|
+
enabled?: boolean;
|
|
11474
|
+
updatedAt?: Date | null;
|
|
11475
|
+
variables?: {
|
|
11476
|
+
[key: string]: string;
|
|
11477
|
+
} | null;
|
|
11478
|
+
}
|
|
11435
11479
|
/**
|
|
11436
11480
|
* Defines the shape of serialized webhook
|
|
11437
11481
|
*/
|
|
@@ -11502,7 +11546,7 @@ type DataResolutionParameters = {
|
|
|
11502
11546
|
};
|
|
11503
11547
|
/** Types of issue that can occur when fetching composition data */
|
|
11504
11548
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
11505
|
-
type DataResolutionIssueCore = components$
|
|
11549
|
+
type DataResolutionIssueCore = components$c['schemas']['DataResolutionIssue'];
|
|
11506
11550
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
11507
11551
|
type PatternIssue = DataResolutionIssueCore & {
|
|
11508
11552
|
type: 'pattern';
|
|
@@ -11556,26 +11600,26 @@ type DataResolutionConfigIssue = {
|
|
|
11556
11600
|
type: 'config';
|
|
11557
11601
|
};
|
|
11558
11602
|
/** Diagnostics about edge request processing */
|
|
11559
|
-
type EdgehancersDiagnostics = components$
|
|
11560
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
11603
|
+
type EdgehancersDiagnostics = components$c['schemas']['EdgehancersDiagnostics'];
|
|
11604
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$c['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
11561
11605
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
11562
|
-
type DataDiagnostic = components$
|
|
11606
|
+
type DataDiagnostic = components$c['schemas']['DataDiagnostic'];
|
|
11563
11607
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
11564
|
-
type CompositionResolvedGetResponse = components$
|
|
11565
|
-
type CompositionResolvedListResponse = components$
|
|
11608
|
+
type CompositionResolvedGetResponse = components$c['schemas']['CompositionResolvedGetResponse'];
|
|
11609
|
+
type CompositionResolvedListResponse = components$c['schemas']['CompositionResolvedListResponse'];
|
|
11566
11610
|
/** All valid response types */
|
|
11567
11611
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
11568
11612
|
/** The GET response from /api/v1/route */
|
|
11569
|
-
type RouteGetParameters = paths$
|
|
11570
|
-
type RouteGetResponse = components$
|
|
11571
|
-
type RouteGetResponseComposition = components$
|
|
11572
|
-
type RouteGetResponseRedirect = components$
|
|
11573
|
-
type RouteGetResponseNotFound = components$
|
|
11574
|
-
type RouteDynamicInputs = components$
|
|
11613
|
+
type RouteGetParameters = paths$b['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11614
|
+
type RouteGetResponse = components$f['schemas']['RouteResponse'];
|
|
11615
|
+
type RouteGetResponseComposition = components$f['schemas']['RouteResponseComposition'];
|
|
11616
|
+
type RouteGetResponseRedirect = components$f['schemas']['RouteResponseRedirect'];
|
|
11617
|
+
type RouteGetResponseNotFound = components$f['schemas']['RouteResponseNotFound'];
|
|
11618
|
+
type RouteDynamicInputs = components$f['schemas']['RouteDynamicInputs'];
|
|
11575
11619
|
/** The GET response from /api/v1/entries */
|
|
11576
11620
|
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11577
11621
|
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11578
|
-
type EntriesResolvedListResponse = components$
|
|
11622
|
+
type EntriesResolvedListResponse = components$c['schemas']['EntryResolvedListResponse'];
|
|
11579
11623
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11580
11624
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
11581
11625
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -12190,7 +12234,7 @@ type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-proper
|
|
|
12190
12234
|
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
12191
12235
|
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
12192
12236
|
|
|
12193
|
-
type schemas = components$
|
|
12237
|
+
type schemas = components$c['schemas'];
|
|
12194
12238
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
12195
12239
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
12196
12240
|
|
|
@@ -16211,7 +16255,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
16211
16255
|
*/
|
|
16212
16256
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
16213
16257
|
|
|
16214
|
-
declare const version = "20.
|
|
16258
|
+
declare const version = "20.87.0";
|
|
16215
16259
|
|
|
16216
16260
|
/** API client to enable managing workflow definitions */
|
|
16217
16261
|
declare class WorkflowClient extends ApiClient {
|