@uniformdev/project-map 20.75.1-alpha.16 → 20.75.1-alpha.6
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 +219 -219
- package/dist/index.d.ts +219 -219
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -9,13 +9,13 @@ interface paths$1 {
|
|
|
9
9
|
path?: never;
|
|
10
10
|
cookie?: never;
|
|
11
11
|
};
|
|
12
|
-
/**
|
|
12
|
+
/** Called to retrieve a list of project maps related to a project or a specific project map by id */
|
|
13
13
|
get: {
|
|
14
14
|
parameters: {
|
|
15
15
|
query: {
|
|
16
|
-
/**
|
|
16
|
+
/** The project to fetch project map for */
|
|
17
17
|
projectId: string;
|
|
18
|
-
/**
|
|
18
|
+
/** The id of the project map to fetch */
|
|
19
19
|
projectMapId?: string;
|
|
20
20
|
};
|
|
21
21
|
header?: never;
|
|
@@ -24,7 +24,7 @@ interface paths$1 {
|
|
|
24
24
|
};
|
|
25
25
|
requestBody?: never;
|
|
26
26
|
responses: {
|
|
27
|
-
/**
|
|
27
|
+
/** OK */
|
|
28
28
|
200: {
|
|
29
29
|
headers: {
|
|
30
30
|
[name: string]: unknown;
|
|
@@ -52,18 +52,18 @@ interface paths$1 {
|
|
|
52
52
|
requestBody: {
|
|
53
53
|
content: {
|
|
54
54
|
"application/json": {
|
|
55
|
-
/**
|
|
55
|
+
/** Project map object to insert */
|
|
56
56
|
projectMap: components$2["schemas"]["ProjectMapDefinition"];
|
|
57
57
|
/**
|
|
58
58
|
* Format: uuid
|
|
59
|
-
*
|
|
59
|
+
* Project id to insert the projectMap into
|
|
60
60
|
*/
|
|
61
61
|
projectId: string;
|
|
62
62
|
};
|
|
63
63
|
};
|
|
64
64
|
};
|
|
65
65
|
responses: {
|
|
66
|
-
/**
|
|
66
|
+
/** OK */
|
|
67
67
|
200: {
|
|
68
68
|
headers: {
|
|
69
69
|
[name: string]: unknown;
|
|
@@ -72,13 +72,13 @@ interface paths$1 {
|
|
|
72
72
|
"application/json": {
|
|
73
73
|
/**
|
|
74
74
|
* Format: uuid
|
|
75
|
-
*
|
|
75
|
+
* Id of the projectMap
|
|
76
76
|
*/
|
|
77
77
|
projectMapId: string;
|
|
78
78
|
};
|
|
79
79
|
};
|
|
80
80
|
};
|
|
81
|
-
/**
|
|
81
|
+
/** OK */
|
|
82
82
|
204: {
|
|
83
83
|
headers: {
|
|
84
84
|
[name: string]: unknown;
|
|
@@ -93,7 +93,7 @@ interface paths$1 {
|
|
|
93
93
|
};
|
|
94
94
|
};
|
|
95
95
|
post?: never;
|
|
96
|
-
/**
|
|
96
|
+
/** Called to delete a projectMap */
|
|
97
97
|
delete: {
|
|
98
98
|
parameters: {
|
|
99
99
|
query?: never;
|
|
@@ -106,19 +106,19 @@ interface paths$1 {
|
|
|
106
106
|
"application/json": {
|
|
107
107
|
/**
|
|
108
108
|
* Format: uuid
|
|
109
|
-
*
|
|
109
|
+
* Id of the project that this projectMap belongs to
|
|
110
110
|
*/
|
|
111
111
|
projectId: string;
|
|
112
112
|
/**
|
|
113
113
|
* Format: uuid
|
|
114
|
-
*
|
|
114
|
+
* Id of the projectMap to delete
|
|
115
115
|
*/
|
|
116
116
|
projectMapId: string;
|
|
117
117
|
};
|
|
118
118
|
};
|
|
119
119
|
};
|
|
120
120
|
responses: {
|
|
121
|
-
/**
|
|
121
|
+
/** OK */
|
|
122
122
|
204: {
|
|
123
123
|
headers: {
|
|
124
124
|
[name: string]: unknown;
|
|
@@ -132,7 +132,7 @@ interface paths$1 {
|
|
|
132
132
|
500: components$2["responses"]["InternalServerError"];
|
|
133
133
|
};
|
|
134
134
|
};
|
|
135
|
-
/**
|
|
135
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
136
136
|
options: {
|
|
137
137
|
parameters: {
|
|
138
138
|
query?: never;
|
|
@@ -142,7 +142,7 @@ interface paths$1 {
|
|
|
142
142
|
};
|
|
143
143
|
requestBody?: never;
|
|
144
144
|
responses: {
|
|
145
|
-
/**
|
|
145
|
+
/** OK */
|
|
146
146
|
204: {
|
|
147
147
|
headers: {
|
|
148
148
|
[name: string]: unknown;
|
|
@@ -159,47 +159,47 @@ interface paths$1 {
|
|
|
159
159
|
interface components$2 {
|
|
160
160
|
schemas: {
|
|
161
161
|
ProjectMapDefinition: {
|
|
162
|
-
/**
|
|
162
|
+
/** The id of the projectMap node */
|
|
163
163
|
id?: string;
|
|
164
|
-
/**
|
|
164
|
+
/** The name of the projectMap node */
|
|
165
165
|
name: string;
|
|
166
|
-
/**
|
|
166
|
+
/** Description of the projectMap node */
|
|
167
167
|
description?: string;
|
|
168
|
-
/**
|
|
168
|
+
/** The prefix of the url generated by this projectMap */
|
|
169
169
|
baseUrl?: string;
|
|
170
170
|
default?: boolean;
|
|
171
|
-
/**
|
|
171
|
+
/** Global query strings that are allowed on all nodes in this project map */
|
|
172
172
|
globalQueryStrings?: components$2["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
173
173
|
};
|
|
174
174
|
ProjectMapNodeAllowedQueryString: {
|
|
175
|
-
/**
|
|
175
|
+
/** The name of the query string parameter */
|
|
176
176
|
name: string;
|
|
177
|
-
/**
|
|
177
|
+
/** The default value of the query string if it is not provided by an incoming route path */
|
|
178
178
|
value?: string;
|
|
179
|
-
/**
|
|
179
|
+
/** Help text for authors who might be setting up a preview value for this query string */
|
|
180
180
|
helpText?: string;
|
|
181
|
-
/**
|
|
181
|
+
/** Configuration for providing a list of allowed values for this query string */
|
|
182
182
|
optionsSource?: {
|
|
183
183
|
/**
|
|
184
|
-
*
|
|
185
|
-
|
|
184
|
+
* The source type for the options
|
|
185
|
+
|
|
186
186
|
*/
|
|
187
187
|
source: "static";
|
|
188
188
|
options: {
|
|
189
|
-
/**
|
|
189
|
+
/** Display name for the option */
|
|
190
190
|
name: string;
|
|
191
|
-
/**
|
|
191
|
+
/** The actual value to be used */
|
|
192
192
|
value: string;
|
|
193
193
|
}[];
|
|
194
194
|
};
|
|
195
195
|
};
|
|
196
196
|
Error: {
|
|
197
|
-
/**
|
|
197
|
+
/** Error message(s) that occurred while processing the request */
|
|
198
198
|
errorMessage?: string[] | string;
|
|
199
199
|
};
|
|
200
200
|
};
|
|
201
201
|
responses: {
|
|
202
|
-
/**
|
|
202
|
+
/** Request input validation failed */
|
|
203
203
|
BadRequestError: {
|
|
204
204
|
headers: {
|
|
205
205
|
[name: string]: unknown;
|
|
@@ -208,7 +208,7 @@ interface components$2 {
|
|
|
208
208
|
"application/json": components$2["schemas"]["Error"];
|
|
209
209
|
};
|
|
210
210
|
};
|
|
211
|
-
/**
|
|
211
|
+
/** API key or token was not valid */
|
|
212
212
|
UnauthorizedError: {
|
|
213
213
|
headers: {
|
|
214
214
|
[name: string]: unknown;
|
|
@@ -217,7 +217,7 @@ interface components$2 {
|
|
|
217
217
|
"application/json": components$2["schemas"]["Error"];
|
|
218
218
|
};
|
|
219
219
|
};
|
|
220
|
-
/**
|
|
220
|
+
/** Permission was denied */
|
|
221
221
|
ForbiddenError: {
|
|
222
222
|
headers: {
|
|
223
223
|
[name: string]: unknown;
|
|
@@ -226,14 +226,14 @@ interface components$2 {
|
|
|
226
226
|
"application/json": components$2["schemas"]["Error"];
|
|
227
227
|
};
|
|
228
228
|
};
|
|
229
|
-
/**
|
|
229
|
+
/** Too many requests in allowed time period */
|
|
230
230
|
RateLimitError: {
|
|
231
231
|
headers: {
|
|
232
232
|
[name: string]: unknown;
|
|
233
233
|
};
|
|
234
234
|
content?: never;
|
|
235
235
|
};
|
|
236
|
-
/**
|
|
236
|
+
/** Execution error occurred */
|
|
237
237
|
InternalServerError: {
|
|
238
238
|
headers: {
|
|
239
239
|
[name: string]: unknown;
|
|
@@ -252,33 +252,33 @@ interface components$1 {
|
|
|
252
252
|
ProjectMapNodeDefinition: {
|
|
253
253
|
/**
|
|
254
254
|
* Format: uuid
|
|
255
|
-
*
|
|
255
|
+
* The id of the projectMap entry
|
|
256
256
|
*/
|
|
257
257
|
id: string;
|
|
258
|
-
/**
|
|
258
|
+
/** Path representing the path to the current node */
|
|
259
259
|
path: string;
|
|
260
|
-
/**
|
|
260
|
+
/** Ordering of the node, higher numbers go after lower numbers */
|
|
261
261
|
order?: number;
|
|
262
262
|
data?: components$1["schemas"]["ProjectMapNodeData"];
|
|
263
|
-
/**
|
|
263
|
+
/** The name of the projectMap entry */
|
|
264
264
|
name: string;
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
267
|
-
|
|
266
|
+
* The type of the projectMap entry
|
|
267
|
+
|
|
268
268
|
*/
|
|
269
269
|
type: "composition" | "placeholder";
|
|
270
270
|
/**
|
|
271
271
|
* Format: uuid
|
|
272
|
-
*
|
|
272
|
+
* The composition id related to the projectMap entry
|
|
273
273
|
*/
|
|
274
274
|
compositionId?: string;
|
|
275
|
-
/**
|
|
275
|
+
/** Description of the projectMap node */
|
|
276
276
|
description?: string;
|
|
277
|
-
/**
|
|
277
|
+
/** Parent path of the current node, only included if requested with the expanded flag */
|
|
278
278
|
parentPath?: string;
|
|
279
|
-
/**
|
|
279
|
+
/** Last segment of the url */
|
|
280
280
|
pathSegment?: string;
|
|
281
|
-
/**
|
|
281
|
+
/** returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
|
|
282
282
|
isLeaf?: boolean;
|
|
283
283
|
compositionData?: components$1["schemas"]["ProjectMapNodeCompositionData"];
|
|
284
284
|
sourceRedirects?: components$1["schemas"]["ProjectMapSourceRedirectData"];
|
|
@@ -288,14 +288,14 @@ interface components$1 {
|
|
|
288
288
|
};
|
|
289
289
|
};
|
|
290
290
|
ProjectMapNodeLocale: {
|
|
291
|
-
/**
|
|
291
|
+
/** Name of node in the locale */
|
|
292
292
|
name?: string;
|
|
293
|
-
/**
|
|
293
|
+
/** Full path to the current node in this locale, only included if requested with the expanded flag */
|
|
294
294
|
path?: string;
|
|
295
|
-
/**
|
|
295
|
+
/** Last segment of the url in this locale */
|
|
296
296
|
pathSegment: string;
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
298
|
+
* When false, the node explicitly defines a locale-specific path segment.
|
|
299
299
|
*
|
|
300
300
|
* When true, an ancestor defines a locale-specific path segment,
|
|
301
301
|
* which makes its descendants resolvable using that segment.
|
|
@@ -308,182 +308,182 @@ interface components$1 {
|
|
|
308
308
|
ProjectMapSourceRedirectData: {
|
|
309
309
|
/**
|
|
310
310
|
* Format: uuid
|
|
311
|
-
*
|
|
311
|
+
* The public UUID of the source redirect
|
|
312
312
|
*/
|
|
313
313
|
id?: string;
|
|
314
314
|
}[];
|
|
315
315
|
ProjectMapTargetRedirectData: {
|
|
316
316
|
/**
|
|
317
317
|
* Format: uuid
|
|
318
|
-
*
|
|
318
|
+
* The public UUID of the target redirect
|
|
319
319
|
*/
|
|
320
320
|
id?: string;
|
|
321
321
|
}[];
|
|
322
322
|
/**
|
|
323
|
-
*
|
|
323
|
+
* Basic information about the linked composition from the context of a project map node.
|
|
324
324
|
* If the linked composition has editions, the editions are included in the `editions` property.
|
|
325
325
|
*/
|
|
326
326
|
ProjectMapNodeCompositionData: {
|
|
327
|
-
/**
|
|
327
|
+
/** Type of the linked composition (id of its definition) */
|
|
328
328
|
type: string;
|
|
329
329
|
/**
|
|
330
330
|
* Format: uuid
|
|
331
|
-
*
|
|
331
|
+
* The UUID of the linked composition
|
|
332
332
|
*/
|
|
333
333
|
id: string;
|
|
334
334
|
/**
|
|
335
335
|
* Format: uuid
|
|
336
|
-
*
|
|
336
|
+
* The edition UUID underneath the linked composition
|
|
337
337
|
* This is only present if the composition has not been published, but an edition has
|
|
338
338
|
*/
|
|
339
339
|
editionId?: string;
|
|
340
|
-
/**
|
|
340
|
+
/** Slug pattern of the linked composition or edition */
|
|
341
341
|
slug?: string | null;
|
|
342
|
-
/**
|
|
342
|
+
/** Friendly name of this composition or edition */
|
|
343
343
|
name: string;
|
|
344
344
|
/**
|
|
345
345
|
* @deprecated
|
|
346
|
-
*
|
|
347
|
-
|
|
346
|
+
* UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
347
|
+
|
|
348
348
|
*/
|
|
349
349
|
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
350
350
|
/**
|
|
351
|
-
*
|
|
352
|
-
* @
|
|
351
|
+
* Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
352
|
+
* @defaultValue screen
|
|
353
353
|
*/
|
|
354
354
|
icon?: string;
|
|
355
|
-
/**
|
|
355
|
+
/** Friendly name of this Composition's Definition */
|
|
356
356
|
typeName?: string;
|
|
357
357
|
/**
|
|
358
|
-
*
|
|
358
|
+
* List of locales that the composition _or any of its editions_ is available in.
|
|
359
359
|
* If empty, available in all locales.
|
|
360
360
|
*/
|
|
361
361
|
locales: string[];
|
|
362
|
-
/**
|
|
362
|
+
/** Priority of the composition relative to any editions */
|
|
363
363
|
editionPriority?: number;
|
|
364
|
-
/**
|
|
364
|
+
/** Friendly name of the edition */
|
|
365
365
|
editionName?: string;
|
|
366
366
|
/**
|
|
367
|
-
*
|
|
367
|
+
* List of editions available for this composition. The composition is included in the list, it is the edition
|
|
368
368
|
* where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
|
|
369
369
|
*/
|
|
370
370
|
editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
|
|
371
371
|
/**
|
|
372
372
|
* Format: date-time
|
|
373
|
-
*
|
|
373
|
+
* Date and time the composition was last modified (or created if never modified).
|
|
374
374
|
* Uses ISO-8859-1 formatting and UTC timezone.
|
|
375
375
|
* IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
|
|
376
376
|
*/
|
|
377
377
|
modified?: string;
|
|
378
378
|
};
|
|
379
|
-
/**
|
|
379
|
+
/** Basic information about a composition edition from the context of a project map node */
|
|
380
380
|
ProjectMapNodeCompositionEditionData: {
|
|
381
381
|
/**
|
|
382
382
|
* Format: uuid
|
|
383
|
-
*
|
|
383
|
+
* The UUID of the linked composition
|
|
384
384
|
*/
|
|
385
385
|
id: string;
|
|
386
|
-
/**
|
|
386
|
+
/** Type of the edition instance (public_id of its definition) */
|
|
387
387
|
type: string;
|
|
388
388
|
/**
|
|
389
389
|
* Format: uuid
|
|
390
|
-
*
|
|
390
|
+
* The edition UUID underneath the linked composition
|
|
391
391
|
*/
|
|
392
392
|
editionId?: string;
|
|
393
|
-
/**
|
|
393
|
+
/** Slug pattern of this edition */
|
|
394
394
|
slug?: string | null;
|
|
395
|
-
/**
|
|
395
|
+
/** Friendly name of the linked composition */
|
|
396
396
|
name: string;
|
|
397
|
-
/**
|
|
397
|
+
/** Friendly name of the edition */
|
|
398
398
|
editionName?: string;
|
|
399
|
-
/**
|
|
399
|
+
/** Priority of the edition */
|
|
400
400
|
editionPriority?: number;
|
|
401
401
|
/**
|
|
402
402
|
* @deprecated
|
|
403
|
-
*
|
|
404
|
-
|
|
403
|
+
* UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
404
|
+
|
|
405
405
|
*/
|
|
406
406
|
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
407
407
|
/**
|
|
408
|
-
*
|
|
409
|
-
* @
|
|
408
|
+
* Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
409
|
+
* @defaultValue screen
|
|
410
410
|
*/
|
|
411
411
|
icon?: string;
|
|
412
|
-
/**
|
|
412
|
+
/** Friendly name of this edition's definition */
|
|
413
413
|
typeName?: string;
|
|
414
|
-
/**
|
|
414
|
+
/** List of locales that the edition is available in. If empty, available in all locales */
|
|
415
415
|
locales: string[];
|
|
416
416
|
/**
|
|
417
417
|
* Format: date-time
|
|
418
|
-
*
|
|
418
|
+
* Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
|
|
419
419
|
*/
|
|
420
420
|
modified?: string;
|
|
421
421
|
};
|
|
422
422
|
ProjectMapNodeUpdate: {
|
|
423
423
|
/**
|
|
424
424
|
* Format: uuid
|
|
425
|
-
*
|
|
425
|
+
* The id of the projectMap entry
|
|
426
426
|
*/
|
|
427
427
|
id?: string;
|
|
428
|
-
/**
|
|
428
|
+
/** Path representing the path to the current node */
|
|
429
429
|
path: string;
|
|
430
|
-
/**
|
|
430
|
+
/** Ordering of the node, higher numbers go after lower numbers */
|
|
431
431
|
order?: number;
|
|
432
432
|
data?: components$1["schemas"]["ProjectMapNodeData"];
|
|
433
|
-
/**
|
|
433
|
+
/** The name of the projectMap entry */
|
|
434
434
|
name: string;
|
|
435
435
|
/**
|
|
436
|
-
*
|
|
437
|
-
|
|
436
|
+
* The type of the projectMap entry
|
|
437
|
+
|
|
438
438
|
*/
|
|
439
439
|
type: "composition" | "placeholder";
|
|
440
440
|
/**
|
|
441
441
|
* Format: uuid
|
|
442
|
-
*
|
|
442
|
+
* The composition id related to the projectMap entry
|
|
443
443
|
*/
|
|
444
444
|
compositionId?: string;
|
|
445
|
-
/**
|
|
445
|
+
/** Description of the projectMap node */
|
|
446
446
|
description?: string;
|
|
447
447
|
locales?: {
|
|
448
448
|
[key: string]: components$1["schemas"]["ProjectMapNodeLocaleUpdate"];
|
|
449
449
|
};
|
|
450
450
|
};
|
|
451
451
|
ProjectMapNodeLocaleUpdate: {
|
|
452
|
-
/**
|
|
452
|
+
/** Name of node in the locale */
|
|
453
453
|
name?: string;
|
|
454
|
-
/**
|
|
454
|
+
/** Locale specific path segment for this node (not a full path) */
|
|
455
455
|
pathSegment: string;
|
|
456
456
|
};
|
|
457
457
|
ProjectMapNodeData: {
|
|
458
|
-
/**
|
|
458
|
+
/** 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 */
|
|
459
459
|
isSearchHit?: boolean;
|
|
460
|
-
/**
|
|
460
|
+
/** Query strings that are allowed to be passed to the node */
|
|
461
461
|
queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
462
462
|
/**
|
|
463
|
-
*
|
|
463
|
+
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
464
464
|
* The preview value is used when editing a connected composition, and is the default
|
|
465
465
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
466
466
|
*/
|
|
467
467
|
previewValue?: string;
|
|
468
468
|
};
|
|
469
469
|
ProjectMapNodeAllowedQueryString: {
|
|
470
|
-
/**
|
|
470
|
+
/** The name of the query string parameter */
|
|
471
471
|
name: string;
|
|
472
|
-
/**
|
|
472
|
+
/** The default value of the query string if it is not provided by an incoming route path */
|
|
473
473
|
value?: string;
|
|
474
|
-
/**
|
|
474
|
+
/** Help text for authors who might be setting up a preview value for this query string */
|
|
475
475
|
helpText?: string;
|
|
476
|
-
/**
|
|
476
|
+
/** Configuration for providing a list of allowed values for this query string */
|
|
477
477
|
optionsSource?: {
|
|
478
478
|
/**
|
|
479
|
-
*
|
|
480
|
-
|
|
479
|
+
* The source type for the options
|
|
480
|
+
|
|
481
481
|
*/
|
|
482
482
|
source: "static";
|
|
483
483
|
options: {
|
|
484
|
-
/**
|
|
484
|
+
/** Display name for the option */
|
|
485
485
|
name: string;
|
|
486
|
-
/**
|
|
486
|
+
/** The actual value to be used */
|
|
487
487
|
value: string;
|
|
488
488
|
}[];
|
|
489
489
|
};
|
|
@@ -505,7 +505,7 @@ interface paths {
|
|
|
505
505
|
cookie?: never;
|
|
506
506
|
};
|
|
507
507
|
/**
|
|
508
|
-
*
|
|
508
|
+
* Called to get a list of nodes belonging to a specific path or Id.
|
|
509
509
|
*
|
|
510
510
|
* Note on branch-scoped permissions: if the caller's role has a
|
|
511
511
|
* branch-scoped PrmNodeRead policy (i.e. read access is configured for
|
|
@@ -518,12 +518,12 @@ interface paths {
|
|
|
518
518
|
get: {
|
|
519
519
|
parameters: {
|
|
520
520
|
query: {
|
|
521
|
-
/**
|
|
521
|
+
/** The project map id that the desired nodes belong */
|
|
522
522
|
projectMapId?: string;
|
|
523
|
-
/**
|
|
523
|
+
/** The project id that contains the project map tree that this node belongs to */
|
|
524
524
|
projectId: string;
|
|
525
525
|
/**
|
|
526
|
-
*
|
|
526
|
+
* The ID of a release to fetch the composition data for.
|
|
527
527
|
*
|
|
528
528
|
* - When unspecified, composition data is fetched from base.
|
|
529
529
|
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
@@ -531,40 +531,40 @@ interface paths {
|
|
|
531
531
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
|
|
532
532
|
*/
|
|
533
533
|
releaseId?: string;
|
|
534
|
-
/**
|
|
534
|
+
/** The id of the node to retrieve, cannot have both this parameter and `path` */
|
|
535
535
|
id?: string;
|
|
536
|
-
/**
|
|
536
|
+
/** The path of the root node to retrieve, cannot have both this parameter and `id` */
|
|
537
537
|
path?: string;
|
|
538
|
-
/**
|
|
538
|
+
/** Composition id to find associated project map node for */
|
|
539
539
|
compositionId?: string;
|
|
540
|
-
/**
|
|
540
|
+
/** Limit the number or records returned by a number */
|
|
541
541
|
limit?: number;
|
|
542
|
-
/**
|
|
542
|
+
/** Number of records to skip before returning nodes */
|
|
543
543
|
offset?: number;
|
|
544
|
-
/**
|
|
544
|
+
/** Depth of the tree to fetch. This only applies when fetching by path */
|
|
545
545
|
depth?: number;
|
|
546
|
-
/**
|
|
546
|
+
/** State of compositions to fetch. 0 = draft, 64 = published */
|
|
547
547
|
state?: number;
|
|
548
|
-
/**
|
|
548
|
+
/** should the data be returned as a json tree object (or a flat array) */
|
|
549
549
|
tree?: boolean;
|
|
550
|
-
/**
|
|
550
|
+
/** text search filter */
|
|
551
551
|
search?: string;
|
|
552
552
|
/**
|
|
553
|
-
*
|
|
553
|
+
* Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
|
|
554
554
|
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
|
|
555
555
|
*/
|
|
556
556
|
includeAncestors?: boolean;
|
|
557
|
-
/**
|
|
557
|
+
/** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
|
|
558
558
|
expanded?: boolean;
|
|
559
|
-
/**
|
|
559
|
+
/** include basic composition information. ID, type, state, name, and definition id */
|
|
560
560
|
withCompositionData?: boolean;
|
|
561
561
|
/**
|
|
562
562
|
* @deprecated
|
|
563
|
-
*
|
|
563
|
+
* Returns the UI status string of the composition.
|
|
564
564
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
|
|
565
565
|
*/
|
|
566
566
|
withCompositionUIStatus?: boolean;
|
|
567
|
-
/**
|
|
567
|
+
/** Include basic redirect information */
|
|
568
568
|
withRedirectData?: boolean;
|
|
569
569
|
};
|
|
570
570
|
header?: never;
|
|
@@ -573,7 +573,7 @@ interface paths {
|
|
|
573
573
|
};
|
|
574
574
|
requestBody?: never;
|
|
575
575
|
responses: {
|
|
576
|
-
/**
|
|
576
|
+
/** OK */
|
|
577
577
|
200: {
|
|
578
578
|
headers: {
|
|
579
579
|
[name: string]: unknown;
|
|
@@ -592,7 +592,7 @@ interface paths {
|
|
|
592
592
|
500: components["responses"]["InternalServerError"];
|
|
593
593
|
};
|
|
594
594
|
};
|
|
595
|
-
/**
|
|
595
|
+
/** Called to insert or update a node or nodes */
|
|
596
596
|
put: {
|
|
597
597
|
parameters: {
|
|
598
598
|
query?: never;
|
|
@@ -603,29 +603,29 @@ interface paths {
|
|
|
603
603
|
requestBody: {
|
|
604
604
|
content: {
|
|
605
605
|
"application/json": {
|
|
606
|
-
/**
|
|
606
|
+
/** An array of projectMap node objects to be updated or inserted */
|
|
607
607
|
nodes: {
|
|
608
608
|
node: components["schemas"]["ProjectMapNodeUpdate"];
|
|
609
|
-
/**
|
|
609
|
+
/** The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
|
|
610
610
|
previousSibling?: string;
|
|
611
|
-
/**
|
|
611
|
+
/** The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
|
|
612
612
|
nextSibling?: string;
|
|
613
613
|
}[];
|
|
614
614
|
/**
|
|
615
615
|
* Format: uuid
|
|
616
|
-
*
|
|
616
|
+
* The project id of the project that the projectMap belongs to
|
|
617
617
|
*/
|
|
618
618
|
projectId: string;
|
|
619
619
|
/**
|
|
620
620
|
* Format: uuid
|
|
621
|
-
*
|
|
621
|
+
* The projectMap id that the changing or inserting nodes belong to
|
|
622
622
|
*/
|
|
623
623
|
projectMapId?: string;
|
|
624
624
|
};
|
|
625
625
|
};
|
|
626
626
|
};
|
|
627
627
|
responses: {
|
|
628
|
-
/**
|
|
628
|
+
/** OK */
|
|
629
629
|
204: {
|
|
630
630
|
headers: {
|
|
631
631
|
[name: string]: unknown;
|
|
@@ -640,7 +640,7 @@ interface paths {
|
|
|
640
640
|
};
|
|
641
641
|
};
|
|
642
642
|
post?: never;
|
|
643
|
-
/**
|
|
643
|
+
/** Called to delete a particular projectMap node by id or path */
|
|
644
644
|
delete: {
|
|
645
645
|
parameters: {
|
|
646
646
|
query?: never;
|
|
@@ -653,44 +653,44 @@ interface paths {
|
|
|
653
653
|
"application/json": {
|
|
654
654
|
/**
|
|
655
655
|
* Format: uuid
|
|
656
|
-
*
|
|
656
|
+
* Id of the projectMap node to delete
|
|
657
657
|
*/
|
|
658
658
|
nodeId?: string;
|
|
659
|
-
/**
|
|
659
|
+
/** Path to the projectMap node to delete */
|
|
660
660
|
path: string;
|
|
661
661
|
/**
|
|
662
662
|
* Format: uuid
|
|
663
|
-
*
|
|
663
|
+
* Project map id that the node to delete belongs to
|
|
664
664
|
*/
|
|
665
665
|
projectMapId?: string;
|
|
666
666
|
/**
|
|
667
667
|
* Format: uuid
|
|
668
|
-
*
|
|
668
|
+
* Project id that the project map belongs to
|
|
669
669
|
*/
|
|
670
670
|
projectId: string;
|
|
671
671
|
} | {
|
|
672
672
|
/**
|
|
673
673
|
* Format: uuid
|
|
674
|
-
*
|
|
674
|
+
* Id of the projectMap node to delete
|
|
675
675
|
*/
|
|
676
676
|
nodeId: string;
|
|
677
|
-
/**
|
|
677
|
+
/** Path to the projectMap node to delete */
|
|
678
678
|
path?: string;
|
|
679
679
|
/**
|
|
680
680
|
* Format: uuid
|
|
681
|
-
*
|
|
681
|
+
* Project map id that the node to delete belongs to
|
|
682
682
|
*/
|
|
683
683
|
projectMapId?: string;
|
|
684
684
|
/**
|
|
685
685
|
* Format: uuid
|
|
686
|
-
*
|
|
686
|
+
* Project id that the project map belongs to
|
|
687
687
|
*/
|
|
688
688
|
projectId: string;
|
|
689
689
|
};
|
|
690
690
|
};
|
|
691
691
|
};
|
|
692
692
|
responses: {
|
|
693
|
-
/**
|
|
693
|
+
/** OK */
|
|
694
694
|
204: {
|
|
695
695
|
headers: {
|
|
696
696
|
[name: string]: unknown;
|
|
@@ -704,7 +704,7 @@ interface paths {
|
|
|
704
704
|
500: components["responses"]["InternalServerError"];
|
|
705
705
|
};
|
|
706
706
|
};
|
|
707
|
-
/**
|
|
707
|
+
/** Handles preflight requests. This endpoint allows CORS */
|
|
708
708
|
options: {
|
|
709
709
|
parameters: {
|
|
710
710
|
query?: never;
|
|
@@ -714,7 +714,7 @@ interface paths {
|
|
|
714
714
|
};
|
|
715
715
|
requestBody?: never;
|
|
716
716
|
responses: {
|
|
717
|
-
/**
|
|
717
|
+
/** OK */
|
|
718
718
|
204: {
|
|
719
719
|
headers: {
|
|
720
720
|
[name: string]: unknown;
|
|
@@ -731,134 +731,134 @@ interface paths {
|
|
|
731
731
|
interface components {
|
|
732
732
|
schemas: {
|
|
733
733
|
ProjectMapNodeAllowedQueryString: {
|
|
734
|
-
/**
|
|
734
|
+
/** The name of the query string parameter */
|
|
735
735
|
name: string;
|
|
736
|
-
/**
|
|
736
|
+
/** The default value of the query string if it is not provided by an incoming route path */
|
|
737
737
|
value?: string;
|
|
738
|
-
/**
|
|
738
|
+
/** Help text for authors who might be setting up a preview value for this query string */
|
|
739
739
|
helpText?: string;
|
|
740
|
-
/**
|
|
740
|
+
/** Configuration for providing a list of allowed values for this query string */
|
|
741
741
|
optionsSource?: {
|
|
742
742
|
/**
|
|
743
|
-
*
|
|
744
|
-
|
|
743
|
+
* The source type for the options
|
|
744
|
+
|
|
745
745
|
*/
|
|
746
746
|
source: "static";
|
|
747
747
|
options: {
|
|
748
|
-
/**
|
|
748
|
+
/** Display name for the option */
|
|
749
749
|
name: string;
|
|
750
|
-
/**
|
|
750
|
+
/** The actual value to be used */
|
|
751
751
|
value: string;
|
|
752
752
|
}[];
|
|
753
753
|
};
|
|
754
754
|
};
|
|
755
755
|
ProjectMapNodeData: {
|
|
756
|
-
/**
|
|
756
|
+
/** 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 */
|
|
757
757
|
isSearchHit?: boolean;
|
|
758
|
-
/**
|
|
758
|
+
/** Query strings that are allowed to be passed to the node */
|
|
759
759
|
queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
760
760
|
/**
|
|
761
|
-
*
|
|
761
|
+
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
762
762
|
* The preview value is used when editing a connected composition, and is the default
|
|
763
763
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
764
764
|
*/
|
|
765
765
|
previewValue?: string;
|
|
766
766
|
};
|
|
767
|
-
/**
|
|
767
|
+
/** Basic information about a composition edition from the context of a project map node */
|
|
768
768
|
ProjectMapNodeCompositionEditionData: {
|
|
769
769
|
/**
|
|
770
770
|
* Format: uuid
|
|
771
|
-
*
|
|
771
|
+
* The UUID of the linked composition
|
|
772
772
|
*/
|
|
773
773
|
id: string;
|
|
774
|
-
/**
|
|
774
|
+
/** Type of the edition instance (public_id of its definition) */
|
|
775
775
|
type: string;
|
|
776
776
|
/**
|
|
777
777
|
* Format: uuid
|
|
778
|
-
*
|
|
778
|
+
* The edition UUID underneath the linked composition
|
|
779
779
|
*/
|
|
780
780
|
editionId?: string;
|
|
781
|
-
/**
|
|
781
|
+
/** Slug pattern of this edition */
|
|
782
782
|
slug?: string | null;
|
|
783
|
-
/**
|
|
783
|
+
/** Friendly name of the linked composition */
|
|
784
784
|
name: string;
|
|
785
|
-
/**
|
|
785
|
+
/** Friendly name of the edition */
|
|
786
786
|
editionName?: string;
|
|
787
|
-
/**
|
|
787
|
+
/** Priority of the edition */
|
|
788
788
|
editionPriority?: number;
|
|
789
789
|
/**
|
|
790
790
|
* @deprecated
|
|
791
|
-
*
|
|
792
|
-
|
|
791
|
+
* UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
792
|
+
|
|
793
793
|
*/
|
|
794
794
|
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
795
795
|
/**
|
|
796
|
-
*
|
|
797
|
-
* @
|
|
796
|
+
* Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
797
|
+
* @defaultValue screen
|
|
798
798
|
*/
|
|
799
799
|
icon?: string;
|
|
800
|
-
/**
|
|
800
|
+
/** Friendly name of this edition's definition */
|
|
801
801
|
typeName?: string;
|
|
802
|
-
/**
|
|
802
|
+
/** List of locales that the edition is available in. If empty, available in all locales */
|
|
803
803
|
locales: string[];
|
|
804
804
|
/**
|
|
805
805
|
* Format: date-time
|
|
806
|
-
*
|
|
806
|
+
* Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
|
|
807
807
|
*/
|
|
808
808
|
modified?: string;
|
|
809
809
|
};
|
|
810
810
|
/**
|
|
811
|
-
*
|
|
811
|
+
* Basic information about the linked composition from the context of a project map node.
|
|
812
812
|
* If the linked composition has editions, the editions are included in the `editions` property.
|
|
813
813
|
*/
|
|
814
814
|
ProjectMapNodeCompositionData: {
|
|
815
|
-
/**
|
|
815
|
+
/** Type of the linked composition (id of its definition) */
|
|
816
816
|
type: string;
|
|
817
817
|
/**
|
|
818
818
|
* Format: uuid
|
|
819
|
-
*
|
|
819
|
+
* The UUID of the linked composition
|
|
820
820
|
*/
|
|
821
821
|
id: string;
|
|
822
822
|
/**
|
|
823
823
|
* Format: uuid
|
|
824
|
-
*
|
|
824
|
+
* The edition UUID underneath the linked composition
|
|
825
825
|
* This is only present if the composition has not been published, but an edition has
|
|
826
826
|
*/
|
|
827
827
|
editionId?: string;
|
|
828
|
-
/**
|
|
828
|
+
/** Slug pattern of the linked composition or edition */
|
|
829
829
|
slug?: string | null;
|
|
830
|
-
/**
|
|
830
|
+
/** Friendly name of this composition or edition */
|
|
831
831
|
name: string;
|
|
832
832
|
/**
|
|
833
833
|
* @deprecated
|
|
834
|
-
*
|
|
835
|
-
|
|
834
|
+
* UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
|
|
835
|
+
|
|
836
836
|
*/
|
|
837
837
|
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
838
838
|
/**
|
|
839
|
-
*
|
|
840
|
-
* @
|
|
839
|
+
* Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
840
|
+
* @defaultValue screen
|
|
841
841
|
*/
|
|
842
842
|
icon?: string;
|
|
843
|
-
/**
|
|
843
|
+
/** Friendly name of this Composition's Definition */
|
|
844
844
|
typeName?: string;
|
|
845
845
|
/**
|
|
846
|
-
*
|
|
846
|
+
* List of locales that the composition _or any of its editions_ is available in.
|
|
847
847
|
* If empty, available in all locales.
|
|
848
848
|
*/
|
|
849
849
|
locales: string[];
|
|
850
|
-
/**
|
|
850
|
+
/** Priority of the composition relative to any editions */
|
|
851
851
|
editionPriority?: number;
|
|
852
|
-
/**
|
|
852
|
+
/** Friendly name of the edition */
|
|
853
853
|
editionName?: string;
|
|
854
854
|
/**
|
|
855
|
-
*
|
|
855
|
+
* List of editions available for this composition. The composition is included in the list, it is the edition
|
|
856
856
|
* where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
|
|
857
857
|
*/
|
|
858
858
|
editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
|
|
859
859
|
/**
|
|
860
860
|
* Format: date-time
|
|
861
|
-
*
|
|
861
|
+
* Date and time the composition was last modified (or created if never modified).
|
|
862
862
|
* Uses ISO-8859-1 formatting and UTC timezone.
|
|
863
863
|
* IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
|
|
864
864
|
*/
|
|
@@ -867,26 +867,26 @@ interface components {
|
|
|
867
867
|
ProjectMapSourceRedirectData: {
|
|
868
868
|
/**
|
|
869
869
|
* Format: uuid
|
|
870
|
-
*
|
|
870
|
+
* The public UUID of the source redirect
|
|
871
871
|
*/
|
|
872
872
|
id?: string;
|
|
873
873
|
}[];
|
|
874
874
|
ProjectMapTargetRedirectData: {
|
|
875
875
|
/**
|
|
876
876
|
* Format: uuid
|
|
877
|
-
*
|
|
877
|
+
* The public UUID of the target redirect
|
|
878
878
|
*/
|
|
879
879
|
id?: string;
|
|
880
880
|
}[];
|
|
881
881
|
ProjectMapNodeLocale: {
|
|
882
|
-
/**
|
|
882
|
+
/** Name of node in the locale */
|
|
883
883
|
name?: string;
|
|
884
|
-
/**
|
|
884
|
+
/** Full path to the current node in this locale, only included if requested with the expanded flag */
|
|
885
885
|
path?: string;
|
|
886
|
-
/**
|
|
886
|
+
/** Last segment of the url in this locale */
|
|
887
887
|
pathSegment: string;
|
|
888
888
|
/**
|
|
889
|
-
*
|
|
889
|
+
* When false, the node explicitly defines a locale-specific path segment.
|
|
890
890
|
*
|
|
891
891
|
* When true, an ancestor defines a locale-specific path segment,
|
|
892
892
|
* which makes its descendants resolvable using that segment.
|
|
@@ -899,33 +899,33 @@ interface components {
|
|
|
899
899
|
ProjectMapNodeDefinition: {
|
|
900
900
|
/**
|
|
901
901
|
* Format: uuid
|
|
902
|
-
*
|
|
902
|
+
* The id of the projectMap entry
|
|
903
903
|
*/
|
|
904
904
|
id: string;
|
|
905
|
-
/**
|
|
905
|
+
/** Path representing the path to the current node */
|
|
906
906
|
path: string;
|
|
907
|
-
/**
|
|
907
|
+
/** Ordering of the node, higher numbers go after lower numbers */
|
|
908
908
|
order?: number;
|
|
909
909
|
data?: components["schemas"]["ProjectMapNodeData"];
|
|
910
|
-
/**
|
|
910
|
+
/** The name of the projectMap entry */
|
|
911
911
|
name: string;
|
|
912
912
|
/**
|
|
913
|
-
*
|
|
914
|
-
|
|
913
|
+
* The type of the projectMap entry
|
|
914
|
+
|
|
915
915
|
*/
|
|
916
916
|
type: "composition" | "placeholder";
|
|
917
917
|
/**
|
|
918
918
|
* Format: uuid
|
|
919
|
-
*
|
|
919
|
+
* The composition id related to the projectMap entry
|
|
920
920
|
*/
|
|
921
921
|
compositionId?: string;
|
|
922
|
-
/**
|
|
922
|
+
/** Description of the projectMap node */
|
|
923
923
|
description?: string;
|
|
924
|
-
/**
|
|
924
|
+
/** Parent path of the current node, only included if requested with the expanded flag */
|
|
925
925
|
parentPath?: string;
|
|
926
|
-
/**
|
|
926
|
+
/** Last segment of the url */
|
|
927
927
|
pathSegment?: string;
|
|
928
|
-
/**
|
|
928
|
+
/** returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
|
|
929
929
|
isLeaf?: boolean;
|
|
930
930
|
compositionData?: components["schemas"]["ProjectMapNodeCompositionData"];
|
|
931
931
|
sourceRedirects?: components["schemas"]["ProjectMapSourceRedirectData"];
|
|
@@ -935,43 +935,43 @@ interface components {
|
|
|
935
935
|
};
|
|
936
936
|
};
|
|
937
937
|
ProjectMapTreeNodeDefinition: {
|
|
938
|
-
/**
|
|
938
|
+
/** Children of the node */
|
|
939
939
|
children?: components["schemas"]["ProjectMapTreeNodeDefinition"][];
|
|
940
940
|
} & WithRequired<components["schemas"]["ProjectMapNodeDefinition"], "name">;
|
|
941
941
|
Error: {
|
|
942
|
-
/**
|
|
942
|
+
/** Error message(s) that occurred while processing the request */
|
|
943
943
|
errorMessage?: string[] | string;
|
|
944
944
|
};
|
|
945
945
|
ProjectMapNodeLocaleUpdate: {
|
|
946
|
-
/**
|
|
946
|
+
/** Name of node in the locale */
|
|
947
947
|
name?: string;
|
|
948
|
-
/**
|
|
948
|
+
/** Locale specific path segment for this node (not a full path) */
|
|
949
949
|
pathSegment: string;
|
|
950
950
|
};
|
|
951
951
|
ProjectMapNodeUpdate: {
|
|
952
952
|
/**
|
|
953
953
|
* Format: uuid
|
|
954
|
-
*
|
|
954
|
+
* The id of the projectMap entry
|
|
955
955
|
*/
|
|
956
956
|
id?: string;
|
|
957
|
-
/**
|
|
957
|
+
/** Path representing the path to the current node */
|
|
958
958
|
path: string;
|
|
959
|
-
/**
|
|
959
|
+
/** Ordering of the node, higher numbers go after lower numbers */
|
|
960
960
|
order?: number;
|
|
961
961
|
data?: components["schemas"]["ProjectMapNodeData"];
|
|
962
|
-
/**
|
|
962
|
+
/** The name of the projectMap entry */
|
|
963
963
|
name: string;
|
|
964
964
|
/**
|
|
965
|
-
*
|
|
966
|
-
|
|
965
|
+
* The type of the projectMap entry
|
|
966
|
+
|
|
967
967
|
*/
|
|
968
968
|
type: "composition" | "placeholder";
|
|
969
969
|
/**
|
|
970
970
|
* Format: uuid
|
|
971
|
-
*
|
|
971
|
+
* The composition id related to the projectMap entry
|
|
972
972
|
*/
|
|
973
973
|
compositionId?: string;
|
|
974
|
-
/**
|
|
974
|
+
/** Description of the projectMap node */
|
|
975
975
|
description?: string;
|
|
976
976
|
locales?: {
|
|
977
977
|
[key: string]: components["schemas"]["ProjectMapNodeLocaleUpdate"];
|
|
@@ -979,7 +979,7 @@ interface components {
|
|
|
979
979
|
};
|
|
980
980
|
};
|
|
981
981
|
responses: {
|
|
982
|
-
/**
|
|
982
|
+
/** Request input validation failed */
|
|
983
983
|
BadRequestError: {
|
|
984
984
|
headers: {
|
|
985
985
|
[name: string]: unknown;
|
|
@@ -988,7 +988,7 @@ interface components {
|
|
|
988
988
|
"application/json": components["schemas"]["Error"];
|
|
989
989
|
};
|
|
990
990
|
};
|
|
991
|
-
/**
|
|
991
|
+
/** API key or token was not valid */
|
|
992
992
|
UnauthorizedError: {
|
|
993
993
|
headers: {
|
|
994
994
|
[name: string]: unknown;
|
|
@@ -997,7 +997,7 @@ interface components {
|
|
|
997
997
|
"application/json": components["schemas"]["Error"];
|
|
998
998
|
};
|
|
999
999
|
};
|
|
1000
|
-
/**
|
|
1000
|
+
/** Permission was denied */
|
|
1001
1001
|
ForbiddenError: {
|
|
1002
1002
|
headers: {
|
|
1003
1003
|
[name: string]: unknown;
|
|
@@ -1006,14 +1006,14 @@ interface components {
|
|
|
1006
1006
|
"application/json": components["schemas"]["Error"];
|
|
1007
1007
|
};
|
|
1008
1008
|
};
|
|
1009
|
-
/**
|
|
1009
|
+
/** Too many requests in allowed time period */
|
|
1010
1010
|
RateLimitError: {
|
|
1011
1011
|
headers: {
|
|
1012
1012
|
[name: string]: unknown;
|
|
1013
1013
|
};
|
|
1014
1014
|
content?: never;
|
|
1015
1015
|
};
|
|
1016
|
-
/**
|
|
1016
|
+
/** Execution error occurred */
|
|
1017
1017
|
InternalServerError: {
|
|
1018
1018
|
headers: {
|
|
1019
1019
|
[name: string]: unknown;
|
|
@@ -1117,7 +1117,7 @@ declare class UncachedProjectMapClient extends ProjectMapClient {
|
|
|
1117
1117
|
/**
|
|
1118
1118
|
* Internal use only.
|
|
1119
1119
|
*
|
|
1120
|
-
* @deprecated
|
|
1120
|
+
* @deprecated Internal constant; not for public use.
|
|
1121
1121
|
*/
|
|
1122
1122
|
declare const __INTERNAL_MISSING_PARENT_NODE_ERROR = "Upsert failed, parent node not found.";
|
|
1123
1123
|
|
|
@@ -1211,7 +1211,7 @@ type UnmatchedRoute = {
|
|
|
1211
1211
|
type ExpandOptions = {
|
|
1212
1212
|
dynamicInputValues?: Record<string, string | number | boolean>;
|
|
1213
1213
|
allowedQueryParams?: Array<string>;
|
|
1214
|
-
/** Prevents URL-escaping of variable expressions of the form
|
|
1214
|
+
/** Prevents URL-escaping of variable expressions of the form `${...}` in the expand result */
|
|
1215
1215
|
doNotEscapeVariables?: boolean;
|
|
1216
1216
|
};
|
|
1217
1217
|
declare class Route {
|