@uniformdev/canvas 20.81.1-alpha.41.sha-adcf82dedd → 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 +740 -623
- package/dist/index.d.ts +740 -623
- package/dist/index.esm.js +2 -1
- package/dist/index.js +2 -1
- package/dist/index.mjs +2 -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
|
|
@@ -2234,6 +2235,12 @@ interface components$p {
|
|
|
2234
2235
|
* The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
|
|
2235
2236
|
*/
|
|
2236
2237
|
workflowStageId?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* Format: uuid
|
|
2240
|
+
* The workflow that entries created from this pattern start in. This is not the workflow
|
|
2241
|
+
* the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
|
|
2242
|
+
*/
|
|
2243
|
+
instanceWorkflowId?: string;
|
|
2237
2244
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
2238
2245
|
workflowDefinition?: components$p["schemas"]["WorkflowDefinition"];
|
|
2239
2246
|
/**
|
|
@@ -3537,6 +3544,15 @@ interface paths$l {
|
|
|
3537
3544
|
* The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
|
|
3538
3545
|
*/
|
|
3539
3546
|
workflowStageId?: string;
|
|
3547
|
+
/**
|
|
3548
|
+
* Format: uuid
|
|
3549
|
+
* The workflow that entries created from this pattern start in. This is not the
|
|
3550
|
+
* workflow the pattern itself is in, which comes from its content type.
|
|
3551
|
+
* When null, creation falls back to the content type's workflow.
|
|
3552
|
+
* Entry patterns only; sending it on anything else is a 400.
|
|
3553
|
+
* @defaultValue null
|
|
3554
|
+
*/
|
|
3555
|
+
instanceWorkflowId?: string | null;
|
|
3540
3556
|
/**
|
|
3541
3557
|
* Format: uuid
|
|
3542
3558
|
* The edition ID. When set, this is a child edition of the entry in _id.
|
|
@@ -4146,6 +4162,8 @@ interface components$n {
|
|
|
4146
4162
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
4147
4163
|
*/
|
|
4148
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;
|
|
4149
4167
|
/**
|
|
4150
4168
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
4151
4169
|
* @defaultValue false
|
|
@@ -4162,6 +4180,12 @@ interface components$n {
|
|
|
4162
4180
|
* The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
|
|
4163
4181
|
*/
|
|
4164
4182
|
workflowStageId?: string;
|
|
4183
|
+
/**
|
|
4184
|
+
* Format: uuid
|
|
4185
|
+
* The workflow that entries created from this pattern start in. This is not the workflow
|
|
4186
|
+
* the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
|
|
4187
|
+
*/
|
|
4188
|
+
instanceWorkflowId?: string;
|
|
4165
4189
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
4166
4190
|
workflowDefinition?: components$n["schemas"]["WorkflowDefinition"];
|
|
4167
4191
|
/**
|
|
@@ -6078,320 +6102,36 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
6078
6102
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
6079
6103
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
6080
6104
|
|
|
6081
|
-
interface paths$d {
|
|
6082
|
-
"/api/v1/views": {
|
|
6083
|
-
parameters: {
|
|
6084
|
-
query?: never;
|
|
6085
|
-
header?: never;
|
|
6086
|
-
path?: never;
|
|
6087
|
-
cookie?: never;
|
|
6088
|
-
};
|
|
6089
|
-
/** Lists saved views for a project + resource type. */
|
|
6090
|
-
get: {
|
|
6091
|
-
parameters: {
|
|
6092
|
-
query: {
|
|
6093
|
-
/** Project the views belong to. */
|
|
6094
|
-
projectId: string;
|
|
6095
|
-
/** Resource type these views apply to (e.g. "entry"). */
|
|
6096
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6097
|
-
/** Number of records to skip. */
|
|
6098
|
-
offset?: number | null;
|
|
6099
|
-
/** Maximum number of records to return. */
|
|
6100
|
-
limit?: number;
|
|
6101
|
-
};
|
|
6102
|
-
header?: never;
|
|
6103
|
-
path?: never;
|
|
6104
|
-
cookie?: never;
|
|
6105
|
-
};
|
|
6106
|
-
requestBody?: never;
|
|
6107
|
-
responses: {
|
|
6108
|
-
/** OK */
|
|
6109
|
-
200: {
|
|
6110
|
-
headers: {
|
|
6111
|
-
[name: string]: unknown;
|
|
6112
|
-
};
|
|
6113
|
-
content: {
|
|
6114
|
-
"application/json": {
|
|
6115
|
-
views: {
|
|
6116
|
-
name: string;
|
|
6117
|
-
description?: string;
|
|
6118
|
-
searchTerm?: string;
|
|
6119
|
-
filters: {
|
|
6120
|
-
field: string;
|
|
6121
|
-
dynamicField?: string;
|
|
6122
|
-
operator: string;
|
|
6123
|
-
value: string | string[];
|
|
6124
|
-
}[];
|
|
6125
|
-
sort?: string[];
|
|
6126
|
-
shared: boolean;
|
|
6127
|
-
icon?: string;
|
|
6128
|
-
id: string;
|
|
6129
|
-
projectId: string;
|
|
6130
|
-
/** @enum {string} */
|
|
6131
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6132
|
-
createdBy: string | null;
|
|
6133
|
-
/** Format: date-time */
|
|
6134
|
-
created: string;
|
|
6135
|
-
/** Format: date-time */
|
|
6136
|
-
modified: string;
|
|
6137
|
-
}[];
|
|
6138
|
-
totalCount: number;
|
|
6139
|
-
};
|
|
6140
|
-
};
|
|
6141
|
-
};
|
|
6142
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6143
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6144
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6145
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6146
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6147
|
-
};
|
|
6148
|
-
};
|
|
6149
|
-
/** 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. */
|
|
6150
|
-
put: {
|
|
6151
|
-
parameters: {
|
|
6152
|
-
query?: never;
|
|
6153
|
-
header?: never;
|
|
6154
|
-
path?: never;
|
|
6155
|
-
cookie?: never;
|
|
6156
|
-
};
|
|
6157
|
-
requestBody: {
|
|
6158
|
-
content: {
|
|
6159
|
-
"application/json": {
|
|
6160
|
-
name: string;
|
|
6161
|
-
description?: string;
|
|
6162
|
-
searchTerm?: string;
|
|
6163
|
-
filters: {
|
|
6164
|
-
field: string;
|
|
6165
|
-
dynamicField?: string;
|
|
6166
|
-
operator: string;
|
|
6167
|
-
value: string | string[];
|
|
6168
|
-
}[];
|
|
6169
|
-
sort?: string[];
|
|
6170
|
-
shared: boolean;
|
|
6171
|
-
icon?: string;
|
|
6172
|
-
id: string;
|
|
6173
|
-
projectId: string;
|
|
6174
|
-
/** @enum {string} */
|
|
6175
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6176
|
-
};
|
|
6177
|
-
};
|
|
6178
|
-
};
|
|
6179
|
-
responses: {
|
|
6180
|
-
/** OK */
|
|
6181
|
-
200: {
|
|
6182
|
-
headers: {
|
|
6183
|
-
[name: string]: unknown;
|
|
6184
|
-
};
|
|
6185
|
-
content: {
|
|
6186
|
-
"application/json": {
|
|
6187
|
-
name: string;
|
|
6188
|
-
description?: string;
|
|
6189
|
-
searchTerm?: string;
|
|
6190
|
-
filters: {
|
|
6191
|
-
field: string;
|
|
6192
|
-
dynamicField?: string;
|
|
6193
|
-
operator: string;
|
|
6194
|
-
value: string | string[];
|
|
6195
|
-
}[];
|
|
6196
|
-
sort?: string[];
|
|
6197
|
-
shared: boolean;
|
|
6198
|
-
icon?: string;
|
|
6199
|
-
id: string;
|
|
6200
|
-
projectId: string;
|
|
6201
|
-
/** @enum {string} */
|
|
6202
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6203
|
-
createdBy: string | null;
|
|
6204
|
-
/** Format: date-time */
|
|
6205
|
-
created: string;
|
|
6206
|
-
/** Format: date-time */
|
|
6207
|
-
modified: string;
|
|
6208
|
-
};
|
|
6209
|
-
};
|
|
6210
|
-
};
|
|
6211
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6212
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6213
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6214
|
-
/** View not found (or belongs to another project). */
|
|
6215
|
-
404: {
|
|
6216
|
-
headers: {
|
|
6217
|
-
[name: string]: unknown;
|
|
6218
|
-
};
|
|
6219
|
-
content?: never;
|
|
6220
|
-
};
|
|
6221
|
-
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
6222
|
-
409: {
|
|
6223
|
-
headers: {
|
|
6224
|
-
[name: string]: unknown;
|
|
6225
|
-
};
|
|
6226
|
-
content?: never;
|
|
6227
|
-
};
|
|
6228
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6229
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6230
|
-
};
|
|
6231
|
-
};
|
|
6232
|
-
post?: never;
|
|
6233
|
-
/** Deletes a saved view by id. */
|
|
6234
|
-
delete: {
|
|
6235
|
-
parameters: {
|
|
6236
|
-
query?: never;
|
|
6237
|
-
header?: never;
|
|
6238
|
-
path?: never;
|
|
6239
|
-
cookie?: never;
|
|
6240
|
-
};
|
|
6241
|
-
requestBody: {
|
|
6242
|
-
content: {
|
|
6243
|
-
"application/json": {
|
|
6244
|
-
id: string;
|
|
6245
|
-
projectId: string;
|
|
6246
|
-
};
|
|
6247
|
-
};
|
|
6248
|
-
};
|
|
6249
|
-
responses: {
|
|
6250
|
-
/** No Content */
|
|
6251
|
-
204: {
|
|
6252
|
-
headers: {
|
|
6253
|
-
[name: string]: unknown;
|
|
6254
|
-
};
|
|
6255
|
-
content: {
|
|
6256
|
-
"application/json": string;
|
|
6257
|
-
};
|
|
6258
|
-
};
|
|
6259
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6260
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6261
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6262
|
-
/** View not found. */
|
|
6263
|
-
404: {
|
|
6264
|
-
headers: {
|
|
6265
|
-
[name: string]: unknown;
|
|
6266
|
-
};
|
|
6267
|
-
content?: never;
|
|
6268
|
-
};
|
|
6269
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6270
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6271
|
-
};
|
|
6272
|
-
};
|
|
6273
|
-
/** Handles preflight requests. This endpoint allows CORS. */
|
|
6274
|
-
options: {
|
|
6275
|
-
parameters: {
|
|
6276
|
-
query?: never;
|
|
6277
|
-
header?: never;
|
|
6278
|
-
path?: never;
|
|
6279
|
-
cookie?: never;
|
|
6280
|
-
};
|
|
6281
|
-
requestBody?: never;
|
|
6282
|
-
responses: {
|
|
6283
|
-
/** ok */
|
|
6284
|
-
204: {
|
|
6285
|
-
headers: {
|
|
6286
|
-
[name: string]: unknown;
|
|
6287
|
-
};
|
|
6288
|
-
content?: never;
|
|
6289
|
-
};
|
|
6290
|
-
};
|
|
6291
|
-
};
|
|
6292
|
-
head?: never;
|
|
6293
|
-
patch?: never;
|
|
6294
|
-
trace?: never;
|
|
6295
|
-
};
|
|
6296
|
-
}
|
|
6297
6105
|
interface components$f {
|
|
6298
6106
|
schemas: {
|
|
6299
|
-
|
|
6300
|
-
|
|
6301
|
-
|
|
6302
|
-
|
|
6303
|
-
|
|
6304
|
-
|
|
6305
|
-
|
|
6306
|
-
|
|
6307
|
-
|
|
6308
|
-
[name: string]: unknown;
|
|
6309
|
-
};
|
|
6310
|
-
content: {
|
|
6311
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6312
|
-
};
|
|
6107
|
+
RouteResponse: components$f["schemas"]["RouteResponseRedirect"] | components$f["schemas"]["RouteResponseComposition"] | components$f["schemas"]["RouteResponseNotFound"];
|
|
6108
|
+
/** The route matches a redirection configured in Uniform */
|
|
6109
|
+
RouteResponseRedirect: {
|
|
6110
|
+
/** The route that was matched in the redirects */
|
|
6111
|
+
matchedRoute: string;
|
|
6112
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6113
|
+
/** @enum {string} */
|
|
6114
|
+
type: "redirect";
|
|
6115
|
+
redirect: components$f["schemas"]["Redirect"];
|
|
6313
6116
|
};
|
|
6314
|
-
/**
|
|
6315
|
-
|
|
6316
|
-
|
|
6317
|
-
|
|
6318
|
-
|
|
6319
|
-
|
|
6320
|
-
|
|
6321
|
-
|
|
6322
|
-
|
|
6323
|
-
|
|
6324
|
-
|
|
6325
|
-
|
|
6326
|
-
|
|
6327
|
-
|
|
6328
|
-
|
|
6329
|
-
|
|
6330
|
-
|
|
6331
|
-
|
|
6332
|
-
/** Too many requests in allowed time period */
|
|
6333
|
-
RateLimitError: {
|
|
6334
|
-
headers: {
|
|
6335
|
-
[name: string]: unknown;
|
|
6336
|
-
};
|
|
6337
|
-
content?: never;
|
|
6338
|
-
};
|
|
6339
|
-
/** Execution error occurred */
|
|
6340
|
-
InternalServerError: {
|
|
6341
|
-
headers: {
|
|
6342
|
-
[name: string]: unknown;
|
|
6343
|
-
};
|
|
6344
|
-
content?: never;
|
|
6345
|
-
};
|
|
6346
|
-
};
|
|
6347
|
-
parameters: never;
|
|
6348
|
-
requestBodies: never;
|
|
6349
|
-
headers: never;
|
|
6350
|
-
pathItems: never;
|
|
6351
|
-
}
|
|
6352
|
-
|
|
6353
|
-
type ViewsApi = paths$d['/api/v1/views'];
|
|
6354
|
-
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
6355
|
-
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
6356
|
-
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
6357
|
-
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
6358
|
-
type View = ViewsResponse['views'][number];
|
|
6359
|
-
/**
|
|
6360
|
-
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
6361
|
-
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
6362
|
-
*/
|
|
6363
|
-
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
6364
|
-
|
|
6365
|
-
interface components$e {
|
|
6366
|
-
schemas: {
|
|
6367
|
-
RouteResponse: components$e["schemas"]["RouteResponseRedirect"] | components$e["schemas"]["RouteResponseComposition"] | components$e["schemas"]["RouteResponseNotFound"];
|
|
6368
|
-
/** The route matches a redirection configured in Uniform */
|
|
6369
|
-
RouteResponseRedirect: {
|
|
6370
|
-
/** The route that was matched in the redirects */
|
|
6371
|
-
matchedRoute: string;
|
|
6372
|
-
dynamicInputs?: components$e["schemas"]["RouteDynamicInputs"];
|
|
6373
|
-
/** @enum {string} */
|
|
6374
|
-
type: "redirect";
|
|
6375
|
-
redirect: components$e["schemas"]["Redirect"];
|
|
6376
|
-
};
|
|
6377
|
-
/**
|
|
6378
|
-
* The route matches a composition.
|
|
6379
|
-
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
6380
|
-
*/
|
|
6381
|
-
RouteResponseComposition: {
|
|
6382
|
-
/** The route that was matched in the project map */
|
|
6383
|
-
matchedRoute: string;
|
|
6384
|
-
dynamicInputs?: components$e["schemas"]["RouteDynamicInputs"];
|
|
6385
|
-
/**
|
|
6386
|
-
* Indicates the data variant that was fetched for data resources.
|
|
6387
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
6388
|
-
* 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.
|
|
6389
|
-
|
|
6390
|
-
*/
|
|
6391
|
-
dataResourcesVariant?: "unpublished";
|
|
6392
|
-
/** @enum {string} */
|
|
6393
|
-
type: "composition";
|
|
6394
|
-
compositionApiResponse: components$e["schemas"]["CompositionApiResponse"];
|
|
6117
|
+
/**
|
|
6118
|
+
* The route matches a composition.
|
|
6119
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
6120
|
+
*/
|
|
6121
|
+
RouteResponseComposition: {
|
|
6122
|
+
/** The route that was matched in the project map */
|
|
6123
|
+
matchedRoute: string;
|
|
6124
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6125
|
+
/**
|
|
6126
|
+
* Indicates the data variant that was fetched for data resources.
|
|
6127
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
6128
|
+
* 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.
|
|
6129
|
+
|
|
6130
|
+
*/
|
|
6131
|
+
dataResourcesVariant?: "unpublished";
|
|
6132
|
+
/** @enum {string} */
|
|
6133
|
+
type: "composition";
|
|
6134
|
+
compositionApiResponse: components$f["schemas"]["CompositionApiResponse"];
|
|
6395
6135
|
};
|
|
6396
6136
|
/**
|
|
6397
6137
|
* The route does not match any configured redirections or compositions.
|
|
@@ -6509,11 +6249,11 @@ interface components$e {
|
|
|
6509
6249
|
|
|
6510
6250
|
*/
|
|
6511
6251
|
op?: "&" | "|";
|
|
6512
|
-
clauses: (components$
|
|
6252
|
+
clauses: (components$f["schemas"]["VisibilityCriteria"] | components$f["schemas"]["VisibilityCriteriaGroup"])[];
|
|
6513
6253
|
};
|
|
6514
6254
|
/** Defines a conditional value for a component parameter */
|
|
6515
6255
|
ComponentParameterConditionalValue: {
|
|
6516
|
-
when: components$
|
|
6256
|
+
when: components$f["schemas"]["VisibilityCriteriaGroup"];
|
|
6517
6257
|
/**
|
|
6518
6258
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
6519
6259
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -6535,7 +6275,7 @@ interface components$e {
|
|
|
6535
6275
|
*
|
|
6536
6276
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
6537
6277
|
*/
|
|
6538
|
-
ComponentParameterConditions: components$
|
|
6278
|
+
ComponentParameterConditions: components$f["schemas"]["ComponentParameterConditionalValue"][];
|
|
6539
6279
|
/** Defines an editable parameter on a component */
|
|
6540
6280
|
ComponentParameter: {
|
|
6541
6281
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -6543,7 +6283,7 @@ interface components$e {
|
|
|
6543
6283
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
6544
6284
|
type: string;
|
|
6545
6285
|
/** @deprecated */
|
|
6546
|
-
connectedData?: components$
|
|
6286
|
+
connectedData?: components$f["schemas"]["DataElementConnectionDefinition"];
|
|
6547
6287
|
/**
|
|
6548
6288
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
6549
6289
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -6551,10 +6291,10 @@ interface components$e {
|
|
|
6551
6291
|
locales?: {
|
|
6552
6292
|
[key: string]: unknown;
|
|
6553
6293
|
};
|
|
6554
|
-
conditions?: components$
|
|
6294
|
+
conditions?: components$f["schemas"]["ComponentParameterConditions"];
|
|
6555
6295
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
6556
6296
|
localesConditions?: {
|
|
6557
|
-
[key: string]: components$
|
|
6297
|
+
[key: string]: components$f["schemas"]["ComponentParameterConditions"];
|
|
6558
6298
|
};
|
|
6559
6299
|
};
|
|
6560
6300
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -6589,7 +6329,7 @@ interface components$e {
|
|
|
6589
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 */
|
|
6590
6330
|
isSearchHit?: boolean;
|
|
6591
6331
|
/** Query strings that are allowed to be passed to the node */
|
|
6592
|
-
queryStrings?: components$
|
|
6332
|
+
queryStrings?: components$f["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
6593
6333
|
/**
|
|
6594
6334
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
6595
6335
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -6614,7 +6354,7 @@ interface components$e {
|
|
|
6614
6354
|
* Unique identifier for the project map that this node belongs to
|
|
6615
6355
|
*/
|
|
6616
6356
|
projectMapId: string;
|
|
6617
|
-
data?: components$
|
|
6357
|
+
data?: components$f["schemas"]["ProjectMapNodeData"];
|
|
6618
6358
|
/**
|
|
6619
6359
|
* Locale-specific paths of the project map node.
|
|
6620
6360
|
* Keys are locale codes
|
|
@@ -6634,13 +6374,13 @@ interface components$e {
|
|
|
6634
6374
|
type: string;
|
|
6635
6375
|
/** Component parameter values for the component instance */
|
|
6636
6376
|
parameters?: {
|
|
6637
|
-
[key: string]: components$
|
|
6377
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6638
6378
|
};
|
|
6639
6379
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6640
6380
|
variant?: string;
|
|
6641
6381
|
/** Slots containing any child components */
|
|
6642
6382
|
slots?: {
|
|
6643
|
-
[key: string]: components$
|
|
6383
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6644
6384
|
};
|
|
6645
6385
|
/**
|
|
6646
6386
|
* Unique identifier of the component within the composition.
|
|
@@ -6651,20 +6391,20 @@ interface components$e {
|
|
|
6651
6391
|
_id?: string;
|
|
6652
6392
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
6653
6393
|
_pattern?: string;
|
|
6654
|
-
_dataResources?: components$
|
|
6394
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6655
6395
|
/**
|
|
6656
6396
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
6657
6397
|
* Means nothing for PUTs; it will be ignored
|
|
6658
6398
|
*/
|
|
6659
6399
|
_patternDataResources?: {
|
|
6660
|
-
[key: string]: components$
|
|
6400
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6661
6401
|
};
|
|
6662
6402
|
/**
|
|
6663
6403
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6664
6404
|
* Means nothing for PUTs; it will be ignored
|
|
6665
6405
|
*/
|
|
6666
6406
|
_patternOptedInQueryStrings?: string[];
|
|
6667
|
-
_patternError?: components$
|
|
6407
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6668
6408
|
/**
|
|
6669
6409
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6670
6410
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6678,14 +6418,14 @@ interface components$e {
|
|
|
6678
6418
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6679
6419
|
*/
|
|
6680
6420
|
_overrides?: {
|
|
6681
|
-
[key: string]: components$
|
|
6421
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6682
6422
|
};
|
|
6683
6423
|
/**
|
|
6684
6424
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6685
6425
|
* Means nothing for PUTs; it will be ignored
|
|
6686
6426
|
*/
|
|
6687
6427
|
_patternOverrides?: {
|
|
6688
|
-
[key: string]: components$
|
|
6428
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6689
6429
|
};
|
|
6690
6430
|
/**
|
|
6691
6431
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6694,7 +6434,7 @@ interface components$e {
|
|
|
6694
6434
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6695
6435
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6696
6436
|
*/
|
|
6697
|
-
_overridability?: components$
|
|
6437
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6698
6438
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
6699
6439
|
_locales?: string[];
|
|
6700
6440
|
};
|
|
@@ -6719,14 +6459,14 @@ interface components$e {
|
|
|
6719
6459
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
6720
6460
|
*/
|
|
6721
6461
|
optionalPatternParameter?: boolean;
|
|
6722
|
-
variables?: components$
|
|
6462
|
+
variables?: components$f["schemas"]["DataResourceVariables"];
|
|
6723
6463
|
};
|
|
6724
6464
|
/**
|
|
6725
6465
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
6726
6466
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
6727
6467
|
*/
|
|
6728
6468
|
DataResourceDefinitions: {
|
|
6729
|
-
[key: string]: components$
|
|
6469
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6730
6470
|
};
|
|
6731
6471
|
/**
|
|
6732
6472
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -6744,10 +6484,10 @@ interface components$e {
|
|
|
6744
6484
|
*/
|
|
6745
6485
|
ComponentOverride: {
|
|
6746
6486
|
parameters?: {
|
|
6747
|
-
[key: string]: components$
|
|
6487
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6748
6488
|
};
|
|
6749
6489
|
slots?: {
|
|
6750
|
-
[key: string]: components$
|
|
6490
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6751
6491
|
};
|
|
6752
6492
|
variant?: string;
|
|
6753
6493
|
/**
|
|
@@ -6756,7 +6496,7 @@ interface components$e {
|
|
|
6756
6496
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
6757
6497
|
*/
|
|
6758
6498
|
dataResources?: {
|
|
6759
|
-
[key: string]: components$
|
|
6499
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6760
6500
|
};
|
|
6761
6501
|
};
|
|
6762
6502
|
/**
|
|
@@ -6777,7 +6517,7 @@ interface components$e {
|
|
|
6777
6517
|
ComponentOverridability: {
|
|
6778
6518
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
6779
6519
|
parameters?: {
|
|
6780
|
-
[key: string]: components$
|
|
6520
|
+
[key: string]: components$f["schemas"]["OverrideOptions"];
|
|
6781
6521
|
};
|
|
6782
6522
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
6783
6523
|
variants?: boolean;
|
|
@@ -6794,15 +6534,15 @@ interface components$e {
|
|
|
6794
6534
|
type: string;
|
|
6795
6535
|
/** Component parameter values for the component instance */
|
|
6796
6536
|
parameters?: {
|
|
6797
|
-
[key: string]: components$
|
|
6537
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6798
6538
|
};
|
|
6799
6539
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6800
6540
|
variant?: string;
|
|
6801
6541
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
6802
|
-
projectMapNodes?: components$
|
|
6542
|
+
projectMapNodes?: components$f["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
6803
6543
|
/** Slots containing any child components */
|
|
6804
6544
|
slots?: {
|
|
6805
|
-
[key: string]: components$
|
|
6545
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6806
6546
|
};
|
|
6807
6547
|
/** The ID of the composition */
|
|
6808
6548
|
_id: string;
|
|
@@ -6825,15 +6565,15 @@ interface components$e {
|
|
|
6825
6565
|
* Means nothing for PUTs; it will be ignored
|
|
6826
6566
|
*/
|
|
6827
6567
|
_patternDataResources?: {
|
|
6828
|
-
[key: string]: components$
|
|
6568
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6829
6569
|
};
|
|
6830
6570
|
/**
|
|
6831
6571
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6832
6572
|
* Means nothing for PUTs; it will be ignored
|
|
6833
6573
|
*/
|
|
6834
6574
|
_patternOptedInQueryStrings?: string[];
|
|
6835
|
-
_dataResources?: components$
|
|
6836
|
-
_patternError?: components$
|
|
6575
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6576
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6837
6577
|
/**
|
|
6838
6578
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6839
6579
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6847,14 +6587,14 @@ interface components$e {
|
|
|
6847
6587
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6848
6588
|
*/
|
|
6849
6589
|
_overrides?: {
|
|
6850
|
-
[key: string]: components$
|
|
6590
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6851
6591
|
};
|
|
6852
6592
|
/**
|
|
6853
6593
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6854
6594
|
* Means nothing for PUTs; it will be ignored
|
|
6855
6595
|
*/
|
|
6856
6596
|
_patternOverrides?: {
|
|
6857
|
-
[key: string]: components$
|
|
6597
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6858
6598
|
};
|
|
6859
6599
|
/**
|
|
6860
6600
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6863,7 +6603,7 @@ interface components$e {
|
|
|
6863
6603
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6864
6604
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6865
6605
|
*/
|
|
6866
|
-
_overridability?: components$
|
|
6606
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6867
6607
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
6868
6608
|
_locales?: string[];
|
|
6869
6609
|
/**
|
|
@@ -6902,7 +6642,7 @@ interface components$e {
|
|
|
6902
6642
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
6903
6643
|
*/
|
|
6904
6644
|
permissions: {
|
|
6905
|
-
[key: string]: components$
|
|
6645
|
+
[key: string]: components$f["schemas"]["WorkflowStageTransitionPermission"];
|
|
6906
6646
|
};
|
|
6907
6647
|
};
|
|
6908
6648
|
/** Definition of a stage in a workflow */
|
|
@@ -6916,7 +6656,7 @@ interface components$e {
|
|
|
6916
6656
|
* listed here, the stage is read-only and publishing is disabled
|
|
6917
6657
|
*/
|
|
6918
6658
|
permissions: {
|
|
6919
|
-
[key: string]: components$
|
|
6659
|
+
[key: string]: components$f["schemas"]["WorkflowStagePermission"];
|
|
6920
6660
|
};
|
|
6921
6661
|
/**
|
|
6922
6662
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -6936,7 +6676,7 @@ interface components$e {
|
|
|
6936
6676
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
6937
6677
|
* has a stage that can never be escaped
|
|
6938
6678
|
*/
|
|
6939
|
-
transitions: components$
|
|
6679
|
+
transitions: components$f["schemas"]["WorkflowStageTransition"][];
|
|
6940
6680
|
/**
|
|
6941
6681
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
6942
6682
|
* @defaultValue chevron-double-right-o
|
|
@@ -6961,7 +6701,7 @@ interface components$e {
|
|
|
6961
6701
|
initialStage: string;
|
|
6962
6702
|
/** All stages of the workflow */
|
|
6963
6703
|
stages: {
|
|
6964
|
-
[key: string]: components$
|
|
6704
|
+
[key: string]: components$f["schemas"]["WorkflowStage"];
|
|
6965
6705
|
};
|
|
6966
6706
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
6967
6707
|
modified?: string;
|
|
@@ -7009,6 +6749,8 @@ interface components$e {
|
|
|
7009
6749
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7010
6750
|
*/
|
|
7011
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;
|
|
7012
6754
|
/** User name of the creator of this composition */
|
|
7013
6755
|
creator?: string;
|
|
7014
6756
|
/** User name of the last editor of this composition */
|
|
@@ -7034,7 +6776,7 @@ interface components$e {
|
|
|
7034
6776
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7035
6777
|
*/
|
|
7036
6778
|
releaseId?: string;
|
|
7037
|
-
composition: components$
|
|
6779
|
+
composition: components$f["schemas"]["RootComponentInstance"];
|
|
7038
6780
|
/**
|
|
7039
6781
|
* Format: uuid
|
|
7040
6782
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7045,8 +6787,14 @@ interface components$e {
|
|
|
7045
6787
|
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
7046
6788
|
*/
|
|
7047
6789
|
workflowStageId?: string;
|
|
6790
|
+
/**
|
|
6791
|
+
* Format: uuid
|
|
6792
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
6793
|
+
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
6794
|
+
*/
|
|
6795
|
+
instanceWorkflowId?: string;
|
|
7048
6796
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7049
|
-
workflowDefinition?: components$
|
|
6797
|
+
workflowDefinition?: components$f["schemas"]["WorkflowDefinition"];
|
|
7050
6798
|
/**
|
|
7051
6799
|
* Format: uuid
|
|
7052
6800
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7157,7 +6905,7 @@ interface components$e {
|
|
|
7157
6905
|
pathItems: never;
|
|
7158
6906
|
}
|
|
7159
6907
|
|
|
7160
|
-
interface paths$
|
|
6908
|
+
interface paths$d {
|
|
7161
6909
|
"/api/v1/canvas": {
|
|
7162
6910
|
parameters: {
|
|
7163
6911
|
query?: never;
|
|
@@ -7279,56 +7027,56 @@ interface paths$c {
|
|
|
7279
7027
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7280
7028
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7281
7029
|
*/
|
|
7282
|
-
compositionId?: components$
|
|
7030
|
+
compositionId?: components$e["parameters"]["compositionId"];
|
|
7283
7031
|
/**
|
|
7284
7032
|
* Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
7285
7033
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7286
7034
|
*/
|
|
7287
|
-
componentId?: components$
|
|
7035
|
+
componentId?: components$e["parameters"]["componentId"];
|
|
7288
7036
|
/**
|
|
7289
7037
|
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
7290
7038
|
* Must be used with the `compositionId` parameter
|
|
7291
7039
|
*/
|
|
7292
|
-
versionId?: components$
|
|
7040
|
+
versionId?: components$e["parameters"]["versionId"];
|
|
7293
7041
|
/**
|
|
7294
7042
|
* Specify multiple composition IDs to fetch. The response type will be a list.
|
|
7295
7043
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7296
7044
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7297
7045
|
*/
|
|
7298
|
-
compositionIDs?: components$
|
|
7046
|
+
compositionIDs?: components$e["parameters"]["compositionIDs"];
|
|
7299
7047
|
/**
|
|
7300
7048
|
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
7301
7049
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7302
7050
|
*/
|
|
7303
|
-
createdBy?: components$
|
|
7051
|
+
createdBy?: components$e["parameters"]["createdBy"];
|
|
7304
7052
|
/**
|
|
7305
7053
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
7306
7054
|
* NOT a full-text search; does not match composition contents.
|
|
7307
7055
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7308
7056
|
*/
|
|
7309
|
-
keyword?: components$
|
|
7057
|
+
keyword?: components$e["parameters"]["keyword"];
|
|
7310
7058
|
/**
|
|
7311
7059
|
* Maximum number of records to return
|
|
7312
7060
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7313
7061
|
*/
|
|
7314
|
-
limit?: components$
|
|
7062
|
+
limit?: components$e["parameters"]["limit"];
|
|
7315
7063
|
/**
|
|
7316
7064
|
* Number of records to skip
|
|
7317
7065
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7318
7066
|
*/
|
|
7319
|
-
offset?: components$
|
|
7067
|
+
offset?: components$e["parameters"]["offset"];
|
|
7320
7068
|
/**
|
|
7321
7069
|
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
7322
7070
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
7323
7071
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
7324
7072
|
* When using primary query parameters, this parameter is ignored
|
|
7325
7073
|
*/
|
|
7326
|
-
orderBy?: components$
|
|
7074
|
+
orderBy?: components$e["parameters"]["orderBy"];
|
|
7327
7075
|
/**
|
|
7328
7076
|
* @deprecated
|
|
7329
7077
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
7330
7078
|
*/
|
|
7331
|
-
facetBy?: components$
|
|
7079
|
+
facetBy?: components$e["parameters"]["facetBy"];
|
|
7332
7080
|
/**
|
|
7333
7081
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
7334
7082
|
* If true, only pattern compositions will be returned.
|
|
@@ -7336,44 +7084,44 @@ interface paths$c {
|
|
|
7336
7084
|
* If omitted or 'any', both pattern and regular compositions will be returned.
|
|
7337
7085
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7338
7086
|
*/
|
|
7339
|
-
pattern?: components$
|
|
7087
|
+
pattern?: components$e["parameters"]["pattern"];
|
|
7340
7088
|
/**
|
|
7341
7089
|
* This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
7342
7090
|
* * `all` - Returns all pattern instances
|
|
7343
7091
|
* * `component` - Returns only component patterns
|
|
7344
7092
|
* * `composition` - Returns only composition patterns
|
|
7345
7093
|
*/
|
|
7346
|
-
patternType?: components$
|
|
7094
|
+
patternType?: components$e["parameters"]["patternType"];
|
|
7347
7095
|
/**
|
|
7348
7096
|
* @deprecated
|
|
7349
7097
|
* Includes the `patternType` attribute in the response
|
|
7350
7098
|
*/
|
|
7351
|
-
withPatternType?: components$
|
|
7099
|
+
withPatternType?: components$e["parameters"]["withPatternType"];
|
|
7352
7100
|
/** The project the composition(s) belong to */
|
|
7353
|
-
projectId: components$
|
|
7101
|
+
projectId: components$e["parameters"]["projectId"];
|
|
7354
7102
|
/**
|
|
7355
7103
|
* Specify a project map ID to fetch by path or node ID from.
|
|
7356
7104
|
* If not specified, the default project map for the projectId is used.
|
|
7357
7105
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
7358
7106
|
*/
|
|
7359
|
-
projectMapId?: components$
|
|
7107
|
+
projectMapId?: components$e["parameters"]["projectMapId"];
|
|
7360
7108
|
/**
|
|
7361
7109
|
* Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
7362
7110
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7363
7111
|
*/
|
|
7364
|
-
projectMapNodeId?: components$
|
|
7112
|
+
projectMapNodeId?: components$e["parameters"]["projectMapNodeId"];
|
|
7365
7113
|
/**
|
|
7366
7114
|
* Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
7367
7115
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7368
7116
|
*/
|
|
7369
|
-
projectMapNodePath?: components$
|
|
7117
|
+
projectMapNodePath?: components$e["parameters"]["projectMapNodePath"];
|
|
7370
7118
|
/**
|
|
7371
7119
|
* @deprecated
|
|
7372
7120
|
* Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
7373
7121
|
* This improves performance if you do not require enhanced component data.
|
|
7374
7122
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
7375
7123
|
*/
|
|
7376
|
-
skipEnhance?: components$
|
|
7124
|
+
skipEnhance?: components$e["parameters"]["skipEnhance"];
|
|
7377
7125
|
/**
|
|
7378
7126
|
* If true, any pattern references in the composition will be left unresolved.
|
|
7379
7127
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -7381,12 +7129,12 @@ interface paths$c {
|
|
|
7381
7129
|
* Default: true when `format` is canonical. False otherwise.
|
|
7382
7130
|
* Prefer selecting a `format` rather than using this option.
|
|
7383
7131
|
*/
|
|
7384
|
-
skipPatternResolution?: components$
|
|
7132
|
+
skipPatternResolution?: components$e["parameters"]["skipPatternResolution"];
|
|
7385
7133
|
/**
|
|
7386
7134
|
* @deprecated
|
|
7387
7135
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
7388
7136
|
*/
|
|
7389
|
-
skipParameterResolution?: components$
|
|
7137
|
+
skipParameterResolution?: components$e["parameters"]["skipParameterResolution"];
|
|
7390
7138
|
/**
|
|
7391
7139
|
* If true, any pattern override data is not resolved by the API.
|
|
7392
7140
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
@@ -7394,69 +7142,69 @@ interface paths$c {
|
|
|
7394
7142
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7395
7143
|
* Prefer selecting a `format` rather than using this option.
|
|
7396
7144
|
*/
|
|
7397
|
-
skipOverridesResolution?: components$
|
|
7145
|
+
skipOverridesResolution?: components$e["parameters"]["skipOverridesResolution"];
|
|
7398
7146
|
/**
|
|
7399
7147
|
* Specify a single composition to fetch by slug. The response will be a single composition.
|
|
7400
7148
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7401
7149
|
*/
|
|
7402
|
-
slug?: components$
|
|
7150
|
+
slug?: components$e["parameters"]["slug"];
|
|
7403
7151
|
/** Filtration by category ID. An empty string can be used to include records without a category. */
|
|
7404
|
-
categories?: components$
|
|
7152
|
+
categories?: components$e["parameters"]["categories"];
|
|
7405
7153
|
/**
|
|
7406
7154
|
* Publishing state to fetch. 0 = draft, 64 = published.
|
|
7407
7155
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7408
7156
|
*/
|
|
7409
|
-
state?: components$
|
|
7157
|
+
state?: components$e["parameters"]["state"];
|
|
7410
7158
|
/**
|
|
7411
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.
|
|
7412
7160
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7413
7161
|
*/
|
|
7414
|
-
type?: components$
|
|
7162
|
+
type?: components$e["parameters"]["type"];
|
|
7415
7163
|
/**
|
|
7416
7164
|
* @deprecated
|
|
7417
7165
|
* Filters composition lists by the UI status of the composition.
|
|
7418
7166
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data.
|
|
7419
7167
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7420
7168
|
*/
|
|
7421
|
-
uiStatus?: components$
|
|
7169
|
+
uiStatus?: components$e["parameters"]["uiStatus"];
|
|
7422
7170
|
/**
|
|
7423
7171
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
|
7424
7172
|
* if set to false. If not specified, no filtration is applied.
|
|
7425
7173
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7426
7174
|
*/
|
|
7427
|
-
attachedToProjectMap?: components$
|
|
7175
|
+
attachedToProjectMap?: components$e["parameters"]["attachedToProjectMap"];
|
|
7428
7176
|
/**
|
|
7429
7177
|
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
7430
7178
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7431
7179
|
*/
|
|
7432
|
-
updatedBy?: components$
|
|
7180
|
+
updatedBy?: components$e["parameters"]["updatedBy"];
|
|
7433
7181
|
/**
|
|
7434
7182
|
* If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
7435
7183
|
* If false, the `_id` will not be present in the API response.
|
|
7436
7184
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7437
7185
|
* Prefer selecting a `format` rather than using this option.
|
|
7438
7186
|
*/
|
|
7439
|
-
withComponentIDs?: components$
|
|
7187
|
+
withComponentIDs?: components$e["parameters"]["withComponentIDs"];
|
|
7440
7188
|
/**
|
|
7441
7189
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
7442
7190
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
7443
7191
|
*/
|
|
7444
|
-
withTotalCount?: components$
|
|
7192
|
+
withTotalCount?: components$e["parameters"]["withTotalCount"];
|
|
7445
7193
|
/**
|
|
7446
7194
|
* @deprecated
|
|
7447
7195
|
* Returns the UI status string of the composition.
|
|
7448
7196
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
7449
7197
|
*/
|
|
7450
|
-
withUIStatus?: components$
|
|
7198
|
+
withUIStatus?: components$e["parameters"]["withUIStatus"];
|
|
7451
7199
|
/** Returns the definition of any attached workflow along with the composition data */
|
|
7452
|
-
withWorkflowDefinition?: components$
|
|
7200
|
+
withWorkflowDefinition?: components$e["parameters"]["withWorkflowDefinition"];
|
|
7453
7201
|
/** Includes project map node information in the composition results */
|
|
7454
|
-
withProjectMapNodes?: components$
|
|
7202
|
+
withProjectMapNodes?: components$e["parameters"]["withProjectMapNodes"];
|
|
7455
7203
|
/**
|
|
7456
7204
|
* @deprecated
|
|
7457
7205
|
* Has no effect.
|
|
7458
7206
|
*/
|
|
7459
|
-
withContentSourceMap?: components$
|
|
7207
|
+
withContentSourceMap?: components$e["parameters"]["withContentSourceMap"];
|
|
7460
7208
|
/**
|
|
7461
7209
|
* One or more locales to filter and localize by.
|
|
7462
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.
|
|
@@ -7470,7 +7218,7 @@ interface paths$c {
|
|
|
7470
7218
|
* When this parameter is not passed, all locales' data will be returned.
|
|
7471
7219
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
7472
7220
|
*/
|
|
7473
|
-
locale?: components$
|
|
7221
|
+
locale?: components$e["parameters"]["locale"];
|
|
7474
7222
|
/**
|
|
7475
7223
|
* The ID of a release to fetch the content for.
|
|
7476
7224
|
*
|
|
@@ -7479,7 +7227,7 @@ interface paths$c {
|
|
|
7479
7227
|
*
|
|
7480
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
|
|
7481
7229
|
*/
|
|
7482
|
-
releaseId?: components$
|
|
7230
|
+
releaseId?: components$e["parameters"]["releaseId"];
|
|
7483
7231
|
/**
|
|
7484
7232
|
* Search on textual fields of a composition.
|
|
7485
7233
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -7487,7 +7235,7 @@ interface paths$c {
|
|
|
7487
7235
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
7488
7236
|
* Example: ?search=hello
|
|
7489
7237
|
*/
|
|
7490
|
-
search?: components$
|
|
7238
|
+
search?: components$e["parameters"]["search"];
|
|
7491
7239
|
/**
|
|
7492
7240
|
* @deprecated
|
|
7493
7241
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -7495,7 +7243,7 @@ interface paths$c {
|
|
|
7495
7243
|
* Use this for "where is this content defined" queries.
|
|
7496
7244
|
* Requires AI credits.
|
|
7497
7245
|
*/
|
|
7498
|
-
searchSemantic?: components$
|
|
7246
|
+
searchSemantic?: components$e["parameters"]["searchSemantic"];
|
|
7499
7247
|
/**
|
|
7500
7248
|
* Controls the edition resolution behavior.
|
|
7501
7249
|
*
|
|
@@ -7510,7 +7258,7 @@ interface paths$c {
|
|
|
7510
7258
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
7511
7259
|
* If versionId is passed, this is always enabled.
|
|
7512
7260
|
*/
|
|
7513
|
-
editions?: components$
|
|
7261
|
+
editions?: components$e["parameters"]["editions"];
|
|
7514
7262
|
/**
|
|
7515
7263
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7516
7264
|
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
@@ -7523,7 +7271,7 @@ interface paths$c {
|
|
|
7523
7271
|
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7524
7272
|
* and component `_id`s removed.
|
|
7525
7273
|
*/
|
|
7526
|
-
format?: components$
|
|
7274
|
+
format?: components$e["parameters"]["format"];
|
|
7527
7275
|
/**
|
|
7528
7276
|
* Controls filtering of trashed items.
|
|
7529
7277
|
*
|
|
@@ -7531,7 +7279,7 @@ interface paths$c {
|
|
|
7531
7279
|
* only: Only return trashed items (for trash view).
|
|
7532
7280
|
* include: Return both trashed and non-trashed items.
|
|
7533
7281
|
*/
|
|
7534
|
-
deleted?: components$
|
|
7282
|
+
deleted?: components$e["parameters"]["deleted"];
|
|
7535
7283
|
};
|
|
7536
7284
|
header?: never;
|
|
7537
7285
|
path?: never;
|
|
@@ -7545,12 +7293,12 @@ interface paths$c {
|
|
|
7545
7293
|
[name: string]: unknown;
|
|
7546
7294
|
};
|
|
7547
7295
|
content: {
|
|
7548
|
-
"application/json": components$
|
|
7296
|
+
"application/json": components$e["schemas"]["CompositionListResponse"] | components$e["schemas"]["CompositionApiResponse"];
|
|
7549
7297
|
};
|
|
7550
7298
|
};
|
|
7551
|
-
400: components$
|
|
7552
|
-
401: components$
|
|
7553
|
-
403: components$
|
|
7299
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7300
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7301
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7554
7302
|
/** Composition not found */
|
|
7555
7303
|
404: {
|
|
7556
7304
|
headers: {
|
|
@@ -7560,8 +7308,8 @@ interface paths$c {
|
|
|
7560
7308
|
"text/plain": string;
|
|
7561
7309
|
};
|
|
7562
7310
|
};
|
|
7563
|
-
429: components$
|
|
7564
|
-
500: components$
|
|
7311
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7312
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7565
7313
|
};
|
|
7566
7314
|
};
|
|
7567
7315
|
/** Upserts a composition */
|
|
@@ -7589,7 +7337,7 @@ interface paths$c {
|
|
|
7589
7337
|
projectId: string;
|
|
7590
7338
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
7591
7339
|
state: number;
|
|
7592
|
-
composition: components$
|
|
7340
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7593
7341
|
/**
|
|
7594
7342
|
* Indicates if the composition is a pattern that can be referenced in other compositions
|
|
7595
7343
|
* @defaultValue false
|
|
@@ -7630,6 +7378,15 @@ interface paths$c {
|
|
|
7630
7378
|
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
7631
7379
|
*/
|
|
7632
7380
|
workflowStageId?: string;
|
|
7381
|
+
/**
|
|
7382
|
+
* Format: uuid
|
|
7383
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
7384
|
+
* workflow the pattern itself is in, which comes from its component definition.
|
|
7385
|
+
* When null, creation falls back to the component definition's workflow.
|
|
7386
|
+
* Composition patterns only; sending it on anything else is a 400.
|
|
7387
|
+
* @defaultValue null
|
|
7388
|
+
*/
|
|
7389
|
+
instanceWorkflowId?: string | null;
|
|
7633
7390
|
/**
|
|
7634
7391
|
* Format: uuid
|
|
7635
7392
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7656,9 +7413,9 @@ interface paths$c {
|
|
|
7656
7413
|
};
|
|
7657
7414
|
content?: never;
|
|
7658
7415
|
};
|
|
7659
|
-
400: components$
|
|
7660
|
-
401: components$
|
|
7661
|
-
403: components$
|
|
7416
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7417
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7418
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7662
7419
|
/** Conflict - Composition has been changed since being loaded */
|
|
7663
7420
|
409: {
|
|
7664
7421
|
headers: {
|
|
@@ -7668,8 +7425,8 @@ interface paths$c {
|
|
|
7668
7425
|
"text/plain": string;
|
|
7669
7426
|
};
|
|
7670
7427
|
};
|
|
7671
|
-
429: components$
|
|
7672
|
-
500: components$
|
|
7428
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7429
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7673
7430
|
};
|
|
7674
7431
|
};
|
|
7675
7432
|
post?: never;
|
|
@@ -7722,11 +7479,11 @@ interface paths$c {
|
|
|
7722
7479
|
};
|
|
7723
7480
|
content?: never;
|
|
7724
7481
|
};
|
|
7725
|
-
400: components$
|
|
7726
|
-
401: components$
|
|
7727
|
-
403: components$
|
|
7728
|
-
429: components$
|
|
7729
|
-
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"];
|
|
7730
7487
|
};
|
|
7731
7488
|
};
|
|
7732
7489
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -7753,7 +7510,7 @@ interface paths$c {
|
|
|
7753
7510
|
trace?: never;
|
|
7754
7511
|
};
|
|
7755
7512
|
}
|
|
7756
|
-
interface components$
|
|
7513
|
+
interface components$e {
|
|
7757
7514
|
schemas: {
|
|
7758
7515
|
CompositionApiResponse: {
|
|
7759
7516
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -7784,6 +7541,8 @@ interface components$d {
|
|
|
7784
7541
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7785
7542
|
*/
|
|
7786
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;
|
|
7787
7546
|
/** User name of the creator of this composition */
|
|
7788
7547
|
creator?: string;
|
|
7789
7548
|
/** User name of the last editor of this composition */
|
|
@@ -7809,7 +7568,7 @@ interface components$d {
|
|
|
7809
7568
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7810
7569
|
*/
|
|
7811
7570
|
releaseId?: string;
|
|
7812
|
-
composition: components$
|
|
7571
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7813
7572
|
/**
|
|
7814
7573
|
* Format: uuid
|
|
7815
7574
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7820,8 +7579,14 @@ interface components$d {
|
|
|
7820
7579
|
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
7821
7580
|
*/
|
|
7822
7581
|
workflowStageId?: string;
|
|
7582
|
+
/**
|
|
7583
|
+
* Format: uuid
|
|
7584
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
7585
|
+
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
7586
|
+
*/
|
|
7587
|
+
instanceWorkflowId?: string;
|
|
7823
7588
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7824
|
-
workflowDefinition?: components$
|
|
7589
|
+
workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
|
|
7825
7590
|
/**
|
|
7826
7591
|
* Format: uuid
|
|
7827
7592
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7839,7 +7604,7 @@ interface components$d {
|
|
|
7839
7604
|
editionPriority?: number;
|
|
7840
7605
|
};
|
|
7841
7606
|
CompositionListResponse: {
|
|
7842
|
-
compositions: components$
|
|
7607
|
+
compositions: components$e["schemas"]["CompositionApiResponse"][];
|
|
7843
7608
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
7844
7609
|
totalCount?: number;
|
|
7845
7610
|
/** Per-field counts for distinct values */
|
|
@@ -7913,11 +7678,11 @@ interface components$d {
|
|
|
7913
7678
|
|
|
7914
7679
|
*/
|
|
7915
7680
|
op?: "&" | "|";
|
|
7916
|
-
clauses: (components$
|
|
7681
|
+
clauses: (components$e["schemas"]["VisibilityCriteria"] | components$e["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7917
7682
|
};
|
|
7918
7683
|
/** Defines a conditional value for a component parameter */
|
|
7919
7684
|
ComponentParameterConditionalValue: {
|
|
7920
|
-
when: components$
|
|
7685
|
+
when: components$e["schemas"]["VisibilityCriteriaGroup"];
|
|
7921
7686
|
/**
|
|
7922
7687
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7923
7688
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -7939,7 +7704,7 @@ interface components$d {
|
|
|
7939
7704
|
*
|
|
7940
7705
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7941
7706
|
*/
|
|
7942
|
-
ComponentParameterConditions: components$
|
|
7707
|
+
ComponentParameterConditions: components$e["schemas"]["ComponentParameterConditionalValue"][];
|
|
7943
7708
|
/** Defines an editable parameter on a component */
|
|
7944
7709
|
ComponentParameter: {
|
|
7945
7710
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7947,7 +7712,7 @@ interface components$d {
|
|
|
7947
7712
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7948
7713
|
type: string;
|
|
7949
7714
|
/** @deprecated */
|
|
7950
|
-
connectedData?: components$
|
|
7715
|
+
connectedData?: components$e["schemas"]["DataElementConnectionDefinition"];
|
|
7951
7716
|
/**
|
|
7952
7717
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
7953
7718
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -7955,10 +7720,10 @@ interface components$d {
|
|
|
7955
7720
|
locales?: {
|
|
7956
7721
|
[key: string]: unknown;
|
|
7957
7722
|
};
|
|
7958
|
-
conditions?: components$
|
|
7723
|
+
conditions?: components$e["schemas"]["ComponentParameterConditions"];
|
|
7959
7724
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
7960
7725
|
localesConditions?: {
|
|
7961
|
-
[key: string]: components$
|
|
7726
|
+
[key: string]: components$e["schemas"]["ComponentParameterConditions"];
|
|
7962
7727
|
};
|
|
7963
7728
|
};
|
|
7964
7729
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -7993,7 +7758,7 @@ interface components$d {
|
|
|
7993
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 */
|
|
7994
7759
|
isSearchHit?: boolean;
|
|
7995
7760
|
/** Query strings that are allowed to be passed to the node */
|
|
7996
|
-
queryStrings?: components$
|
|
7761
|
+
queryStrings?: components$e["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
7997
7762
|
/**
|
|
7998
7763
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
7999
7764
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -8018,7 +7783,7 @@ interface components$d {
|
|
|
8018
7783
|
* Unique identifier for the project map that this node belongs to
|
|
8019
7784
|
*/
|
|
8020
7785
|
projectMapId: string;
|
|
8021
|
-
data?: components$
|
|
7786
|
+
data?: components$e["schemas"]["ProjectMapNodeData"];
|
|
8022
7787
|
/**
|
|
8023
7788
|
* Locale-specific paths of the project map node.
|
|
8024
7789
|
* Keys are locale codes
|
|
@@ -8038,13 +7803,13 @@ interface components$d {
|
|
|
8038
7803
|
type: string;
|
|
8039
7804
|
/** Component parameter values for the component instance */
|
|
8040
7805
|
parameters?: {
|
|
8041
|
-
[key: string]: components$
|
|
7806
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8042
7807
|
};
|
|
8043
7808
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8044
7809
|
variant?: string;
|
|
8045
7810
|
/** Slots containing any child components */
|
|
8046
7811
|
slots?: {
|
|
8047
|
-
[key: string]: components$
|
|
7812
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8048
7813
|
};
|
|
8049
7814
|
/**
|
|
8050
7815
|
* Unique identifier of the component within the composition.
|
|
@@ -8055,20 +7820,20 @@ interface components$d {
|
|
|
8055
7820
|
_id?: string;
|
|
8056
7821
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
8057
7822
|
_pattern?: string;
|
|
8058
|
-
_dataResources?: components$
|
|
7823
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8059
7824
|
/**
|
|
8060
7825
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8061
7826
|
* Means nothing for PUTs; it will be ignored
|
|
8062
7827
|
*/
|
|
8063
7828
|
_patternDataResources?: {
|
|
8064
|
-
[key: string]: components$
|
|
7829
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8065
7830
|
};
|
|
8066
7831
|
/**
|
|
8067
7832
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8068
7833
|
* Means nothing for PUTs; it will be ignored
|
|
8069
7834
|
*/
|
|
8070
7835
|
_patternOptedInQueryStrings?: string[];
|
|
8071
|
-
_patternError?: components$
|
|
7836
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8072
7837
|
/**
|
|
8073
7838
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8074
7839
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8082,14 +7847,14 @@ interface components$d {
|
|
|
8082
7847
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8083
7848
|
*/
|
|
8084
7849
|
_overrides?: {
|
|
8085
|
-
[key: string]: components$
|
|
7850
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8086
7851
|
};
|
|
8087
7852
|
/**
|
|
8088
7853
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8089
7854
|
* Means nothing for PUTs; it will be ignored
|
|
8090
7855
|
*/
|
|
8091
7856
|
_patternOverrides?: {
|
|
8092
|
-
[key: string]: components$
|
|
7857
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8093
7858
|
};
|
|
8094
7859
|
/**
|
|
8095
7860
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8098,7 +7863,7 @@ interface components$d {
|
|
|
8098
7863
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8099
7864
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8100
7865
|
*/
|
|
8101
|
-
_overridability?: components$
|
|
7866
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8102
7867
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
8103
7868
|
_locales?: string[];
|
|
8104
7869
|
};
|
|
@@ -8123,14 +7888,14 @@ interface components$d {
|
|
|
8123
7888
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
8124
7889
|
*/
|
|
8125
7890
|
optionalPatternParameter?: boolean;
|
|
8126
|
-
variables?: components$
|
|
7891
|
+
variables?: components$e["schemas"]["DataResourceVariables"];
|
|
8127
7892
|
};
|
|
8128
7893
|
/**
|
|
8129
7894
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
8130
7895
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
8131
7896
|
*/
|
|
8132
7897
|
DataResourceDefinitions: {
|
|
8133
|
-
[key: string]: components$
|
|
7898
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8134
7899
|
};
|
|
8135
7900
|
/**
|
|
8136
7901
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8148,10 +7913,10 @@ interface components$d {
|
|
|
8148
7913
|
*/
|
|
8149
7914
|
ComponentOverride: {
|
|
8150
7915
|
parameters?: {
|
|
8151
|
-
[key: string]: components$
|
|
7916
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8152
7917
|
};
|
|
8153
7918
|
slots?: {
|
|
8154
|
-
[key: string]: components$
|
|
7919
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8155
7920
|
};
|
|
8156
7921
|
variant?: string;
|
|
8157
7922
|
/**
|
|
@@ -8160,7 +7925,7 @@ interface components$d {
|
|
|
8160
7925
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
8161
7926
|
*/
|
|
8162
7927
|
dataResources?: {
|
|
8163
|
-
[key: string]: components$
|
|
7928
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8164
7929
|
};
|
|
8165
7930
|
};
|
|
8166
7931
|
/**
|
|
@@ -8181,7 +7946,7 @@ interface components$d {
|
|
|
8181
7946
|
ComponentOverridability: {
|
|
8182
7947
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
8183
7948
|
parameters?: {
|
|
8184
|
-
[key: string]: components$
|
|
7949
|
+
[key: string]: components$e["schemas"]["OverrideOptions"];
|
|
8185
7950
|
};
|
|
8186
7951
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
8187
7952
|
variants?: boolean;
|
|
@@ -8198,15 +7963,15 @@ interface components$d {
|
|
|
8198
7963
|
type: string;
|
|
8199
7964
|
/** Component parameter values for the component instance */
|
|
8200
7965
|
parameters?: {
|
|
8201
|
-
[key: string]: components$
|
|
7966
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8202
7967
|
};
|
|
8203
7968
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8204
7969
|
variant?: string;
|
|
8205
7970
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
8206
|
-
projectMapNodes?: components$
|
|
7971
|
+
projectMapNodes?: components$e["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
8207
7972
|
/** Slots containing any child components */
|
|
8208
7973
|
slots?: {
|
|
8209
|
-
[key: string]: components$
|
|
7974
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8210
7975
|
};
|
|
8211
7976
|
/** The ID of the composition */
|
|
8212
7977
|
_id: string;
|
|
@@ -8229,15 +7994,15 @@ interface components$d {
|
|
|
8229
7994
|
* Means nothing for PUTs; it will be ignored
|
|
8230
7995
|
*/
|
|
8231
7996
|
_patternDataResources?: {
|
|
8232
|
-
[key: string]: components$
|
|
7997
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8233
7998
|
};
|
|
8234
7999
|
/**
|
|
8235
8000
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8236
8001
|
* Means nothing for PUTs; it will be ignored
|
|
8237
8002
|
*/
|
|
8238
8003
|
_patternOptedInQueryStrings?: string[];
|
|
8239
|
-
_dataResources?: components$
|
|
8240
|
-
_patternError?: components$
|
|
8004
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8005
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8241
8006
|
/**
|
|
8242
8007
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8243
8008
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8251,14 +8016,14 @@ interface components$d {
|
|
|
8251
8016
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8252
8017
|
*/
|
|
8253
8018
|
_overrides?: {
|
|
8254
|
-
[key: string]: components$
|
|
8019
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8255
8020
|
};
|
|
8256
8021
|
/**
|
|
8257
8022
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8258
8023
|
* Means nothing for PUTs; it will be ignored
|
|
8259
8024
|
*/
|
|
8260
8025
|
_patternOverrides?: {
|
|
8261
|
-
[key: string]: components$
|
|
8026
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8262
8027
|
};
|
|
8263
8028
|
/**
|
|
8264
8029
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8267,7 +8032,7 @@ interface components$d {
|
|
|
8267
8032
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8268
8033
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8269
8034
|
*/
|
|
8270
|
-
_overridability?: components$
|
|
8035
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8271
8036
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
8272
8037
|
_locales?: string[];
|
|
8273
8038
|
/**
|
|
@@ -8306,7 +8071,7 @@ interface components$d {
|
|
|
8306
8071
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8307
8072
|
*/
|
|
8308
8073
|
permissions: {
|
|
8309
|
-
[key: string]: components$
|
|
8074
|
+
[key: string]: components$e["schemas"]["WorkflowStageTransitionPermission"];
|
|
8310
8075
|
};
|
|
8311
8076
|
};
|
|
8312
8077
|
/** Definition of a stage in a workflow */
|
|
@@ -8320,7 +8085,7 @@ interface components$d {
|
|
|
8320
8085
|
* listed here, the stage is read-only and publishing is disabled
|
|
8321
8086
|
*/
|
|
8322
8087
|
permissions: {
|
|
8323
|
-
[key: string]: components$
|
|
8088
|
+
[key: string]: components$e["schemas"]["WorkflowStagePermission"];
|
|
8324
8089
|
};
|
|
8325
8090
|
/**
|
|
8326
8091
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -8340,7 +8105,7 @@ interface components$d {
|
|
|
8340
8105
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8341
8106
|
* has a stage that can never be escaped
|
|
8342
8107
|
*/
|
|
8343
|
-
transitions: components$
|
|
8108
|
+
transitions: components$e["schemas"]["WorkflowStageTransition"][];
|
|
8344
8109
|
/**
|
|
8345
8110
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8346
8111
|
* @defaultValue chevron-double-right-o
|
|
@@ -8365,7 +8130,7 @@ interface components$d {
|
|
|
8365
8130
|
initialStage: string;
|
|
8366
8131
|
/** All stages of the workflow */
|
|
8367
8132
|
stages: {
|
|
8368
|
-
[key: string]: components$
|
|
8133
|
+
[key: string]: components$e["schemas"]["WorkflowStage"];
|
|
8369
8134
|
};
|
|
8370
8135
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
8371
8136
|
modified?: string;
|
|
@@ -8396,7 +8161,7 @@ interface components$d {
|
|
|
8396
8161
|
[name: string]: unknown;
|
|
8397
8162
|
};
|
|
8398
8163
|
content: {
|
|
8399
|
-
"application/json": components$
|
|
8164
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8400
8165
|
};
|
|
8401
8166
|
};
|
|
8402
8167
|
/** API key or token was not valid */
|
|
@@ -8405,7 +8170,7 @@ interface components$d {
|
|
|
8405
8170
|
[name: string]: unknown;
|
|
8406
8171
|
};
|
|
8407
8172
|
content: {
|
|
8408
|
-
"application/json": components$
|
|
8173
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8409
8174
|
};
|
|
8410
8175
|
};
|
|
8411
8176
|
/** Permission was denied */
|
|
@@ -8414,7 +8179,7 @@ interface components$d {
|
|
|
8414
8179
|
[name: string]: unknown;
|
|
8415
8180
|
};
|
|
8416
8181
|
content: {
|
|
8417
|
-
"application/json": components$
|
|
8182
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8418
8183
|
};
|
|
8419
8184
|
};
|
|
8420
8185
|
/** Too many requests in allowed time period */
|
|
@@ -8697,7 +8462,7 @@ interface components$d {
|
|
|
8697
8462
|
pathItems: never;
|
|
8698
8463
|
}
|
|
8699
8464
|
|
|
8700
|
-
interface paths$
|
|
8465
|
+
interface paths$c {
|
|
8701
8466
|
"/api/v1/canvas-history": {
|
|
8702
8467
|
parameters: {
|
|
8703
8468
|
query?: never;
|
|
@@ -8731,12 +8496,12 @@ interface paths$b {
|
|
|
8731
8496
|
[name: string]: unknown;
|
|
8732
8497
|
};
|
|
8733
8498
|
content: {
|
|
8734
|
-
"application/json": components$
|
|
8499
|
+
"application/json": components$d["schemas"]["HistoryApiResponse"];
|
|
8735
8500
|
};
|
|
8736
8501
|
};
|
|
8737
|
-
400: components$
|
|
8738
|
-
401: components$
|
|
8739
|
-
403: components$
|
|
8502
|
+
400: components$d["responses"]["BadRequestError"];
|
|
8503
|
+
401: components$d["responses"]["UnauthorizedError"];
|
|
8504
|
+
403: components$d["responses"]["ForbiddenError"];
|
|
8740
8505
|
/** Composition not found */
|
|
8741
8506
|
404: {
|
|
8742
8507
|
headers: {
|
|
@@ -8746,8 +8511,8 @@ interface paths$b {
|
|
|
8746
8511
|
"text/plain": string;
|
|
8747
8512
|
};
|
|
8748
8513
|
};
|
|
8749
|
-
429: components$
|
|
8750
|
-
500: components$
|
|
8514
|
+
429: components$d["responses"]["RateLimitError"];
|
|
8515
|
+
500: components$d["responses"]["InternalServerError"];
|
|
8751
8516
|
};
|
|
8752
8517
|
};
|
|
8753
8518
|
put?: never;
|
|
@@ -8759,7 +8524,7 @@ interface paths$b {
|
|
|
8759
8524
|
trace?: never;
|
|
8760
8525
|
};
|
|
8761
8526
|
}
|
|
8762
|
-
interface components$
|
|
8527
|
+
interface components$d {
|
|
8763
8528
|
schemas: {
|
|
8764
8529
|
HistoryEntry: {
|
|
8765
8530
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -8783,7 +8548,7 @@ interface components$c {
|
|
|
8783
8548
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
8784
8549
|
truncated?: boolean;
|
|
8785
8550
|
/** Version history entries */
|
|
8786
|
-
results?: components$
|
|
8551
|
+
results?: components$d["schemas"]["HistoryEntry"][];
|
|
8787
8552
|
};
|
|
8788
8553
|
Error: {
|
|
8789
8554
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -8797,7 +8562,7 @@ interface components$c {
|
|
|
8797
8562
|
[name: string]: unknown;
|
|
8798
8563
|
};
|
|
8799
8564
|
content: {
|
|
8800
|
-
"application/json": components$
|
|
8565
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8801
8566
|
};
|
|
8802
8567
|
};
|
|
8803
8568
|
/** API key or token was not valid */
|
|
@@ -8806,7 +8571,7 @@ interface components$c {
|
|
|
8806
8571
|
[name: string]: unknown;
|
|
8807
8572
|
};
|
|
8808
8573
|
content: {
|
|
8809
|
-
"application/json": components$
|
|
8574
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8810
8575
|
};
|
|
8811
8576
|
};
|
|
8812
8577
|
/** Permission was denied */
|
|
@@ -8815,7 +8580,7 @@ interface components$c {
|
|
|
8815
8580
|
[name: string]: unknown;
|
|
8816
8581
|
};
|
|
8817
8582
|
content: {
|
|
8818
|
-
"application/json": components$
|
|
8583
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8819
8584
|
};
|
|
8820
8585
|
};
|
|
8821
8586
|
/** Too many requests in allowed time period */
|
|
@@ -8839,41 +8604,41 @@ interface components$c {
|
|
|
8839
8604
|
pathItems: never;
|
|
8840
8605
|
}
|
|
8841
8606
|
|
|
8842
|
-
interface components$
|
|
8607
|
+
interface components$c {
|
|
8843
8608
|
schemas: {
|
|
8844
|
-
CompositionResolvedGetResponse: components$
|
|
8609
|
+
CompositionResolvedGetResponse: components$c["schemas"]["EdgehancersResolutionInfo"] & components$c["schemas"]["CompositionApiResponse"];
|
|
8845
8610
|
CompositionResolvedListResponse: {
|
|
8846
|
-
diagnostics?: components$
|
|
8611
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8847
8612
|
data?: {
|
|
8848
|
-
[key: string]: components$
|
|
8613
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8849
8614
|
};
|
|
8850
8615
|
};
|
|
8851
8616
|
errors?: {
|
|
8852
|
-
[key: string]: components$
|
|
8617
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8853
8618
|
};
|
|
8854
8619
|
warnings?: {
|
|
8855
|
-
[key: string]: components$
|
|
8620
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8856
8621
|
};
|
|
8857
8622
|
infos?: {
|
|
8858
|
-
[key: string]: components$
|
|
8623
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8859
8624
|
};
|
|
8860
|
-
} & components$
|
|
8625
|
+
} & components$c["schemas"]["CompositionListResponse"];
|
|
8861
8626
|
EntryResolvedListResponse: {
|
|
8862
|
-
diagnostics?: components$
|
|
8627
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8863
8628
|
data?: {
|
|
8864
|
-
[key: string]: components$
|
|
8629
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8865
8630
|
};
|
|
8866
8631
|
};
|
|
8867
8632
|
errors?: {
|
|
8868
|
-
[key: string]: components$
|
|
8633
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8869
8634
|
};
|
|
8870
8635
|
warnings?: {
|
|
8871
|
-
[key: string]: components$
|
|
8636
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8872
8637
|
};
|
|
8873
8638
|
infos?: {
|
|
8874
|
-
[key: string]: components$
|
|
8639
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8875
8640
|
};
|
|
8876
|
-
} & components$
|
|
8641
|
+
} & components$c["schemas"]["EntryListResponse"];
|
|
8877
8642
|
EdgehancersResolutionInfo: {
|
|
8878
8643
|
wholeResponseCacheDiagnostics?: {
|
|
8879
8644
|
info: string;
|
|
@@ -8882,19 +8647,19 @@ interface components$b {
|
|
|
8882
8647
|
edgeLocation?: string;
|
|
8883
8648
|
requestId: string;
|
|
8884
8649
|
};
|
|
8885
|
-
diagnostics?: components$
|
|
8886
|
-
data?: components$
|
|
8650
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8651
|
+
data?: components$c["schemas"]["DataDiagnostic"][];
|
|
8887
8652
|
};
|
|
8888
|
-
errors?: components$
|
|
8889
|
-
warnings?: components$
|
|
8890
|
-
infos?: components$
|
|
8653
|
+
errors?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8654
|
+
warnings?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8655
|
+
infos?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8891
8656
|
};
|
|
8892
8657
|
EdgehancersError: {
|
|
8893
8658
|
message: string;
|
|
8894
8659
|
status: number;
|
|
8895
8660
|
statusText: string;
|
|
8896
8661
|
};
|
|
8897
|
-
UniformError: components$
|
|
8662
|
+
UniformError: components$c["schemas"]["EdgehancersError"] | components$c["schemas"]["Error"];
|
|
8898
8663
|
InvalidationPayload: {
|
|
8899
8664
|
/** List of variables with values to invalidate */
|
|
8900
8665
|
variables?: {
|
|
@@ -8908,7 +8673,7 @@ interface components$b {
|
|
|
8908
8673
|
dataTypeId: string;
|
|
8909
8674
|
/** Format: uuid */
|
|
8910
8675
|
purgeKey: string;
|
|
8911
|
-
conditions?: components$
|
|
8676
|
+
conditions?: components$c["schemas"]["InvalidationPayload"];
|
|
8912
8677
|
}[];
|
|
8913
8678
|
DataDiagnostic: {
|
|
8914
8679
|
componentPath: string;
|
|
@@ -8968,7 +8733,7 @@ interface components$b {
|
|
|
8968
8733
|
message: string;
|
|
8969
8734
|
type: string;
|
|
8970
8735
|
parameterName?: string;
|
|
8971
|
-
expression?: components$
|
|
8736
|
+
expression?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
8972
8737
|
dataName?: string;
|
|
8973
8738
|
dataType?: string;
|
|
8974
8739
|
inputName?: string;
|
|
@@ -9043,11 +8808,11 @@ interface components$b {
|
|
|
9043
8808
|
|
|
9044
8809
|
*/
|
|
9045
8810
|
op?: "&" | "|";
|
|
9046
|
-
clauses: (components$
|
|
8811
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
9047
8812
|
};
|
|
9048
8813
|
/** Defines a conditional value for a component parameter */
|
|
9049
8814
|
ComponentParameterConditionalValue: {
|
|
9050
|
-
when: components$
|
|
8815
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
9051
8816
|
/**
|
|
9052
8817
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
9053
8818
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -9069,7 +8834,7 @@ interface components$b {
|
|
|
9069
8834
|
*
|
|
9070
8835
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
9071
8836
|
*/
|
|
9072
|
-
ComponentParameterConditions: components$
|
|
8837
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
9073
8838
|
/** Defines an editable parameter on a component */
|
|
9074
8839
|
ComponentParameter: {
|
|
9075
8840
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9077,7 +8842,7 @@ interface components$b {
|
|
|
9077
8842
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9078
8843
|
type: string;
|
|
9079
8844
|
/** @deprecated */
|
|
9080
|
-
connectedData?: components$
|
|
8845
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9081
8846
|
/**
|
|
9082
8847
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9083
8848
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -9085,10 +8850,10 @@ interface components$b {
|
|
|
9085
8850
|
locales?: {
|
|
9086
8851
|
[key: string]: unknown;
|
|
9087
8852
|
};
|
|
9088
|
-
conditions?: components$
|
|
8853
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
9089
8854
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
9090
8855
|
localesConditions?: {
|
|
9091
|
-
[key: string]: components$
|
|
8856
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
9092
8857
|
};
|
|
9093
8858
|
};
|
|
9094
8859
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9123,7 +8888,7 @@ interface components$b {
|
|
|
9123
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 */
|
|
9124
8889
|
isSearchHit?: boolean;
|
|
9125
8890
|
/** Query strings that are allowed to be passed to the node */
|
|
9126
|
-
queryStrings?: components$
|
|
8891
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9127
8892
|
/**
|
|
9128
8893
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
9129
8894
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -9148,7 +8913,7 @@ interface components$b {
|
|
|
9148
8913
|
* Unique identifier for the project map that this node belongs to
|
|
9149
8914
|
*/
|
|
9150
8915
|
projectMapId: string;
|
|
9151
|
-
data?: components$
|
|
8916
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
9152
8917
|
/**
|
|
9153
8918
|
* Locale-specific paths of the project map node.
|
|
9154
8919
|
* Keys are locale codes
|
|
@@ -9168,13 +8933,13 @@ interface components$b {
|
|
|
9168
8933
|
type: string;
|
|
9169
8934
|
/** Component parameter values for the component instance */
|
|
9170
8935
|
parameters?: {
|
|
9171
|
-
[key: string]: components$
|
|
8936
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9172
8937
|
};
|
|
9173
8938
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9174
8939
|
variant?: string;
|
|
9175
8940
|
/** Slots containing any child components */
|
|
9176
8941
|
slots?: {
|
|
9177
|
-
[key: string]: components$
|
|
8942
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9178
8943
|
};
|
|
9179
8944
|
/**
|
|
9180
8945
|
* Unique identifier of the component within the composition.
|
|
@@ -9185,20 +8950,20 @@ interface components$b {
|
|
|
9185
8950
|
_id?: string;
|
|
9186
8951
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
9187
8952
|
_pattern?: string;
|
|
9188
|
-
_dataResources?: components$
|
|
8953
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9189
8954
|
/**
|
|
9190
8955
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9191
8956
|
* Means nothing for PUTs; it will be ignored
|
|
9192
8957
|
*/
|
|
9193
8958
|
_patternDataResources?: {
|
|
9194
|
-
[key: string]: components$
|
|
8959
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9195
8960
|
};
|
|
9196
8961
|
/**
|
|
9197
8962
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9198
8963
|
* Means nothing for PUTs; it will be ignored
|
|
9199
8964
|
*/
|
|
9200
8965
|
_patternOptedInQueryStrings?: string[];
|
|
9201
|
-
_patternError?: components$
|
|
8966
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9202
8967
|
/**
|
|
9203
8968
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9204
8969
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9212,14 +8977,14 @@ interface components$b {
|
|
|
9212
8977
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9213
8978
|
*/
|
|
9214
8979
|
_overrides?: {
|
|
9215
|
-
[key: string]: components$
|
|
8980
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9216
8981
|
};
|
|
9217
8982
|
/**
|
|
9218
8983
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9219
8984
|
* Means nothing for PUTs; it will be ignored
|
|
9220
8985
|
*/
|
|
9221
8986
|
_patternOverrides?: {
|
|
9222
|
-
[key: string]: components$
|
|
8987
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9223
8988
|
};
|
|
9224
8989
|
/**
|
|
9225
8990
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9228,7 +8993,7 @@ interface components$b {
|
|
|
9228
8993
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9229
8994
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9230
8995
|
*/
|
|
9231
|
-
_overridability?: components$
|
|
8996
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9232
8997
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9233
8998
|
_locales?: string[];
|
|
9234
8999
|
};
|
|
@@ -9253,14 +9018,14 @@ interface components$b {
|
|
|
9253
9018
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9254
9019
|
*/
|
|
9255
9020
|
optionalPatternParameter?: boolean;
|
|
9256
|
-
variables?: components$
|
|
9021
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
9257
9022
|
};
|
|
9258
9023
|
/**
|
|
9259
9024
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9260
9025
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9261
9026
|
*/
|
|
9262
9027
|
DataResourceDefinitions: {
|
|
9263
|
-
[key: string]: components$
|
|
9028
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9264
9029
|
};
|
|
9265
9030
|
/**
|
|
9266
9031
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9278,10 +9043,10 @@ interface components$b {
|
|
|
9278
9043
|
*/
|
|
9279
9044
|
ComponentOverride: {
|
|
9280
9045
|
parameters?: {
|
|
9281
|
-
[key: string]: components$
|
|
9046
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9282
9047
|
};
|
|
9283
9048
|
slots?: {
|
|
9284
|
-
[key: string]: components$
|
|
9049
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9285
9050
|
};
|
|
9286
9051
|
variant?: string;
|
|
9287
9052
|
/**
|
|
@@ -9290,7 +9055,7 @@ interface components$b {
|
|
|
9290
9055
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9291
9056
|
*/
|
|
9292
9057
|
dataResources?: {
|
|
9293
|
-
[key: string]: components$
|
|
9058
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9294
9059
|
};
|
|
9295
9060
|
};
|
|
9296
9061
|
/**
|
|
@@ -9311,7 +9076,7 @@ interface components$b {
|
|
|
9311
9076
|
ComponentOverridability: {
|
|
9312
9077
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9313
9078
|
parameters?: {
|
|
9314
|
-
[key: string]: components$
|
|
9079
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
9315
9080
|
};
|
|
9316
9081
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9317
9082
|
variants?: boolean;
|
|
@@ -9328,15 +9093,15 @@ interface components$b {
|
|
|
9328
9093
|
type: string;
|
|
9329
9094
|
/** Component parameter values for the component instance */
|
|
9330
9095
|
parameters?: {
|
|
9331
|
-
[key: string]: components$
|
|
9096
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9332
9097
|
};
|
|
9333
9098
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9334
9099
|
variant?: string;
|
|
9335
9100
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9336
|
-
projectMapNodes?: components$
|
|
9101
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9337
9102
|
/** Slots containing any child components */
|
|
9338
9103
|
slots?: {
|
|
9339
|
-
[key: string]: components$
|
|
9104
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9340
9105
|
};
|
|
9341
9106
|
/** The ID of the composition */
|
|
9342
9107
|
_id: string;
|
|
@@ -9359,15 +9124,15 @@ interface components$b {
|
|
|
9359
9124
|
* Means nothing for PUTs; it will be ignored
|
|
9360
9125
|
*/
|
|
9361
9126
|
_patternDataResources?: {
|
|
9362
|
-
[key: string]: components$
|
|
9127
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9363
9128
|
};
|
|
9364
9129
|
/**
|
|
9365
9130
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9366
9131
|
* Means nothing for PUTs; it will be ignored
|
|
9367
9132
|
*/
|
|
9368
9133
|
_patternOptedInQueryStrings?: string[];
|
|
9369
|
-
_dataResources?: components$
|
|
9370
|
-
_patternError?: components$
|
|
9134
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9135
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9371
9136
|
/**
|
|
9372
9137
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9373
9138
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9381,14 +9146,14 @@ interface components$b {
|
|
|
9381
9146
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9382
9147
|
*/
|
|
9383
9148
|
_overrides?: {
|
|
9384
|
-
[key: string]: components$
|
|
9149
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9385
9150
|
};
|
|
9386
9151
|
/**
|
|
9387
9152
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9388
9153
|
* Means nothing for PUTs; it will be ignored
|
|
9389
9154
|
*/
|
|
9390
9155
|
_patternOverrides?: {
|
|
9391
|
-
[key: string]: components$
|
|
9156
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9392
9157
|
};
|
|
9393
9158
|
/**
|
|
9394
9159
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9397,7 +9162,7 @@ interface components$b {
|
|
|
9397
9162
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9398
9163
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9399
9164
|
*/
|
|
9400
|
-
_overridability?: components$
|
|
9165
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9401
9166
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9402
9167
|
_locales?: string[];
|
|
9403
9168
|
/**
|
|
@@ -9436,7 +9201,7 @@ interface components$b {
|
|
|
9436
9201
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9437
9202
|
*/
|
|
9438
9203
|
permissions: {
|
|
9439
|
-
[key: string]: components$
|
|
9204
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
9440
9205
|
};
|
|
9441
9206
|
};
|
|
9442
9207
|
/** Definition of a stage in a workflow */
|
|
@@ -9450,7 +9215,7 @@ interface components$b {
|
|
|
9450
9215
|
* listed here, the stage is read-only and publishing is disabled
|
|
9451
9216
|
*/
|
|
9452
9217
|
permissions: {
|
|
9453
|
-
[key: string]: components$
|
|
9218
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
9454
9219
|
};
|
|
9455
9220
|
/**
|
|
9456
9221
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -9470,7 +9235,7 @@ interface components$b {
|
|
|
9470
9235
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9471
9236
|
* has a stage that can never be escaped
|
|
9472
9237
|
*/
|
|
9473
|
-
transitions: components$
|
|
9238
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
9474
9239
|
/**
|
|
9475
9240
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9476
9241
|
* @defaultValue chevron-double-right-o
|
|
@@ -9495,7 +9260,7 @@ interface components$b {
|
|
|
9495
9260
|
initialStage: string;
|
|
9496
9261
|
/** All stages of the workflow */
|
|
9497
9262
|
stages: {
|
|
9498
|
-
[key: string]: components$
|
|
9263
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
9499
9264
|
};
|
|
9500
9265
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
9501
9266
|
modified?: string;
|
|
@@ -9543,6 +9308,8 @@ interface components$b {
|
|
|
9543
9308
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9544
9309
|
*/
|
|
9545
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;
|
|
9546
9313
|
/** User name of the creator of this composition */
|
|
9547
9314
|
creator?: string;
|
|
9548
9315
|
/** User name of the last editor of this composition */
|
|
@@ -9568,7 +9335,7 @@ interface components$b {
|
|
|
9568
9335
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
9569
9336
|
*/
|
|
9570
9337
|
releaseId?: string;
|
|
9571
|
-
composition: components$
|
|
9338
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
9572
9339
|
/**
|
|
9573
9340
|
* Format: uuid
|
|
9574
9341
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9579,8 +9346,14 @@ interface components$b {
|
|
|
9579
9346
|
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
9580
9347
|
*/
|
|
9581
9348
|
workflowStageId?: string;
|
|
9349
|
+
/**
|
|
9350
|
+
* Format: uuid
|
|
9351
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
9352
|
+
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
9353
|
+
*/
|
|
9354
|
+
instanceWorkflowId?: string;
|
|
9582
9355
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9583
|
-
workflowDefinition?: components$
|
|
9356
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9584
9357
|
/**
|
|
9585
9358
|
* Format: uuid
|
|
9586
9359
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9598,7 +9371,7 @@ interface components$b {
|
|
|
9598
9371
|
editionPriority?: number;
|
|
9599
9372
|
};
|
|
9600
9373
|
CompositionListResponse: {
|
|
9601
|
-
compositions: components$
|
|
9374
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
9602
9375
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
9603
9376
|
totalCount?: number;
|
|
9604
9377
|
/** Per-field counts for distinct values */
|
|
@@ -9659,10 +9432,10 @@ interface components$b {
|
|
|
9659
9432
|
RouteResponseRedirect: {
|
|
9660
9433
|
/** The route that was matched in the redirects */
|
|
9661
9434
|
matchedRoute: string;
|
|
9662
|
-
dynamicInputs?: components$
|
|
9435
|
+
dynamicInputs?: components$c["schemas"]["RouteDynamicInputs"];
|
|
9663
9436
|
/** @enum {string} */
|
|
9664
9437
|
type: "redirect";
|
|
9665
|
-
redirect: components$
|
|
9438
|
+
redirect: components$c["schemas"]["Redirect"];
|
|
9666
9439
|
};
|
|
9667
9440
|
/**
|
|
9668
9441
|
* The route does not match any configured redirections or compositions.
|
|
@@ -9702,15 +9475,15 @@ interface components$b {
|
|
|
9702
9475
|
_locales?: string[];
|
|
9703
9476
|
/** Entry field values */
|
|
9704
9477
|
fields?: {
|
|
9705
|
-
[key: string]: components$
|
|
9478
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9706
9479
|
};
|
|
9707
|
-
_dataResources?: components$
|
|
9480
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9708
9481
|
/**
|
|
9709
9482
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9710
9483
|
* Means nothing for PUTs; it will be ignored
|
|
9711
9484
|
*/
|
|
9712
9485
|
_patternDataResources?: {
|
|
9713
|
-
[key: string]: components$
|
|
9486
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9714
9487
|
};
|
|
9715
9488
|
/**
|
|
9716
9489
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9733,7 +9506,7 @@ interface components$b {
|
|
|
9733
9506
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9734
9507
|
*/
|
|
9735
9508
|
_overrides?: {
|
|
9736
|
-
[key: string]: components$
|
|
9509
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9737
9510
|
};
|
|
9738
9511
|
/**
|
|
9739
9512
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9742,7 +9515,7 @@ interface components$b {
|
|
|
9742
9515
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9743
9516
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9744
9517
|
*/
|
|
9745
|
-
_overridability?: components$
|
|
9518
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9746
9519
|
};
|
|
9747
9520
|
EntryApiResponse: {
|
|
9748
9521
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -9778,12 +9551,14 @@ interface components$b {
|
|
|
9778
9551
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9779
9552
|
*/
|
|
9780
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;
|
|
9781
9556
|
/**
|
|
9782
9557
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
9783
9558
|
* @defaultValue false
|
|
9784
9559
|
*/
|
|
9785
9560
|
pattern?: boolean;
|
|
9786
|
-
entry: components$
|
|
9561
|
+
entry: components$c["schemas"]["Entry"];
|
|
9787
9562
|
/**
|
|
9788
9563
|
* Format: uuid
|
|
9789
9564
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -9794,8 +9569,14 @@ interface components$b {
|
|
|
9794
9569
|
* The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
|
|
9795
9570
|
*/
|
|
9796
9571
|
workflowStageId?: string;
|
|
9572
|
+
/**
|
|
9573
|
+
* Format: uuid
|
|
9574
|
+
* The workflow that entries created from this pattern start in. This is not the workflow
|
|
9575
|
+
* the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
|
|
9576
|
+
*/
|
|
9577
|
+
instanceWorkflowId?: string;
|
|
9797
9578
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
9798
|
-
workflowDefinition?: components$
|
|
9579
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9799
9580
|
/**
|
|
9800
9581
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
9801
9582
|
|
|
@@ -9818,7 +9599,7 @@ interface components$b {
|
|
|
9818
9599
|
editionPriority?: number;
|
|
9819
9600
|
};
|
|
9820
9601
|
EntryListResponse: {
|
|
9821
|
-
entries: components$
|
|
9602
|
+
entries: components$c["schemas"]["EntryApiResponse"][];
|
|
9822
9603
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
9823
9604
|
totalCount?: number;
|
|
9824
9605
|
/** Per-field counts for distinct values */
|
|
@@ -9836,7 +9617,7 @@ interface components$b {
|
|
|
9836
9617
|
[name: string]: unknown;
|
|
9837
9618
|
};
|
|
9838
9619
|
content: {
|
|
9839
|
-
"application/json": components$
|
|
9620
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9840
9621
|
};
|
|
9841
9622
|
};
|
|
9842
9623
|
/** Provided token or API key does not have access to the requested resource */
|
|
@@ -9845,7 +9626,7 @@ interface components$b {
|
|
|
9845
9626
|
[name: string]: unknown;
|
|
9846
9627
|
};
|
|
9847
9628
|
content: {
|
|
9848
|
-
"application/json": components$
|
|
9629
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9849
9630
|
};
|
|
9850
9631
|
};
|
|
9851
9632
|
/** Provided token or API key does not allow this action */
|
|
@@ -9854,7 +9635,7 @@ interface components$b {
|
|
|
9854
9635
|
[name: string]: unknown;
|
|
9855
9636
|
};
|
|
9856
9637
|
content: {
|
|
9857
|
-
"application/json": components$
|
|
9638
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9858
9639
|
};
|
|
9859
9640
|
};
|
|
9860
9641
|
/** The requested resource does not exist */
|
|
@@ -9863,7 +9644,7 @@ interface components$b {
|
|
|
9863
9644
|
[name: string]: unknown;
|
|
9864
9645
|
};
|
|
9865
9646
|
content: {
|
|
9866
|
-
"application/json": components$
|
|
9647
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9867
9648
|
};
|
|
9868
9649
|
};
|
|
9869
9650
|
/** Invalid method was used to call the endpoint */
|
|
@@ -9872,7 +9653,7 @@ interface components$b {
|
|
|
9872
9653
|
[name: string]: unknown;
|
|
9873
9654
|
};
|
|
9874
9655
|
content: {
|
|
9875
|
-
"application/json": components$
|
|
9656
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9876
9657
|
};
|
|
9877
9658
|
};
|
|
9878
9659
|
/** The request body could not be parsed or understood */
|
|
@@ -9881,7 +9662,7 @@ interface components$b {
|
|
|
9881
9662
|
[name: string]: unknown;
|
|
9882
9663
|
};
|
|
9883
9664
|
content: {
|
|
9884
|
-
"application/json": components$
|
|
9665
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9885
9666
|
};
|
|
9886
9667
|
};
|
|
9887
9668
|
/** The endpoint is called too often */
|
|
@@ -9890,7 +9671,7 @@ interface components$b {
|
|
|
9890
9671
|
[name: string]: unknown;
|
|
9891
9672
|
};
|
|
9892
9673
|
content: {
|
|
9893
|
-
"application/json": components$
|
|
9674
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9894
9675
|
};
|
|
9895
9676
|
};
|
|
9896
9677
|
/** An unexpected error occurred */
|
|
@@ -9899,7 +9680,7 @@ interface components$b {
|
|
|
9899
9680
|
[name: string]: unknown;
|
|
9900
9681
|
};
|
|
9901
9682
|
content: {
|
|
9902
|
-
"application/json": components$
|
|
9683
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9903
9684
|
};
|
|
9904
9685
|
};
|
|
9905
9686
|
};
|
|
@@ -10209,7 +9990,7 @@ interface components$b {
|
|
|
10209
9990
|
pathItems: never;
|
|
10210
9991
|
}
|
|
10211
9992
|
|
|
10212
|
-
interface paths$
|
|
9993
|
+
interface paths$b {
|
|
10213
9994
|
"/api/v1/route": {
|
|
10214
9995
|
parameters: {
|
|
10215
9996
|
query?: never;
|
|
@@ -10275,7 +10056,7 @@ interface paths$a {
|
|
|
10275
10056
|
parameters: {
|
|
10276
10057
|
query: {
|
|
10277
10058
|
/** The project to fetch a route from */
|
|
10278
|
-
projectId: components$
|
|
10059
|
+
projectId: components$b["parameters"]["projectId"];
|
|
10279
10060
|
/**
|
|
10280
10061
|
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10281
10062
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
@@ -10306,21 +10087,21 @@ interface paths$a {
|
|
|
10306
10087
|
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10307
10088
|
* project map node or redirect would match them.
|
|
10308
10089
|
*/
|
|
10309
|
-
path: components$
|
|
10090
|
+
path: components$b["parameters"]["path"];
|
|
10310
10091
|
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10311
|
-
projectMapId?: components$
|
|
10092
|
+
projectMapId?: components$b["parameters"]["projectMapId"];
|
|
10312
10093
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10313
|
-
state?: components$
|
|
10094
|
+
state?: components$b["parameters"]["state"];
|
|
10314
10095
|
/**
|
|
10315
10096
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10316
10097
|
* If false, the `_id` will not be present in the API response
|
|
10317
10098
|
*/
|
|
10318
|
-
withComponentIDs?: components$
|
|
10099
|
+
withComponentIDs?: components$b["parameters"]["withComponentIDs"];
|
|
10319
10100
|
/**
|
|
10320
10101
|
* @deprecated
|
|
10321
10102
|
* Has no effect.
|
|
10322
10103
|
*/
|
|
10323
|
-
withContentSourceMap?: components$
|
|
10104
|
+
withContentSourceMap?: components$b["parameters"]["withContentSourceMap"];
|
|
10324
10105
|
/**
|
|
10325
10106
|
* One or more locales to localize the response to.
|
|
10326
10107
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
@@ -10337,7 +10118,7 @@ interface paths$a {
|
|
|
10337
10118
|
*
|
|
10338
10119
|
* When the result is a redirect, this parameter has no effect
|
|
10339
10120
|
*/
|
|
10340
|
-
locale?: components$
|
|
10121
|
+
locale?: components$b["parameters"]["locale"];
|
|
10341
10122
|
/**
|
|
10342
10123
|
* The ID of a release to fetch the content for.
|
|
10343
10124
|
*
|
|
@@ -10346,19 +10127,19 @@ interface paths$a {
|
|
|
10346
10127
|
*
|
|
10347
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
|
|
10348
10129
|
*/
|
|
10349
|
-
releaseId?: components$
|
|
10130
|
+
releaseId?: components$b["parameters"]["releaseId"];
|
|
10350
10131
|
/**
|
|
10351
10132
|
* Indicates the data variant that was fetched for data resources.
|
|
10352
10133
|
* undefined: Data resources were resolved using published data from their data source
|
|
10353
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.
|
|
10354
10135
|
*/
|
|
10355
|
-
dataSourceVariant?: components$
|
|
10136
|
+
dataSourceVariant?: components$b["parameters"]["dataSourceVariant"];
|
|
10356
10137
|
/**
|
|
10357
10138
|
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
10358
10139
|
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
10359
10140
|
* that have redirects configured on their paths.
|
|
10360
10141
|
*/
|
|
10361
|
-
ignoreRedirects?: components$
|
|
10142
|
+
ignoreRedirects?: components$b["parameters"]["ignoreRedirects"];
|
|
10362
10143
|
};
|
|
10363
10144
|
header?: never;
|
|
10364
10145
|
path?: never;
|
|
@@ -10372,14 +10153,14 @@ interface paths$a {
|
|
|
10372
10153
|
[name: string]: unknown;
|
|
10373
10154
|
};
|
|
10374
10155
|
content: {
|
|
10375
|
-
"application/json": components$
|
|
10156
|
+
"application/json": components$b["schemas"]["RouteResponse"];
|
|
10376
10157
|
};
|
|
10377
10158
|
};
|
|
10378
|
-
400: components$
|
|
10379
|
-
401: components$
|
|
10380
|
-
403: components$
|
|
10381
|
-
429: components$
|
|
10382
|
-
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"];
|
|
10383
10164
|
};
|
|
10384
10165
|
};
|
|
10385
10166
|
put?: never;
|
|
@@ -10409,7 +10190,7 @@ interface paths$a {
|
|
|
10409
10190
|
trace?: never;
|
|
10410
10191
|
};
|
|
10411
10192
|
}
|
|
10412
|
-
interface components$
|
|
10193
|
+
interface components$b {
|
|
10413
10194
|
schemas: {
|
|
10414
10195
|
RouteDynamicInputs: {
|
|
10415
10196
|
[key: string]: string;
|
|
@@ -10458,10 +10239,10 @@ interface components$a {
|
|
|
10458
10239
|
RouteResponseRedirect: {
|
|
10459
10240
|
/** The route that was matched in the redirects */
|
|
10460
10241
|
matchedRoute: string;
|
|
10461
|
-
dynamicInputs?: components$
|
|
10242
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10462
10243
|
/** @enum {string} */
|
|
10463
10244
|
type: "redirect";
|
|
10464
|
-
redirect: components$
|
|
10245
|
+
redirect: components$b["schemas"]["Redirect"];
|
|
10465
10246
|
};
|
|
10466
10247
|
/** Defines a connection to a dynamic token on a data resource */
|
|
10467
10248
|
DataElementConnectionDefinition: {
|
|
@@ -10527,11 +10308,11 @@ interface components$a {
|
|
|
10527
10308
|
|
|
10528
10309
|
*/
|
|
10529
10310
|
op?: "&" | "|";
|
|
10530
|
-
clauses: (components$
|
|
10311
|
+
clauses: (components$b["schemas"]["VisibilityCriteria"] | components$b["schemas"]["VisibilityCriteriaGroup"])[];
|
|
10531
10312
|
};
|
|
10532
10313
|
/** Defines a conditional value for a component parameter */
|
|
10533
10314
|
ComponentParameterConditionalValue: {
|
|
10534
|
-
when: components$
|
|
10315
|
+
when: components$b["schemas"]["VisibilityCriteriaGroup"];
|
|
10535
10316
|
/**
|
|
10536
10317
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
10537
10318
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -10553,7 +10334,7 @@ interface components$a {
|
|
|
10553
10334
|
*
|
|
10554
10335
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
10555
10336
|
*/
|
|
10556
|
-
ComponentParameterConditions: components$
|
|
10337
|
+
ComponentParameterConditions: components$b["schemas"]["ComponentParameterConditionalValue"][];
|
|
10557
10338
|
/** Defines an editable parameter on a component */
|
|
10558
10339
|
ComponentParameter: {
|
|
10559
10340
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -10561,7 +10342,7 @@ interface components$a {
|
|
|
10561
10342
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
10562
10343
|
type: string;
|
|
10563
10344
|
/** @deprecated */
|
|
10564
|
-
connectedData?: components$
|
|
10345
|
+
connectedData?: components$b["schemas"]["DataElementConnectionDefinition"];
|
|
10565
10346
|
/**
|
|
10566
10347
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
10567
10348
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -10569,10 +10350,10 @@ interface components$a {
|
|
|
10569
10350
|
locales?: {
|
|
10570
10351
|
[key: string]: unknown;
|
|
10571
10352
|
};
|
|
10572
|
-
conditions?: components$
|
|
10353
|
+
conditions?: components$b["schemas"]["ComponentParameterConditions"];
|
|
10573
10354
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
10574
10355
|
localesConditions?: {
|
|
10575
|
-
[key: string]: components$
|
|
10356
|
+
[key: string]: components$b["schemas"]["ComponentParameterConditions"];
|
|
10576
10357
|
};
|
|
10577
10358
|
};
|
|
10578
10359
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -10607,7 +10388,7 @@ interface components$a {
|
|
|
10607
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 */
|
|
10608
10389
|
isSearchHit?: boolean;
|
|
10609
10390
|
/** Query strings that are allowed to be passed to the node */
|
|
10610
|
-
queryStrings?: components$
|
|
10391
|
+
queryStrings?: components$b["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
10611
10392
|
/**
|
|
10612
10393
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
10613
10394
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -10632,7 +10413,7 @@ interface components$a {
|
|
|
10632
10413
|
* Unique identifier for the project map that this node belongs to
|
|
10633
10414
|
*/
|
|
10634
10415
|
projectMapId: string;
|
|
10635
|
-
data?: components$
|
|
10416
|
+
data?: components$b["schemas"]["ProjectMapNodeData"];
|
|
10636
10417
|
/**
|
|
10637
10418
|
* Locale-specific paths of the project map node.
|
|
10638
10419
|
* Keys are locale codes
|
|
@@ -10652,13 +10433,13 @@ interface components$a {
|
|
|
10652
10433
|
type: string;
|
|
10653
10434
|
/** Component parameter values for the component instance */
|
|
10654
10435
|
parameters?: {
|
|
10655
|
-
[key: string]: components$
|
|
10436
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10656
10437
|
};
|
|
10657
10438
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10658
10439
|
variant?: string;
|
|
10659
10440
|
/** Slots containing any child components */
|
|
10660
10441
|
slots?: {
|
|
10661
|
-
[key: string]: components$
|
|
10442
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10662
10443
|
};
|
|
10663
10444
|
/**
|
|
10664
10445
|
* Unique identifier of the component within the composition.
|
|
@@ -10669,20 +10450,20 @@ interface components$a {
|
|
|
10669
10450
|
_id?: string;
|
|
10670
10451
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10671
10452
|
_pattern?: string;
|
|
10672
|
-
_dataResources?: components$
|
|
10453
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10673
10454
|
/**
|
|
10674
10455
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10675
10456
|
* Means nothing for PUTs; it will be ignored
|
|
10676
10457
|
*/
|
|
10677
10458
|
_patternDataResources?: {
|
|
10678
|
-
[key: string]: components$
|
|
10459
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10679
10460
|
};
|
|
10680
10461
|
/**
|
|
10681
10462
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10682
10463
|
* Means nothing for PUTs; it will be ignored
|
|
10683
10464
|
*/
|
|
10684
10465
|
_patternOptedInQueryStrings?: string[];
|
|
10685
|
-
_patternError?: components$
|
|
10466
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10686
10467
|
/**
|
|
10687
10468
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10688
10469
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10696,14 +10477,14 @@ interface components$a {
|
|
|
10696
10477
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10697
10478
|
*/
|
|
10698
10479
|
_overrides?: {
|
|
10699
|
-
[key: string]: components$
|
|
10480
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10700
10481
|
};
|
|
10701
10482
|
/**
|
|
10702
10483
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10703
10484
|
* Means nothing for PUTs; it will be ignored
|
|
10704
10485
|
*/
|
|
10705
10486
|
_patternOverrides?: {
|
|
10706
|
-
[key: string]: components$
|
|
10487
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10707
10488
|
};
|
|
10708
10489
|
/**
|
|
10709
10490
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10712,7 +10493,7 @@ interface components$a {
|
|
|
10712
10493
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10713
10494
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10714
10495
|
*/
|
|
10715
|
-
_overridability?: components$
|
|
10496
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10716
10497
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
10717
10498
|
_locales?: string[];
|
|
10718
10499
|
};
|
|
@@ -10737,14 +10518,14 @@ interface components$a {
|
|
|
10737
10518
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
10738
10519
|
*/
|
|
10739
10520
|
optionalPatternParameter?: boolean;
|
|
10740
|
-
variables?: components$
|
|
10521
|
+
variables?: components$b["schemas"]["DataResourceVariables"];
|
|
10741
10522
|
};
|
|
10742
10523
|
/**
|
|
10743
10524
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
10744
10525
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
10745
10526
|
*/
|
|
10746
10527
|
DataResourceDefinitions: {
|
|
10747
|
-
[key: string]: components$
|
|
10528
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10748
10529
|
};
|
|
10749
10530
|
/**
|
|
10750
10531
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -10762,10 +10543,10 @@ interface components$a {
|
|
|
10762
10543
|
*/
|
|
10763
10544
|
ComponentOverride: {
|
|
10764
10545
|
parameters?: {
|
|
10765
|
-
[key: string]: components$
|
|
10546
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10766
10547
|
};
|
|
10767
10548
|
slots?: {
|
|
10768
|
-
[key: string]: components$
|
|
10549
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10769
10550
|
};
|
|
10770
10551
|
variant?: string;
|
|
10771
10552
|
/**
|
|
@@ -10774,7 +10555,7 @@ interface components$a {
|
|
|
10774
10555
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
10775
10556
|
*/
|
|
10776
10557
|
dataResources?: {
|
|
10777
|
-
[key: string]: components$
|
|
10558
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10778
10559
|
};
|
|
10779
10560
|
};
|
|
10780
10561
|
/**
|
|
@@ -10795,7 +10576,7 @@ interface components$a {
|
|
|
10795
10576
|
ComponentOverridability: {
|
|
10796
10577
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
10797
10578
|
parameters?: {
|
|
10798
|
-
[key: string]: components$
|
|
10579
|
+
[key: string]: components$b["schemas"]["OverrideOptions"];
|
|
10799
10580
|
};
|
|
10800
10581
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
10801
10582
|
variants?: boolean;
|
|
@@ -10812,15 +10593,15 @@ interface components$a {
|
|
|
10812
10593
|
type: string;
|
|
10813
10594
|
/** Component parameter values for the component instance */
|
|
10814
10595
|
parameters?: {
|
|
10815
|
-
[key: string]: components$
|
|
10596
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10816
10597
|
};
|
|
10817
10598
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10818
10599
|
variant?: string;
|
|
10819
10600
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
10820
|
-
projectMapNodes?: components$
|
|
10601
|
+
projectMapNodes?: components$b["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
10821
10602
|
/** Slots containing any child components */
|
|
10822
10603
|
slots?: {
|
|
10823
|
-
[key: string]: components$
|
|
10604
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10824
10605
|
};
|
|
10825
10606
|
/** The ID of the composition */
|
|
10826
10607
|
_id: string;
|
|
@@ -10843,15 +10624,15 @@ interface components$a {
|
|
|
10843
10624
|
* Means nothing for PUTs; it will be ignored
|
|
10844
10625
|
*/
|
|
10845
10626
|
_patternDataResources?: {
|
|
10846
|
-
[key: string]: components$
|
|
10627
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10847
10628
|
};
|
|
10848
10629
|
/**
|
|
10849
10630
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10850
10631
|
* Means nothing for PUTs; it will be ignored
|
|
10851
10632
|
*/
|
|
10852
10633
|
_patternOptedInQueryStrings?: string[];
|
|
10853
|
-
_dataResources?: components$
|
|
10854
|
-
_patternError?: components$
|
|
10634
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10635
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10855
10636
|
/**
|
|
10856
10637
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10857
10638
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10865,14 +10646,14 @@ interface components$a {
|
|
|
10865
10646
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10866
10647
|
*/
|
|
10867
10648
|
_overrides?: {
|
|
10868
|
-
[key: string]: components$
|
|
10649
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10869
10650
|
};
|
|
10870
10651
|
/**
|
|
10871
10652
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10872
10653
|
* Means nothing for PUTs; it will be ignored
|
|
10873
10654
|
*/
|
|
10874
10655
|
_patternOverrides?: {
|
|
10875
|
-
[key: string]: components$
|
|
10656
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10876
10657
|
};
|
|
10877
10658
|
/**
|
|
10878
10659
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10881,7 +10662,7 @@ interface components$a {
|
|
|
10881
10662
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10882
10663
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10883
10664
|
*/
|
|
10884
|
-
_overridability?: components$
|
|
10665
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10885
10666
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
10886
10667
|
_locales?: string[];
|
|
10887
10668
|
/**
|
|
@@ -10920,7 +10701,7 @@ interface components$a {
|
|
|
10920
10701
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
10921
10702
|
*/
|
|
10922
10703
|
permissions: {
|
|
10923
|
-
[key: string]: components$
|
|
10704
|
+
[key: string]: components$b["schemas"]["WorkflowStageTransitionPermission"];
|
|
10924
10705
|
};
|
|
10925
10706
|
};
|
|
10926
10707
|
/** Definition of a stage in a workflow */
|
|
@@ -10934,7 +10715,7 @@ interface components$a {
|
|
|
10934
10715
|
* listed here, the stage is read-only and publishing is disabled
|
|
10935
10716
|
*/
|
|
10936
10717
|
permissions: {
|
|
10937
|
-
[key: string]: components$
|
|
10718
|
+
[key: string]: components$b["schemas"]["WorkflowStagePermission"];
|
|
10938
10719
|
};
|
|
10939
10720
|
/**
|
|
10940
10721
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -10954,7 +10735,7 @@ interface components$a {
|
|
|
10954
10735
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
10955
10736
|
* has a stage that can never be escaped
|
|
10956
10737
|
*/
|
|
10957
|
-
transitions: components$
|
|
10738
|
+
transitions: components$b["schemas"]["WorkflowStageTransition"][];
|
|
10958
10739
|
/**
|
|
10959
10740
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
10960
10741
|
* @defaultValue chevron-double-right-o
|
|
@@ -10979,7 +10760,7 @@ interface components$a {
|
|
|
10979
10760
|
initialStage: string;
|
|
10980
10761
|
/** All stages of the workflow */
|
|
10981
10762
|
stages: {
|
|
10982
|
-
[key: string]: components$
|
|
10763
|
+
[key: string]: components$b["schemas"]["WorkflowStage"];
|
|
10983
10764
|
};
|
|
10984
10765
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
10985
10766
|
modified?: string;
|
|
@@ -11027,6 +10808,8 @@ interface components$a {
|
|
|
11027
10808
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
11028
10809
|
*/
|
|
11029
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;
|
|
11030
10813
|
/** User name of the creator of this composition */
|
|
11031
10814
|
creator?: string;
|
|
11032
10815
|
/** User name of the last editor of this composition */
|
|
@@ -11052,7 +10835,7 @@ interface components$a {
|
|
|
11052
10835
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
11053
10836
|
*/
|
|
11054
10837
|
releaseId?: string;
|
|
11055
|
-
composition: components$
|
|
10838
|
+
composition: components$b["schemas"]["RootComponentInstance"];
|
|
11056
10839
|
/**
|
|
11057
10840
|
* Format: uuid
|
|
11058
10841
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -11063,8 +10846,14 @@ interface components$a {
|
|
|
11063
10846
|
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
11064
10847
|
*/
|
|
11065
10848
|
workflowStageId?: string;
|
|
10849
|
+
/**
|
|
10850
|
+
* Format: uuid
|
|
10851
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
10852
|
+
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
10853
|
+
*/
|
|
10854
|
+
instanceWorkflowId?: string;
|
|
11066
10855
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
11067
|
-
workflowDefinition?: components$
|
|
10856
|
+
workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
|
|
11068
10857
|
/**
|
|
11069
10858
|
* Format: uuid
|
|
11070
10859
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -11088,7 +10877,7 @@ interface components$a {
|
|
|
11088
10877
|
RouteResponseComposition: {
|
|
11089
10878
|
/** The route that was matched in the project map */
|
|
11090
10879
|
matchedRoute: string;
|
|
11091
|
-
dynamicInputs?: components$
|
|
10880
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
11092
10881
|
/**
|
|
11093
10882
|
* Indicates the data variant that was fetched for data resources.
|
|
11094
10883
|
* undefined: Data resources were resolved using published data from their data source
|
|
@@ -11098,7 +10887,7 @@ interface components$a {
|
|
|
11098
10887
|
dataResourcesVariant?: "unpublished";
|
|
11099
10888
|
/** @enum {string} */
|
|
11100
10889
|
type: "composition";
|
|
11101
|
-
compositionApiResponse: components$
|
|
10890
|
+
compositionApiResponse: components$b["schemas"]["CompositionApiResponse"];
|
|
11102
10891
|
};
|
|
11103
10892
|
/**
|
|
11104
10893
|
* The route does not match any configured redirections or compositions.
|
|
@@ -11109,7 +10898,7 @@ interface components$a {
|
|
|
11109
10898
|
/** @enum {string} */
|
|
11110
10899
|
type: "notFound";
|
|
11111
10900
|
};
|
|
11112
|
-
RouteResponse: components$
|
|
10901
|
+
RouteResponse: components$b["schemas"]["RouteResponseRedirect"] | components$b["schemas"]["RouteResponseComposition"] | components$b["schemas"]["RouteResponseNotFound"];
|
|
11113
10902
|
Error: {
|
|
11114
10903
|
/** Error message(s) that occurred while processing the request */
|
|
11115
10904
|
errorMessage?: string[] | string;
|
|
@@ -11122,7 +10911,7 @@ interface components$a {
|
|
|
11122
10911
|
[name: string]: unknown;
|
|
11123
10912
|
};
|
|
11124
10913
|
content: {
|
|
11125
|
-
"application/json": components$
|
|
10914
|
+
"application/json": components$b["schemas"]["Error"];
|
|
11126
10915
|
};
|
|
11127
10916
|
};
|
|
11128
10917
|
/** API key or token was not valid */
|
|
@@ -11131,7 +10920,7 @@ interface components$a {
|
|
|
11131
10920
|
[name: string]: unknown;
|
|
11132
10921
|
};
|
|
11133
10922
|
content: {
|
|
11134
|
-
"application/json": components$
|
|
10923
|
+
"application/json": components$b["schemas"]["Error"];
|
|
11135
10924
|
};
|
|
11136
10925
|
};
|
|
11137
10926
|
/** Permission was denied */
|
|
@@ -11140,7 +10929,7 @@ interface components$a {
|
|
|
11140
10929
|
[name: string]: unknown;
|
|
11141
10930
|
};
|
|
11142
10931
|
content: {
|
|
11143
|
-
"application/json": components$
|
|
10932
|
+
"application/json": components$b["schemas"]["Error"];
|
|
11144
10933
|
};
|
|
11145
10934
|
};
|
|
11146
10935
|
/** Too many requests in allowed time period */
|
|
@@ -11250,10 +11039,294 @@ interface components$a {
|
|
|
11250
11039
|
pathItems: never;
|
|
11251
11040
|
}
|
|
11252
11041
|
|
|
11253
|
-
|
|
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
|
+
};
|
|
11233
|
+
};
|
|
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
|
+
};
|
|
11252
|
+
};
|
|
11253
|
+
head?: never;
|
|
11254
|
+
patch?: never;
|
|
11255
|
+
trace?: never;
|
|
11256
|
+
};
|
|
11257
|
+
}
|
|
11258
|
+
interface components$a {
|
|
11259
|
+
schemas: {
|
|
11260
|
+
Error: {
|
|
11261
|
+
/** Error message(s) that occurred while processing the request */
|
|
11262
|
+
errorMessage?: string[] | string;
|
|
11263
|
+
};
|
|
11264
|
+
};
|
|
11265
|
+
responses: {
|
|
11266
|
+
/** Request input validation failed */
|
|
11267
|
+
BadRequestError: {
|
|
11268
|
+
headers: {
|
|
11269
|
+
[name: string]: unknown;
|
|
11270
|
+
};
|
|
11271
|
+
content: {
|
|
11272
|
+
"application/json": components$a["schemas"]["Error"];
|
|
11273
|
+
};
|
|
11274
|
+
};
|
|
11275
|
+
/** API key or token was not valid */
|
|
11276
|
+
UnauthorizedError: {
|
|
11277
|
+
headers: {
|
|
11278
|
+
[name: string]: unknown;
|
|
11279
|
+
};
|
|
11280
|
+
content: {
|
|
11281
|
+
"application/json": components$a["schemas"]["Error"];
|
|
11282
|
+
};
|
|
11283
|
+
};
|
|
11284
|
+
/** Permission was denied */
|
|
11285
|
+
ForbiddenError: {
|
|
11286
|
+
headers: {
|
|
11287
|
+
[name: string]: unknown;
|
|
11288
|
+
};
|
|
11289
|
+
content: {
|
|
11290
|
+
"application/json": components$a["schemas"]["Error"];
|
|
11291
|
+
};
|
|
11292
|
+
};
|
|
11293
|
+
/** Too many requests in allowed time period */
|
|
11294
|
+
RateLimitError: {
|
|
11295
|
+
headers: {
|
|
11296
|
+
[name: string]: unknown;
|
|
11297
|
+
};
|
|
11298
|
+
content?: never;
|
|
11299
|
+
};
|
|
11300
|
+
/** Execution error occurred */
|
|
11301
|
+
InternalServerError: {
|
|
11302
|
+
headers: {
|
|
11303
|
+
[name: string]: unknown;
|
|
11304
|
+
};
|
|
11305
|
+
content?: never;
|
|
11306
|
+
};
|
|
11307
|
+
};
|
|
11308
|
+
parameters: never;
|
|
11309
|
+
requestBodies: never;
|
|
11310
|
+
headers: never;
|
|
11311
|
+
pathItems: never;
|
|
11312
|
+
}
|
|
11313
|
+
|
|
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'];
|
|
11254
11327
|
type SharedComponents$1 = components$r['schemas'];
|
|
11255
|
-
type Api = paths$
|
|
11256
|
-
type HistoryApi = paths$
|
|
11328
|
+
type Api = paths$d['/api/v1/canvas'];
|
|
11329
|
+
type HistoryApi = paths$c['/api/v1/canvas-history'];
|
|
11257
11330
|
/** Query parameter options for GET /api/v1/canvas */
|
|
11258
11331
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
11259
11332
|
type?: string | string[];
|
|
@@ -11372,6 +11445,37 @@ type CopiedComponentSubtree = {
|
|
|
11372
11445
|
* Defines how a component on a pattern may have its values overridden
|
|
11373
11446
|
*/
|
|
11374
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
|
+
}
|
|
11375
11479
|
/**
|
|
11376
11480
|
* Defines the shape of serialized webhook
|
|
11377
11481
|
*/
|
|
@@ -11442,7 +11546,7 @@ type DataResolutionParameters = {
|
|
|
11442
11546
|
};
|
|
11443
11547
|
/** Types of issue that can occur when fetching composition data */
|
|
11444
11548
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
11445
|
-
type DataResolutionIssueCore = components$
|
|
11549
|
+
type DataResolutionIssueCore = components$c['schemas']['DataResolutionIssue'];
|
|
11446
11550
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
11447
11551
|
type PatternIssue = DataResolutionIssueCore & {
|
|
11448
11552
|
type: 'pattern';
|
|
@@ -11496,26 +11600,26 @@ type DataResolutionConfigIssue = {
|
|
|
11496
11600
|
type: 'config';
|
|
11497
11601
|
};
|
|
11498
11602
|
/** Diagnostics about edge request processing */
|
|
11499
|
-
type EdgehancersDiagnostics = components$
|
|
11500
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
11603
|
+
type EdgehancersDiagnostics = components$c['schemas']['EdgehancersDiagnostics'];
|
|
11604
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$c['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
11501
11605
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
11502
|
-
type DataDiagnostic = components$
|
|
11606
|
+
type DataDiagnostic = components$c['schemas']['DataDiagnostic'];
|
|
11503
11607
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
11504
|
-
type CompositionResolvedGetResponse = components$
|
|
11505
|
-
type CompositionResolvedListResponse = components$
|
|
11608
|
+
type CompositionResolvedGetResponse = components$c['schemas']['CompositionResolvedGetResponse'];
|
|
11609
|
+
type CompositionResolvedListResponse = components$c['schemas']['CompositionResolvedListResponse'];
|
|
11506
11610
|
/** All valid response types */
|
|
11507
11611
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
11508
11612
|
/** The GET response from /api/v1/route */
|
|
11509
|
-
type RouteGetParameters = paths$
|
|
11510
|
-
type RouteGetResponse = components$
|
|
11511
|
-
type RouteGetResponseComposition = components$
|
|
11512
|
-
type RouteGetResponseRedirect = components$
|
|
11513
|
-
type RouteGetResponseNotFound = components$
|
|
11514
|
-
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'];
|
|
11515
11619
|
/** The GET response from /api/v1/entries */
|
|
11516
11620
|
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11517
11621
|
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11518
|
-
type EntriesResolvedListResponse = components$
|
|
11622
|
+
type EntriesResolvedListResponse = components$c['schemas']['EntryResolvedListResponse'];
|
|
11519
11623
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11520
11624
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
11521
11625
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -12130,7 +12234,7 @@ type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-proper
|
|
|
12130
12234
|
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
12131
12235
|
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
12132
12236
|
|
|
12133
|
-
type schemas = components$
|
|
12237
|
+
type schemas = components$c['schemas'];
|
|
12134
12238
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
12135
12239
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
12136
12240
|
|
|
@@ -12500,6 +12604,8 @@ interface paths$7 {
|
|
|
12500
12604
|
icon: string;
|
|
12501
12605
|
/** Width in pixels */
|
|
12502
12606
|
width: number;
|
|
12607
|
+
/** Present and true only on the default viewport, which the editor opens the preview at when the editor has not picked one. At most one viewport per project is the default. */
|
|
12608
|
+
isDefault?: boolean;
|
|
12503
12609
|
}[];
|
|
12504
12610
|
};
|
|
12505
12611
|
};
|
|
@@ -12535,6 +12641,8 @@ interface paths$7 {
|
|
|
12535
12641
|
icon: string;
|
|
12536
12642
|
/** Width in pixels */
|
|
12537
12643
|
width: number;
|
|
12644
|
+
/** Makes this the default viewport and clears the flag on the other viewports of the project. When omitted, the viewport is not the default. */
|
|
12645
|
+
isDefault?: boolean;
|
|
12538
12646
|
};
|
|
12539
12647
|
};
|
|
12540
12648
|
};
|
|
@@ -12571,6 +12679,13 @@ interface paths$7 {
|
|
|
12571
12679
|
};
|
|
12572
12680
|
content?: never;
|
|
12573
12681
|
};
|
|
12682
|
+
/** Conflict: a concurrent request made another viewport the default. Reload the viewports and retry. */
|
|
12683
|
+
409: {
|
|
12684
|
+
headers: {
|
|
12685
|
+
[name: string]: unknown;
|
|
12686
|
+
};
|
|
12687
|
+
content?: never;
|
|
12688
|
+
};
|
|
12574
12689
|
429: components$7["responses"]["RateLimitError"];
|
|
12575
12690
|
500: components$7["responses"]["InternalServerError"];
|
|
12576
12691
|
};
|
|
@@ -15009,6 +15124,7 @@ declare class PreviewClient extends ApiClient {
|
|
|
15009
15124
|
name: string;
|
|
15010
15125
|
icon: string;
|
|
15011
15126
|
width: number;
|
|
15127
|
+
isDefault?: boolean;
|
|
15012
15128
|
}>;
|
|
15013
15129
|
/** Fetches all preview viewports for a project */
|
|
15014
15130
|
getPreviewViewports(options?: ExceptProject<PreviewViewportsGetParameters>): Promise<{
|
|
@@ -15017,6 +15133,7 @@ declare class PreviewClient extends ApiClient {
|
|
|
15017
15133
|
name: string;
|
|
15018
15134
|
icon: string;
|
|
15019
15135
|
width: number;
|
|
15136
|
+
isDefault?: boolean;
|
|
15020
15137
|
}[];
|
|
15021
15138
|
}>;
|
|
15022
15139
|
/** Creates or updates a preview viewport */
|
|
@@ -15221,7 +15338,7 @@ interface components$2 {
|
|
|
15221
15338
|
sampleSize?: number;
|
|
15222
15339
|
searchIndexVersion: string;
|
|
15223
15340
|
/** @enum {string} */
|
|
15224
|
-
searchIndexStatus: "absent" | "present" | "unavailable" | "unknown";
|
|
15341
|
+
searchIndexStatus: "absent" | "hibernated" | "present" | "unavailable" | "unknown";
|
|
15225
15342
|
/**
|
|
15226
15343
|
* @deprecated
|
|
15227
15344
|
* **Experimental / internal.** Subject to change or removal without notice.
|
|
@@ -15277,7 +15394,7 @@ interface components$2 {
|
|
|
15277
15394
|
teamName?: string;
|
|
15278
15395
|
searchIndexVersion?: string;
|
|
15279
15396
|
/** @enum {string} */
|
|
15280
|
-
searchIndexStatus?: "absent" | "present" | "unavailable" | "unknown";
|
|
15397
|
+
searchIndexStatus?: "absent" | "hibernated" | "present" | "unavailable" | "unknown";
|
|
15281
15398
|
/**
|
|
15282
15399
|
* @deprecated
|
|
15283
15400
|
* **Experimental / internal.** Subject to change or removal without notice.
|
|
@@ -16138,7 +16255,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
16138
16255
|
*/
|
|
16139
16256
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
16140
16257
|
|
|
16141
|
-
declare const version = "20.
|
|
16258
|
+
declare const version = "20.87.0";
|
|
16142
16259
|
|
|
16143
16260
|
/** API client to enable managing workflow definitions */
|
|
16144
16261
|
declare class WorkflowClient extends ApiClient {
|