@datocms/cma-client 0.1.5 → 1.0.0
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/cjs/generated/resources/BuildTrigger.js +40 -2
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/Site.js +25 -3
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/cjs/generated/resources/User.js +26 -3
- package/dist/cjs/generated/resources/User.js.map +1 -1
- package/dist/esm/buildBlockRecord.d.ts +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +1296 -379
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +1357 -457
- package/dist/esm/generated/resources/BuildTrigger.d.ts +26 -2
- package/dist/esm/generated/resources/BuildTrigger.js +40 -2
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/Site.d.ts +14 -2
- package/dist/esm/generated/resources/Site.js +25 -3
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/resources/User.d.ts +14 -2
- package/dist/esm/generated/resources/User.js +26 -3
- package/dist/esm/generated/resources/User.js.map +1 -1
- package/dist/types/buildBlockRecord.d.ts +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +1296 -379
- package/dist/types/generated/SimpleSchemaTypes.d.ts +1357 -457
- package/dist/types/generated/resources/BuildTrigger.d.ts +26 -2
- package/dist/types/generated/resources/Site.d.ts +14 -2
- package/dist/types/generated/resources/User.d.ts +14 -2
- package/package.json +6 -5
- package/resources.json +1278 -0
- package/src/generated/SchemaTypes.ts +1320 -388
- package/src/generated/SimpleSchemaTypes.ts +1364 -463
- package/src/generated/resources/BuildTrigger.ts +44 -2
- package/src/generated/resources/Site.ts +33 -3
- package/src/generated/resources/User.ts +36 -3
- package/dist/cjs/generated/schemaInfo.js +0 -3063
- package/dist/cjs/generated/schemaInfo.js.map +0 -1
- package/dist/esm/generated/schemaInfo.d.ts +0 -940
- package/dist/esm/generated/schemaInfo.js +0 -3061
- package/dist/esm/generated/schemaInfo.js.map +0 -1
- package/dist/types/generated/schemaInfo.d.ts +0 -940
- package/src/generated/schemaInfo.ts +0 -3231
|
@@ -81,17 +81,13 @@ export type UserType = 'user';
|
|
|
81
81
|
export type UserIdentity = string;
|
|
82
82
|
/**
|
|
83
83
|
* This interface was referenced by `User`'s JSON-Schema
|
|
84
|
-
* via the `
|
|
84
|
+
* via the `self.hrefSchema` link.
|
|
85
85
|
*/
|
|
86
|
-
export type
|
|
87
|
-
/**
|
|
88
|
-
* New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
|
|
89
|
-
*/
|
|
90
|
-
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
86
|
+
export type UserSelfHrefSchema = {
|
|
91
87
|
/**
|
|
92
|
-
*
|
|
88
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
|
|
93
89
|
*/
|
|
94
|
-
|
|
90
|
+
include?: string;
|
|
95
91
|
[k: string]: unknown;
|
|
96
92
|
};
|
|
97
93
|
/**
|
|
@@ -146,20 +142,35 @@ export type SsoUserDestroyHrefSchema = {
|
|
|
146
142
|
/**
|
|
147
143
|
* JSON API type field
|
|
148
144
|
*
|
|
149
|
-
* This interface was referenced by `
|
|
145
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
150
146
|
* via the `definition` "type".
|
|
151
147
|
*/
|
|
152
|
-
export type
|
|
148
|
+
export type AccessTokenType = 'access_token';
|
|
153
149
|
/**
|
|
154
|
-
*
|
|
150
|
+
* ID of access_token
|
|
155
151
|
*
|
|
156
|
-
* This interface was referenced by `
|
|
152
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
157
153
|
* via the `definition` "identity".
|
|
158
154
|
*
|
|
159
|
-
* This interface was referenced by `
|
|
155
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
160
156
|
* via the `definition` "id".
|
|
161
157
|
*/
|
|
162
|
-
export type
|
|
158
|
+
export type AccessTokenIdentity = string;
|
|
159
|
+
/**
|
|
160
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
161
|
+
* via the `destroy.hrefSchema` link.
|
|
162
|
+
*/
|
|
163
|
+
export type AccessTokenDestroyHrefSchema = {
|
|
164
|
+
/**
|
|
165
|
+
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
|
|
166
|
+
*/
|
|
167
|
+
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
168
|
+
/**
|
|
169
|
+
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
|
|
170
|
+
*/
|
|
171
|
+
destination_user_id?: string;
|
|
172
|
+
[k: string]: unknown;
|
|
173
|
+
};
|
|
163
174
|
/**
|
|
164
175
|
* JSON API type field
|
|
165
176
|
*
|
|
@@ -177,6 +188,49 @@ export type AccountType = 'account';
|
|
|
177
188
|
* via the `definition` "id".
|
|
178
189
|
*/
|
|
179
190
|
export type AccountIdentity = string;
|
|
191
|
+
/**
|
|
192
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
193
|
+
* via the `me.hrefSchema` link.
|
|
194
|
+
*/
|
|
195
|
+
export type UserMeHrefSchema = {
|
|
196
|
+
/**
|
|
197
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
|
|
198
|
+
*/
|
|
199
|
+
include?: string;
|
|
200
|
+
[k: string]: unknown;
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
204
|
+
* via the `destroy.hrefSchema` link.
|
|
205
|
+
*/
|
|
206
|
+
export type UserDestroyHrefSchema = {
|
|
207
|
+
/**
|
|
208
|
+
* New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
|
|
209
|
+
*/
|
|
210
|
+
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
211
|
+
/**
|
|
212
|
+
* New owner for resources previously owned by the deleted user. This argument specifies the new owner ID.
|
|
213
|
+
*/
|
|
214
|
+
destination_user_id?: string;
|
|
215
|
+
[k: string]: unknown;
|
|
216
|
+
};
|
|
217
|
+
/**
|
|
218
|
+
* JSON API type field
|
|
219
|
+
*
|
|
220
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
221
|
+
* via the `definition` "type".
|
|
222
|
+
*/
|
|
223
|
+
export type AuditLogEventType = 'audit_log_event';
|
|
224
|
+
/**
|
|
225
|
+
* ULID of event (https://github.com/ulid/spec)
|
|
226
|
+
*
|
|
227
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
228
|
+
* via the `definition` "identity".
|
|
229
|
+
*
|
|
230
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
231
|
+
* via the `definition` "id".
|
|
232
|
+
*/
|
|
233
|
+
export type AuditLogEventIdentity = string;
|
|
180
234
|
/**
|
|
181
235
|
* JSON API type field
|
|
182
236
|
*
|
|
@@ -264,6 +318,23 @@ export type FieldType = 'field';
|
|
|
264
318
|
* via the `definition` "id".
|
|
265
319
|
*/
|
|
266
320
|
export type FieldIdentity = string;
|
|
321
|
+
/**
|
|
322
|
+
* JSON API type fieldset
|
|
323
|
+
*
|
|
324
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
325
|
+
* via the `definition` "type".
|
|
326
|
+
*/
|
|
327
|
+
export type FieldsetType = 'fieldset';
|
|
328
|
+
/**
|
|
329
|
+
* ID of fieldset
|
|
330
|
+
*
|
|
331
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
332
|
+
* via the `definition` "identity".
|
|
333
|
+
*
|
|
334
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
335
|
+
* via the `definition` "id".
|
|
336
|
+
*/
|
|
337
|
+
export type FieldsetIdentity = string;
|
|
267
338
|
/**
|
|
268
339
|
* JSON API type field
|
|
269
340
|
*
|
|
@@ -288,23 +359,6 @@ export type JobType = 'job';
|
|
|
288
359
|
* via the `definition` "id".
|
|
289
360
|
*/
|
|
290
361
|
export type JobIdentity = string;
|
|
291
|
-
/**
|
|
292
|
-
* JSON API type fieldset
|
|
293
|
-
*
|
|
294
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
295
|
-
* via the `definition` "type".
|
|
296
|
-
*/
|
|
297
|
-
export type FieldsetType = 'fieldset';
|
|
298
|
-
/**
|
|
299
|
-
* ID of fieldset
|
|
300
|
-
*
|
|
301
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
302
|
-
* via the `definition` "identity".
|
|
303
|
-
*
|
|
304
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
305
|
-
* via the `definition` "id".
|
|
306
|
-
*/
|
|
307
|
-
export type FieldsetIdentity = string;
|
|
308
362
|
/**
|
|
309
363
|
* JSON API type field
|
|
310
364
|
*
|
|
@@ -322,38 +376,6 @@ export type SessionType = 'session';
|
|
|
322
376
|
* via the `definition` "id".
|
|
323
377
|
*/
|
|
324
378
|
export type SessionIdentity = string;
|
|
325
|
-
/**
|
|
326
|
-
* JSON API type field
|
|
327
|
-
*
|
|
328
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
329
|
-
* via the `definition` "type".
|
|
330
|
-
*/
|
|
331
|
-
export type AccessTokenType = 'access_token';
|
|
332
|
-
/**
|
|
333
|
-
* ID of access_token
|
|
334
|
-
*
|
|
335
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
336
|
-
* via the `definition` "identity".
|
|
337
|
-
*
|
|
338
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
339
|
-
* via the `definition` "id".
|
|
340
|
-
*/
|
|
341
|
-
export type AccessTokenIdentity = string;
|
|
342
|
-
/**
|
|
343
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
344
|
-
* via the `destroy.hrefSchema` link.
|
|
345
|
-
*/
|
|
346
|
-
export type AccessTokenDestroyHrefSchema = {
|
|
347
|
-
/**
|
|
348
|
-
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
|
|
349
|
-
*/
|
|
350
|
-
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
351
|
-
/**
|
|
352
|
-
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
|
|
353
|
-
*/
|
|
354
|
-
destination_user_id?: string;
|
|
355
|
-
[k: string]: unknown;
|
|
356
|
-
};
|
|
357
379
|
/**
|
|
358
380
|
* JSON API type field
|
|
359
381
|
*
|
|
@@ -1214,6 +1236,17 @@ export type SiteType = 'site';
|
|
|
1214
1236
|
* via the `definition` "id".
|
|
1215
1237
|
*/
|
|
1216
1238
|
export type SiteIdentity = string;
|
|
1239
|
+
/**
|
|
1240
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
1241
|
+
* via the `self.hrefSchema` link.
|
|
1242
|
+
*/
|
|
1243
|
+
export type SiteSelfHrefSchema = {
|
|
1244
|
+
/**
|
|
1245
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
|
|
1246
|
+
*/
|
|
1247
|
+
include?: string;
|
|
1248
|
+
[k: string]: unknown;
|
|
1249
|
+
};
|
|
1217
1250
|
|
|
1218
1251
|
export type DatoApi = {
|
|
1219
1252
|
role?: Role;
|
|
@@ -2414,14 +2447,16 @@ export type UserInstancesTargetSchema = {
|
|
|
2414
2447
|
*/
|
|
2415
2448
|
export type UserSelfTargetSchema = {
|
|
2416
2449
|
data: User;
|
|
2450
|
+
included?: Role[];
|
|
2417
2451
|
};
|
|
2418
2452
|
|
|
2419
2453
|
/**
|
|
2420
2454
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2421
|
-
* via the `
|
|
2455
|
+
* via the `me.targetSchema` link.
|
|
2422
2456
|
*/
|
|
2423
|
-
export type
|
|
2424
|
-
data: User;
|
|
2457
|
+
export type UserMeTargetSchema = {
|
|
2458
|
+
data: User | SsoUser | AccessToken | Account;
|
|
2459
|
+
included?: Role[];
|
|
2425
2460
|
};
|
|
2426
2461
|
|
|
2427
2462
|
/**
|
|
@@ -2556,177 +2591,195 @@ export type SsoUserDestroyTargetSchema = {
|
|
|
2556
2591
|
};
|
|
2557
2592
|
|
|
2558
2593
|
/**
|
|
2559
|
-
*
|
|
2594
|
+
* An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
|
|
2560
2595
|
*
|
|
2561
2596
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2562
|
-
* via the `definition` "
|
|
2597
|
+
* via the `definition` "access_token".
|
|
2563
2598
|
*/
|
|
2564
|
-
export type
|
|
2565
|
-
type:
|
|
2566
|
-
id:
|
|
2567
|
-
attributes:
|
|
2568
|
-
|
|
2599
|
+
export type AccessToken = {
|
|
2600
|
+
type: AccessTokenType;
|
|
2601
|
+
id: AccessTokenIdentity;
|
|
2602
|
+
attributes: AccessTokenAttributes;
|
|
2603
|
+
relationships: AccessTokenRelationships;
|
|
2569
2604
|
};
|
|
2570
2605
|
|
|
2571
2606
|
/**
|
|
2572
2607
|
* JSON API attributes
|
|
2573
2608
|
*
|
|
2574
|
-
* This interface was referenced by `
|
|
2609
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2575
2610
|
* via the `definition` "attributes".
|
|
2576
2611
|
*/
|
|
2577
|
-
export type
|
|
2578
|
-
/**
|
|
2579
|
-
* The actual action performed
|
|
2580
|
-
*/
|
|
2581
|
-
action_name: string;
|
|
2612
|
+
export type AccessTokenAttributes = {
|
|
2582
2613
|
/**
|
|
2583
|
-
*
|
|
2614
|
+
* Name of API token
|
|
2584
2615
|
*/
|
|
2585
|
-
|
|
2586
|
-
/**
|
|
2587
|
-
* The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
|
|
2588
|
-
*/
|
|
2589
|
-
type: string;
|
|
2590
|
-
/**
|
|
2591
|
-
* The ID of the actor
|
|
2592
|
-
*/
|
|
2593
|
-
id: string;
|
|
2594
|
-
/**
|
|
2595
|
-
* An human representation of the actor (name/email/username depending on the type of actor)
|
|
2596
|
-
*/
|
|
2597
|
-
name: string;
|
|
2598
|
-
};
|
|
2616
|
+
name: string;
|
|
2599
2617
|
/**
|
|
2600
|
-
* The
|
|
2618
|
+
* The actual API token (or null if the current user has no permission to read the token)
|
|
2601
2619
|
*/
|
|
2602
|
-
|
|
2603
|
-
/**
|
|
2604
|
-
* The name of the role
|
|
2605
|
-
*/
|
|
2606
|
-
name: string;
|
|
2607
|
-
/**
|
|
2608
|
-
* The ID of the role
|
|
2609
|
-
*/
|
|
2610
|
-
id: string;
|
|
2611
|
-
};
|
|
2620
|
+
token?: null | string;
|
|
2612
2621
|
/**
|
|
2613
|
-
*
|
|
2622
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2614
2623
|
*/
|
|
2615
|
-
|
|
2616
|
-
/**
|
|
2617
|
-
* The ID of the environment
|
|
2618
|
-
*/
|
|
2619
|
-
id: string;
|
|
2620
|
-
/**
|
|
2621
|
-
* Whether the environment was the primary one at the time the action was performed
|
|
2622
|
-
*/
|
|
2623
|
-
primary: boolean;
|
|
2624
|
-
};
|
|
2624
|
+
can_access_cda: boolean;
|
|
2625
2625
|
/**
|
|
2626
|
-
*
|
|
2626
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2627
2627
|
*/
|
|
2628
|
-
|
|
2629
|
-
/**
|
|
2630
|
-
* The full path of the request
|
|
2631
|
-
*/
|
|
2632
|
-
path: string;
|
|
2633
|
-
/**
|
|
2634
|
-
* The HTTP method of the request
|
|
2635
|
-
*/
|
|
2636
|
-
method: string;
|
|
2637
|
-
/**
|
|
2638
|
-
* The X-Request-ID header of the request
|
|
2639
|
-
*/
|
|
2640
|
-
id?: string;
|
|
2641
|
-
/**
|
|
2642
|
-
* The full HTTP body of the request
|
|
2643
|
-
*/
|
|
2644
|
-
payload?: null | {
|
|
2645
|
-
[k: string]: unknown;
|
|
2646
|
-
};
|
|
2647
|
-
};
|
|
2628
|
+
can_access_cda_preview: boolean;
|
|
2648
2629
|
/**
|
|
2649
|
-
*
|
|
2630
|
+
* Whether this API token can access the Content Management API
|
|
2650
2631
|
*/
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
* The HTTP status code of the response
|
|
2654
|
-
*/
|
|
2655
|
-
status: number;
|
|
2656
|
-
/**
|
|
2657
|
-
* The full HTTP body of the response
|
|
2658
|
-
*/
|
|
2659
|
-
payload: {
|
|
2660
|
-
[k: string]: unknown;
|
|
2661
|
-
};
|
|
2662
|
-
};
|
|
2632
|
+
can_access_cma: boolean;
|
|
2633
|
+
hardcoded_type: null | string;
|
|
2663
2634
|
};
|
|
2664
2635
|
|
|
2665
2636
|
/**
|
|
2666
|
-
* JSON API
|
|
2637
|
+
* JSON API links
|
|
2667
2638
|
*
|
|
2668
|
-
* This interface was referenced by `
|
|
2669
|
-
* via the `definition` "
|
|
2639
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2640
|
+
* via the `definition` "relationships".
|
|
2670
2641
|
*/
|
|
2671
|
-
export type
|
|
2642
|
+
export type AccessTokenRelationships = {
|
|
2672
2643
|
/**
|
|
2673
|
-
*
|
|
2644
|
+
* Role
|
|
2674
2645
|
*/
|
|
2675
|
-
|
|
2646
|
+
role: {
|
|
2647
|
+
data: RoleData | null;
|
|
2648
|
+
};
|
|
2676
2649
|
};
|
|
2677
2650
|
|
|
2678
2651
|
/**
|
|
2679
2652
|
* JSON API data
|
|
2680
2653
|
*
|
|
2681
|
-
* This interface was referenced by `
|
|
2654
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2682
2655
|
* via the `definition` "data".
|
|
2683
2656
|
*/
|
|
2684
|
-
export type
|
|
2685
|
-
type:
|
|
2686
|
-
id:
|
|
2657
|
+
export type AccessTokenData = {
|
|
2658
|
+
type: AccessTokenType;
|
|
2659
|
+
id: AccessTokenIdentity;
|
|
2687
2660
|
};
|
|
2688
2661
|
|
|
2689
2662
|
/**
|
|
2690
|
-
* This interface was referenced by `
|
|
2691
|
-
* via the `
|
|
2663
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2664
|
+
* via the `create.schema` link.
|
|
2692
2665
|
*/
|
|
2693
|
-
export type
|
|
2666
|
+
export type AccessTokenCreateSchema = {
|
|
2694
2667
|
data: {
|
|
2695
|
-
|
|
2696
|
-
* JSON API type field
|
|
2697
|
-
*/
|
|
2698
|
-
type: 'audit_log_query';
|
|
2668
|
+
type: AccessTokenType;
|
|
2699
2669
|
attributes: {
|
|
2700
2670
|
/**
|
|
2701
|
-
*
|
|
2671
|
+
* Name of API token
|
|
2702
2672
|
*/
|
|
2703
|
-
|
|
2673
|
+
name: string;
|
|
2704
2674
|
/**
|
|
2705
|
-
*
|
|
2675
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2706
2676
|
*/
|
|
2707
|
-
|
|
2677
|
+
can_access_cda: boolean;
|
|
2708
2678
|
/**
|
|
2709
|
-
* Whether
|
|
2679
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2710
2680
|
*/
|
|
2711
|
-
|
|
2681
|
+
can_access_cda_preview: boolean;
|
|
2682
|
+
/**
|
|
2683
|
+
* Whether this API token can access the Content Management API
|
|
2684
|
+
*/
|
|
2685
|
+
can_access_cma: boolean;
|
|
2686
|
+
};
|
|
2687
|
+
relationships: {
|
|
2688
|
+
/**
|
|
2689
|
+
* Role
|
|
2690
|
+
*/
|
|
2691
|
+
role: {
|
|
2692
|
+
data: RoleData | null;
|
|
2693
|
+
};
|
|
2712
2694
|
};
|
|
2713
2695
|
};
|
|
2714
2696
|
};
|
|
2715
2697
|
|
|
2716
2698
|
/**
|
|
2717
|
-
* This interface was referenced by `
|
|
2718
|
-
* via the `
|
|
2699
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2700
|
+
* via the `create.targetSchema` link.
|
|
2719
2701
|
*/
|
|
2720
|
-
export type
|
|
2721
|
-
data:
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
|
|
2702
|
+
export type AccessTokenCreateTargetSchema = {
|
|
2703
|
+
data: AccessToken;
|
|
2704
|
+
};
|
|
2705
|
+
|
|
2706
|
+
/**
|
|
2707
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2708
|
+
* via the `update.schema` link.
|
|
2709
|
+
*/
|
|
2710
|
+
export type AccessTokenUpdateSchema = {
|
|
2711
|
+
data: {
|
|
2712
|
+
type: AccessTokenType;
|
|
2713
|
+
id: AccessTokenIdentity;
|
|
2714
|
+
attributes: {
|
|
2715
|
+
/**
|
|
2716
|
+
* Name of API token
|
|
2717
|
+
*/
|
|
2718
|
+
name: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2721
|
+
*/
|
|
2722
|
+
can_access_cda: boolean;
|
|
2723
|
+
/**
|
|
2724
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2725
|
+
*/
|
|
2726
|
+
can_access_cda_preview: boolean;
|
|
2727
|
+
/**
|
|
2728
|
+
* Whether this API token can access the Content Management API
|
|
2729
|
+
*/
|
|
2730
|
+
can_access_cma: boolean;
|
|
2731
|
+
};
|
|
2732
|
+
relationships: {
|
|
2733
|
+
/**
|
|
2734
|
+
* Role
|
|
2735
|
+
*/
|
|
2736
|
+
role: {
|
|
2737
|
+
data: RoleData | null;
|
|
2738
|
+
};
|
|
2739
|
+
};
|
|
2727
2740
|
};
|
|
2728
2741
|
};
|
|
2729
2742
|
|
|
2743
|
+
/**
|
|
2744
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2745
|
+
* via the `update.targetSchema` link.
|
|
2746
|
+
*/
|
|
2747
|
+
export type AccessTokenUpdateTargetSchema = {
|
|
2748
|
+
data: AccessToken;
|
|
2749
|
+
};
|
|
2750
|
+
|
|
2751
|
+
/**
|
|
2752
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2753
|
+
* via the `instances.targetSchema` link.
|
|
2754
|
+
*/
|
|
2755
|
+
export type AccessTokenInstancesTargetSchema = {
|
|
2756
|
+
data: AccessToken[];
|
|
2757
|
+
};
|
|
2758
|
+
|
|
2759
|
+
/**
|
|
2760
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2761
|
+
* via the `self.targetSchema` link.
|
|
2762
|
+
*/
|
|
2763
|
+
export type AccessTokenSelfTargetSchema = {
|
|
2764
|
+
data: AccessToken;
|
|
2765
|
+
};
|
|
2766
|
+
|
|
2767
|
+
/**
|
|
2768
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2769
|
+
* via the `regenerate_token.targetSchema` link.
|
|
2770
|
+
*/
|
|
2771
|
+
export type AccessTokenRegenerateTokenTargetSchema = {
|
|
2772
|
+
data: AccessToken;
|
|
2773
|
+
};
|
|
2774
|
+
|
|
2775
|
+
/**
|
|
2776
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2777
|
+
* via the `destroy.targetSchema` link.
|
|
2778
|
+
*/
|
|
2779
|
+
export type AccessTokenDestroyTargetSchema = {
|
|
2780
|
+
data: AccessToken;
|
|
2781
|
+
};
|
|
2782
|
+
|
|
2730
2783
|
/**
|
|
2731
2784
|
* DatoCMS account
|
|
2732
2785
|
*
|
|
@@ -2774,9 +2827,189 @@ export type AccountAttributes = {
|
|
|
2774
2827
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
2775
2828
|
* via the `definition` "data".
|
|
2776
2829
|
*/
|
|
2777
|
-
export type AccountData = {
|
|
2778
|
-
type: AccountType;
|
|
2779
|
-
id: AccountIdentity;
|
|
2830
|
+
export type AccountData = {
|
|
2831
|
+
type: AccountType;
|
|
2832
|
+
id: AccountIdentity;
|
|
2833
|
+
};
|
|
2834
|
+
|
|
2835
|
+
/**
|
|
2836
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
2837
|
+
* via the `destroy.targetSchema` link.
|
|
2838
|
+
*/
|
|
2839
|
+
export type UserDestroyTargetSchema = {
|
|
2840
|
+
data: User;
|
|
2841
|
+
};
|
|
2842
|
+
|
|
2843
|
+
/**
|
|
2844
|
+
* If the Audit log functionality is enabled in a project, logged events can be queried using SQL-like language and fetched in full detail so that they can be exported or analyzed.
|
|
2845
|
+
*
|
|
2846
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2847
|
+
* via the `definition` "audit_log_event".
|
|
2848
|
+
*/
|
|
2849
|
+
export type AuditLogEvent = {
|
|
2850
|
+
type: AuditLogEventType;
|
|
2851
|
+
id: AuditLogEventIdentity;
|
|
2852
|
+
attributes: AuditLogEventAttributes;
|
|
2853
|
+
meta: AuditLogEventMeta;
|
|
2854
|
+
};
|
|
2855
|
+
|
|
2856
|
+
/**
|
|
2857
|
+
* JSON API attributes
|
|
2858
|
+
*
|
|
2859
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2860
|
+
* via the `definition` "attributes".
|
|
2861
|
+
*/
|
|
2862
|
+
export type AuditLogEventAttributes = {
|
|
2863
|
+
/**
|
|
2864
|
+
* The actual action performed
|
|
2865
|
+
*/
|
|
2866
|
+
action_name: string;
|
|
2867
|
+
/**
|
|
2868
|
+
* The actor who performed the action
|
|
2869
|
+
*/
|
|
2870
|
+
actor: {
|
|
2871
|
+
/**
|
|
2872
|
+
* The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
|
|
2873
|
+
*/
|
|
2874
|
+
type: string;
|
|
2875
|
+
/**
|
|
2876
|
+
* The ID of the actor
|
|
2877
|
+
*/
|
|
2878
|
+
id: string;
|
|
2879
|
+
/**
|
|
2880
|
+
* An human representation of the actor (name/email/username depending on the type of actor)
|
|
2881
|
+
*/
|
|
2882
|
+
name: string;
|
|
2883
|
+
};
|
|
2884
|
+
/**
|
|
2885
|
+
* The role of the actor at the time the action was performed
|
|
2886
|
+
*/
|
|
2887
|
+
role: null | {
|
|
2888
|
+
/**
|
|
2889
|
+
* The name of the role
|
|
2890
|
+
*/
|
|
2891
|
+
name: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* The ID of the role
|
|
2894
|
+
*/
|
|
2895
|
+
id: string;
|
|
2896
|
+
};
|
|
2897
|
+
/**
|
|
2898
|
+
* The environment inside of which the action was performed
|
|
2899
|
+
*/
|
|
2900
|
+
environment: {
|
|
2901
|
+
/**
|
|
2902
|
+
* The ID of the environment
|
|
2903
|
+
*/
|
|
2904
|
+
id: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* Whether the environment was the primary one at the time the action was performed
|
|
2907
|
+
*/
|
|
2908
|
+
primary: boolean;
|
|
2909
|
+
};
|
|
2910
|
+
/**
|
|
2911
|
+
* The actual request being performed
|
|
2912
|
+
*/
|
|
2913
|
+
request: {
|
|
2914
|
+
/**
|
|
2915
|
+
* The full path of the request
|
|
2916
|
+
*/
|
|
2917
|
+
path: string;
|
|
2918
|
+
/**
|
|
2919
|
+
* The HTTP method of the request
|
|
2920
|
+
*/
|
|
2921
|
+
method: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* The X-Request-ID header of the request
|
|
2924
|
+
*/
|
|
2925
|
+
id?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* The full HTTP body of the request
|
|
2928
|
+
*/
|
|
2929
|
+
payload?: null | {
|
|
2930
|
+
[k: string]: unknown;
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
/**
|
|
2934
|
+
* The actual response being returned by DatoCMS
|
|
2935
|
+
*/
|
|
2936
|
+
response: null | {
|
|
2937
|
+
/**
|
|
2938
|
+
* The HTTP status code of the response
|
|
2939
|
+
*/
|
|
2940
|
+
status: number;
|
|
2941
|
+
/**
|
|
2942
|
+
* The full HTTP body of the response
|
|
2943
|
+
*/
|
|
2944
|
+
payload: {
|
|
2945
|
+
[k: string]: unknown;
|
|
2946
|
+
};
|
|
2947
|
+
};
|
|
2948
|
+
};
|
|
2949
|
+
|
|
2950
|
+
/**
|
|
2951
|
+
* JSON API meta
|
|
2952
|
+
*
|
|
2953
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2954
|
+
* via the `definition` "meta".
|
|
2955
|
+
*/
|
|
2956
|
+
export type AuditLogEventMeta = {
|
|
2957
|
+
/**
|
|
2958
|
+
* The date of the event
|
|
2959
|
+
*/
|
|
2960
|
+
occurred_at: string;
|
|
2961
|
+
};
|
|
2962
|
+
|
|
2963
|
+
/**
|
|
2964
|
+
* JSON API data
|
|
2965
|
+
*
|
|
2966
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2967
|
+
* via the `definition` "data".
|
|
2968
|
+
*/
|
|
2969
|
+
export type AuditLogEventData = {
|
|
2970
|
+
type: AuditLogEventType;
|
|
2971
|
+
id: AuditLogEventIdentity;
|
|
2972
|
+
};
|
|
2973
|
+
|
|
2974
|
+
/**
|
|
2975
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2976
|
+
* via the `query.schema` link.
|
|
2977
|
+
*/
|
|
2978
|
+
export type AuditLogEventQuerySchema = {
|
|
2979
|
+
data: {
|
|
2980
|
+
/**
|
|
2981
|
+
* JSON API type field
|
|
2982
|
+
*/
|
|
2983
|
+
type: 'audit_log_query';
|
|
2984
|
+
attributes: {
|
|
2985
|
+
/**
|
|
2986
|
+
* An SQL-like expression to filter the events
|
|
2987
|
+
*/
|
|
2988
|
+
filter?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
* Set this value to get remaining results, if a meta.next_token was returned in the previous query response
|
|
2991
|
+
*/
|
|
2992
|
+
next_token?: string;
|
|
2993
|
+
/**
|
|
2994
|
+
* Whether a detailed log complete with full request and response payload must be returned or not
|
|
2995
|
+
*/
|
|
2996
|
+
detailed_log?: boolean;
|
|
2997
|
+
};
|
|
2998
|
+
};
|
|
2999
|
+
};
|
|
3000
|
+
|
|
3001
|
+
/**
|
|
3002
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
3003
|
+
* via the `query.targetSchema` link.
|
|
3004
|
+
*/
|
|
3005
|
+
export type AuditLogEventQueryTargetSchema = {
|
|
3006
|
+
data: AuditLogEvent[];
|
|
3007
|
+
meta: {
|
|
3008
|
+
/**
|
|
3009
|
+
* If the response request exceeds the response payload limit DatoCMS will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results
|
|
3010
|
+
*/
|
|
3011
|
+
next_token: null | string;
|
|
3012
|
+
};
|
|
2780
3013
|
};
|
|
2781
3014
|
|
|
2782
3015
|
/**
|
|
@@ -3329,6 +3562,12 @@ export type ItemTypeRelationships = {
|
|
|
3329
3562
|
fields: {
|
|
3330
3563
|
data: FieldData[];
|
|
3331
3564
|
};
|
|
3565
|
+
/**
|
|
3566
|
+
* The list of item type fieldsets
|
|
3567
|
+
*/
|
|
3568
|
+
fieldsets: {
|
|
3569
|
+
data: FieldsetData[];
|
|
3570
|
+
};
|
|
3332
3571
|
/**
|
|
3333
3572
|
* The field to use as display title
|
|
3334
3573
|
*/
|
|
@@ -3383,6 +3622,17 @@ export type FieldData = {
|
|
|
3383
3622
|
id: FieldIdentity;
|
|
3384
3623
|
};
|
|
3385
3624
|
|
|
3625
|
+
/**
|
|
3626
|
+
* JSON API data
|
|
3627
|
+
*
|
|
3628
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
3629
|
+
* via the `definition` "data".
|
|
3630
|
+
*/
|
|
3631
|
+
export type FieldsetData = {
|
|
3632
|
+
type: FieldsetType;
|
|
3633
|
+
id: FieldsetIdentity;
|
|
3634
|
+
};
|
|
3635
|
+
|
|
3386
3636
|
/**
|
|
3387
3637
|
* JSON API data
|
|
3388
3638
|
*
|
|
@@ -3693,7 +3943,839 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
3693
3943
|
};
|
|
3694
3944
|
|
|
3695
3945
|
/**
|
|
3696
|
-
*
|
|
3946
|
+
* DatoCMS offers a number of different fields that you can combine togheter to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
|
|
3947
|
+
*
|
|
3948
|
+
* ### Different field types require different settings
|
|
3949
|
+
*
|
|
3950
|
+
* When looking at a field resource, you have to pay attention to two particular properties, `validators` and `appearance`.
|
|
3951
|
+
*
|
|
3952
|
+
* The `validators` property expresses the set of validations to be performed server-side on a specific field value for it to be considered valid, while the `appearance` property lets you specify _how_ the field itself will be presented inside the form to the final editor.
|
|
3953
|
+
*
|
|
3954
|
+
* For both properties, the value to specify depends on the type of field itself. For example, you can add a "Limit character count" validation to a _Single-line string_ field, or set its appearence to "Show it as heading", but they won't be accepted for a ie. _Color_ field, as it supports different validations and appearance settings.
|
|
3955
|
+
*
|
|
3956
|
+
* ### Specifying validations
|
|
3957
|
+
*
|
|
3958
|
+
* The `validators` property requires an object whose keys are the validations that you want to be enforced, and the values are objects representing any settings that the validation itself requires. If the validation doesn't have additional settings, you just pass down an empty object.
|
|
3959
|
+
*
|
|
3960
|
+
* This is a valid example for a _Single-line string_ field:
|
|
3961
|
+
*
|
|
3962
|
+
* ```js
|
|
3963
|
+
* {
|
|
3964
|
+
* "validators": {
|
|
3965
|
+
* // "required" validator has no settings
|
|
3966
|
+
* "required": {},
|
|
3967
|
+
* // "length" validator requires "min" and/or "max" properties
|
|
3968
|
+
* "length": { "min": 80 }
|
|
3969
|
+
* }
|
|
3970
|
+
* }
|
|
3971
|
+
* ```
|
|
3972
|
+
*
|
|
3973
|
+
* Below you'll find a summary of all the validators available for each field type with their settings.
|
|
3974
|
+
*
|
|
3975
|
+
* Some validators are required for a specific type of field. For example, the _Slug_ field needs to have a `slug_title_field` validator to specify the ID of the _Single-line string_ field that will be used to generate the slug itself.
|
|
3976
|
+
*
|
|
3977
|
+
* ### Specifying the appearance
|
|
3978
|
+
*
|
|
3979
|
+
* The `appearance` property requires an object with three specific properties: `editor`, `parameters` and `addons`.
|
|
3980
|
+
*
|
|
3981
|
+
* The `editor` represents the type of editor that the users will see inside the form to change the value of this specific field. Depending on the type of field, DatoCMS offers a number of different editors for you to choose from. The `parameters` property is an object representing any additional settings that the editor itself might require.
|
|
3982
|
+
*
|
|
3983
|
+
* This is a valid example for a _Single-line string_ field:
|
|
3984
|
+
*
|
|
3985
|
+
* ```js
|
|
3986
|
+
* {
|
|
3987
|
+
* "appearance": {
|
|
3988
|
+
* // single_line is a DatoCMS built-in editor that you can use with single-line string fields
|
|
3989
|
+
* "editor": "single_line",
|
|
3990
|
+
* // each built-in editor has specific settings
|
|
3991
|
+
* "parameters": { "heading": true },
|
|
3992
|
+
* "addons": []
|
|
3993
|
+
* },
|
|
3994
|
+
* }
|
|
3995
|
+
* ```
|
|
3996
|
+
*
|
|
3997
|
+
* Following you'll find a summary of all the editors available for each field type with their settings.
|
|
3998
|
+
*
|
|
3999
|
+
* #### Setting the appearance to a field editor provided by a plugin
|
|
4000
|
+
*
|
|
4001
|
+
* If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the build-in editors.
|
|
4002
|
+
*
|
|
4003
|
+
* In this case:
|
|
4004
|
+
*
|
|
4005
|
+
* - the `editor` property must be the ID of the plugin;
|
|
4006
|
+
* - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes;
|
|
4007
|
+
* - the `parameters` property must provide a configuration object compatible with the [config screen of the manual field extension](/docs/plugin-sdk/manual-field-extensions#add-per-field-config-screens-to-manual-field-extensions), or an empty object if it doesn't require any configuration.
|
|
4008
|
+
*
|
|
4009
|
+
* ```js
|
|
4010
|
+
* {
|
|
4011
|
+
* "appearance": {
|
|
4012
|
+
* // "2132" is a the ID of a plugin exposing a manual field editor
|
|
4013
|
+
* "editor": "2134",
|
|
4014
|
+
* // "starRating" is a manual field editor exposed by the plugin
|
|
4015
|
+
* "field_extension": "starRating",
|
|
4016
|
+
* // this is a valid configuration for the "starRating" field editor
|
|
4017
|
+
* "parameters": { "maxRating": 5, "starsColor": "#ff0000" },
|
|
4018
|
+
* "addons": []
|
|
4019
|
+
* },
|
|
4020
|
+
* }
|
|
4021
|
+
* ```
|
|
4022
|
+
*
|
|
4023
|
+
* #### Configuring manual field addons
|
|
4024
|
+
*
|
|
4025
|
+
* If the project contains plugins that expose [manual field addons](/docs/plugin-sdk/manual-field-extensions), you can also add them to the field via the `addons` property.
|
|
4026
|
+
*
|
|
4027
|
+
* ```js
|
|
4028
|
+
* {
|
|
4029
|
+
* "appearance": {
|
|
4030
|
+
* "editor": "single_line",
|
|
4031
|
+
* "parameters": { "heading": true },
|
|
4032
|
+
* "addons": [
|
|
4033
|
+
* {
|
|
4034
|
+
* // "2138" is a the ID of a plugin exposing a manual addon editor
|
|
4035
|
+
* "id": "2138",
|
|
4036
|
+
* // "loremIpsumGenerator" is a manual field addon exposed by the plugin
|
|
4037
|
+
* "field_extension": "loremIpsumGenerator",
|
|
4038
|
+
* // this is a valid configuration for the "loremIpsumGenerator" field addon
|
|
4039
|
+
* "parameters": { "sentences": 2 },
|
|
4040
|
+
* }
|
|
4041
|
+
* ]
|
|
4042
|
+
* },
|
|
4043
|
+
* }
|
|
4044
|
+
* ```
|
|
4045
|
+
*
|
|
4046
|
+
* ### Available field types
|
|
4047
|
+
*
|
|
4048
|
+
* <details>
|
|
4049
|
+
* <summary>Single-line string (<code>string</code>)</summary>
|
|
4050
|
+
*
|
|
4051
|
+
* | Property | Value |
|
|
4052
|
+
* | ------------------------------ | ---------------------------------------------------- |
|
|
4053
|
+
* | Code | `string` |
|
|
4054
|
+
* | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
|
|
4055
|
+
* | Available validators | `required`, `unique`, `length`, `format`, `enum` |
|
|
4056
|
+
*
|
|
4057
|
+
* </details>
|
|
4058
|
+
*
|
|
4059
|
+
* <details>
|
|
4060
|
+
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
4061
|
+
*
|
|
4062
|
+
* | Property | Value |
|
|
4063
|
+
* | ------------------------------ | --------------------------------- |
|
|
4064
|
+
* | Code | `text` |
|
|
4065
|
+
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
4066
|
+
* | Available validators | `required`, `length`, `format` |
|
|
4067
|
+
*
|
|
4068
|
+
* </details>
|
|
4069
|
+
*
|
|
4070
|
+
* <details>
|
|
4071
|
+
* <summary>Boolean (<code>boolean</code>)</summary>
|
|
4072
|
+
*
|
|
4073
|
+
* | Property | Value |
|
|
4074
|
+
* | ------------------------------ | -------------------------------- |
|
|
4075
|
+
* | Code | `boolean` |
|
|
4076
|
+
* | Built-in editors for the field | `boolean`, `boolean_radio_group` |
|
|
4077
|
+
* | Available validators | no validators available |
|
|
4078
|
+
*
|
|
4079
|
+
* </details>
|
|
4080
|
+
*
|
|
4081
|
+
* <details>
|
|
4082
|
+
* <summary>Integer (<code>integer</code>)</summary>
|
|
4083
|
+
*
|
|
4084
|
+
* | Property | Value |
|
|
4085
|
+
* | ------------------------------ | -------------------------- |
|
|
4086
|
+
* | Code | `integer` |
|
|
4087
|
+
* | Built-in editors for the field | `integer` |
|
|
4088
|
+
* | Available validators | `required`, `number_range` |
|
|
4089
|
+
*
|
|
4090
|
+
* </details>
|
|
4091
|
+
*
|
|
4092
|
+
* <details>
|
|
4093
|
+
* <summary>Float (<code>float</code>)</summary>
|
|
4094
|
+
*
|
|
4095
|
+
* | Property | Value |
|
|
4096
|
+
* | ------------------------------ | -------------------------- |
|
|
4097
|
+
* | Code | `float` |
|
|
4098
|
+
* | Built-in editors for the field | `float` |
|
|
4099
|
+
* | Available validators | `required`, `number_range` |
|
|
4100
|
+
*
|
|
4101
|
+
* </details>
|
|
4102
|
+
*
|
|
4103
|
+
* <details>
|
|
4104
|
+
* <summary>Date (<code>date</code>)</summary>
|
|
4105
|
+
*
|
|
4106
|
+
* | Property | Value |
|
|
4107
|
+
* | ------------------------------ | ------------------------ |
|
|
4108
|
+
* | Code | `date` |
|
|
4109
|
+
* | Built-in editors for the field | `date_picker` |
|
|
4110
|
+
* | Available validators | `required`, `date_range` |
|
|
4111
|
+
*
|
|
4112
|
+
* </details>
|
|
4113
|
+
*
|
|
4114
|
+
* <details>
|
|
4115
|
+
* <summary>Date time (<code>date_time</code>)</summary>
|
|
4116
|
+
*
|
|
4117
|
+
* | Property | Value |
|
|
4118
|
+
* | ------------------------------ | ----------------------------- |
|
|
4119
|
+
* | Code | `date_time` |
|
|
4120
|
+
* | Built-in editors for the field | `date_time_picker` |
|
|
4121
|
+
* | Available validators | `required`, `date_time_range` |
|
|
4122
|
+
*
|
|
4123
|
+
* </details>
|
|
4124
|
+
*
|
|
4125
|
+
* <details>
|
|
4126
|
+
* <summary>Color (<code>color</code>)</summary>
|
|
4127
|
+
*
|
|
4128
|
+
* | Property | Value |
|
|
4129
|
+
* | ------------------------------ | -------------- |
|
|
4130
|
+
* | Code | `color` |
|
|
4131
|
+
* | Built-in editors for the field | `color_picker` |
|
|
4132
|
+
* | Available validators | `required` |
|
|
4133
|
+
*
|
|
4134
|
+
* </details>
|
|
4135
|
+
*
|
|
4136
|
+
* <details>
|
|
4137
|
+
* <summary>JSON (<code>json</code>)</summary>
|
|
4138
|
+
*
|
|
4139
|
+
* | Property | Value |
|
|
4140
|
+
* | ------------------------------ | ------------------------------------------------------ |
|
|
4141
|
+
* | Code | `json` |
|
|
4142
|
+
* | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
|
|
4143
|
+
* | Available validators | `required` |
|
|
4144
|
+
*
|
|
4145
|
+
* </details>
|
|
4146
|
+
*
|
|
4147
|
+
* <details>
|
|
4148
|
+
* <summary>Location (<code>lat_lon</code>)</summary>
|
|
4149
|
+
*
|
|
4150
|
+
* | Property | Value |
|
|
4151
|
+
* | ------------------------------ | ---------- |
|
|
4152
|
+
* | Code | `lat_lon` |
|
|
4153
|
+
* | Built-in editors for the field | `map` |
|
|
4154
|
+
* | Available validators | `required` |
|
|
4155
|
+
*
|
|
4156
|
+
* </details>
|
|
4157
|
+
*
|
|
4158
|
+
* <details>
|
|
4159
|
+
* <summary>SEO (<code>seo</code>)</summary>
|
|
4160
|
+
*
|
|
4161
|
+
* | Property | Value |
|
|
4162
|
+
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
4163
|
+
* | Code | `seo` |
|
|
4164
|
+
* | Built-in editors for the field | `seo` |
|
|
4165
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
|
|
4166
|
+
*
|
|
4167
|
+
* </details>
|
|
4168
|
+
*
|
|
4169
|
+
* <details>
|
|
4170
|
+
* <summary>Slug (<code>slug</code>)</summary>
|
|
4171
|
+
*
|
|
4172
|
+
* | Property | Value |
|
|
4173
|
+
* | ------------------------------ | ----------------------------------- |
|
|
4174
|
+
* | Code | `slug` |
|
|
4175
|
+
* | Built-in editors for the field | `slug` |
|
|
4176
|
+
* | Required validators | `slug_title_field` |
|
|
4177
|
+
* | Other validators available | `required`, `length`, `slug_format` |
|
|
4178
|
+
*
|
|
4179
|
+
* </details>
|
|
4180
|
+
*
|
|
4181
|
+
* <details>
|
|
4182
|
+
* <summary>External video (<code>video</code>)</summary>
|
|
4183
|
+
*
|
|
4184
|
+
* | Property | Value |
|
|
4185
|
+
* | ------------------------------ | ---------- |
|
|
4186
|
+
* | Code | `video` |
|
|
4187
|
+
* | Built-in editors for the field | `video` |
|
|
4188
|
+
* | Available validators | `required` |
|
|
4189
|
+
*
|
|
4190
|
+
* </details>
|
|
4191
|
+
*
|
|
4192
|
+
* <details>
|
|
4193
|
+
* <summary>Single-asset (<code>file</code>)</summary>
|
|
4194
|
+
*
|
|
4195
|
+
* | Property | Value |
|
|
4196
|
+
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
4197
|
+
* | Code | `file` |
|
|
4198
|
+
* | Built-in editors for the field | `file` |
|
|
4199
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4200
|
+
*
|
|
4201
|
+
* </details>
|
|
4202
|
+
*
|
|
4203
|
+
* <details>
|
|
4204
|
+
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
4205
|
+
*
|
|
4206
|
+
* | Property | Value |
|
|
4207
|
+
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
4208
|
+
* | Code | `gallery` |
|
|
4209
|
+
* | Built-in editors for the field | `gallery` |
|
|
4210
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4211
|
+
*
|
|
4212
|
+
* </details>
|
|
4213
|
+
*
|
|
4214
|
+
* <details>
|
|
4215
|
+
* <summary>Single link (<code>link</code>)</summary>
|
|
4216
|
+
*
|
|
4217
|
+
* | Property | Value |
|
|
4218
|
+
* | ------------------------------ | --------------------------- |
|
|
4219
|
+
* | Code | `link` |
|
|
4220
|
+
* | Built-in editors for the field | `link_select`, `link_embed` |
|
|
4221
|
+
* | Default `editor` | `link_select` |
|
|
4222
|
+
* | Required validators | `item_item_type` |
|
|
4223
|
+
* | Other validators available | `required`, `unique` |
|
|
4224
|
+
*
|
|
4225
|
+
* </details>
|
|
4226
|
+
*
|
|
4227
|
+
* <details>
|
|
4228
|
+
* <summary>Multiple links (<code>links</code>)</summary>
|
|
4229
|
+
*
|
|
4230
|
+
* | Property | Value |
|
|
4231
|
+
* | ------------------------------ | ----------------------------- |
|
|
4232
|
+
* | Code | `links` |
|
|
4233
|
+
* | Built-in editors for the field | `links_select`, `links_embed` |
|
|
4234
|
+
* | Default `editor` | `links_select` |
|
|
4235
|
+
* | Required validators | `items_item_type` |
|
|
4236
|
+
* | Other validators available | `size` |
|
|
4237
|
+
*
|
|
4238
|
+
* </details>
|
|
4239
|
+
*
|
|
4240
|
+
* <details>
|
|
4241
|
+
* <summary>Modular content (<code>rich_text</code>)</summary>
|
|
4242
|
+
*
|
|
4243
|
+
* | Property | Value |
|
|
4244
|
+
* | ------------------------------ | ------------------ |
|
|
4245
|
+
* | Code | `rich_text` |
|
|
4246
|
+
* | Built-in editors for the field | `rich_text` |
|
|
4247
|
+
* | Required validators | `rich_text_blocks` |
|
|
4248
|
+
* | Other validators available | `size` |
|
|
4249
|
+
*
|
|
4250
|
+
* </details>
|
|
4251
|
+
*
|
|
4252
|
+
* <details>
|
|
4253
|
+
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4254
|
+
*
|
|
4255
|
+
* | Property | Value |
|
|
4256
|
+
* | ------------------------------ | ------------------------------------------------- |
|
|
4257
|
+
* | Code | `structured_text` |
|
|
4258
|
+
* | Built-in editors for the field | `structured_text` |
|
|
4259
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
4260
|
+
* | Other validators available | `length` |
|
|
4261
|
+
*
|
|
4262
|
+
* </details>
|
|
4263
|
+
*
|
|
4264
|
+
* ### Validators
|
|
4265
|
+
*
|
|
4266
|
+
* <details>
|
|
4267
|
+
* <summary><code>date_range</code></summary>
|
|
4268
|
+
*
|
|
4269
|
+
* Accept dates only inside a specified date range.
|
|
4270
|
+
*
|
|
4271
|
+
* | Parameter | Type | Required | Description |
|
|
4272
|
+
* | --------- | ------------- | -------- | ------------ |
|
|
4273
|
+
* | `min` | ISO 8601 date | | Minimum date |
|
|
4274
|
+
* | `max` | ISO 8601 date | | Maximum date |
|
|
4275
|
+
*
|
|
4276
|
+
* At least one of the parameters must be specified.
|
|
4277
|
+
*
|
|
4278
|
+
* </details>
|
|
4279
|
+
*
|
|
4280
|
+
* <details>
|
|
4281
|
+
* <summary><code>date_time_range</code></summary>
|
|
4282
|
+
*
|
|
4283
|
+
* Accept date times only inside a specified date range.
|
|
4284
|
+
*
|
|
4285
|
+
* | Parameter | Type | Required | Description |
|
|
4286
|
+
* | --------- | ----------------- | -------- | ---------------- |
|
|
4287
|
+
* | `min` | ISO 8601 datetime | | Minimum datetime |
|
|
4288
|
+
* | `max` | ISO 8601 datetime | | Maximum datetime |
|
|
4289
|
+
*
|
|
4290
|
+
* At least one of the parameters must be specified.
|
|
4291
|
+
*
|
|
4292
|
+
* </details>
|
|
4293
|
+
*
|
|
4294
|
+
* <details>
|
|
4295
|
+
* <summary><code>enum</code></summary>
|
|
4296
|
+
*
|
|
4297
|
+
* Only accept a specific set of values
|
|
4298
|
+
*
|
|
4299
|
+
* | Parameter | Type | Required | Description |
|
|
4300
|
+
* | --------- | --------------- | -------- | --------------------- |
|
|
4301
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4302
|
+
*
|
|
4303
|
+
* </details>
|
|
4304
|
+
*
|
|
4305
|
+
* <details>
|
|
4306
|
+
* <summary><code>extension</code></summary>
|
|
4307
|
+
*
|
|
4308
|
+
* Only accept assets with specific file extensions.
|
|
4309
|
+
*
|
|
4310
|
+
* | Parameter | Type | Required | Description |
|
|
4311
|
+
* | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
|
|
4312
|
+
* | `extensions` | `Array<String>` | | Set of allowed file extensions |
|
|
4313
|
+
* | `predefined_list` | one of `"image"`, `"video"`, `"document"` | | Allowed file type |
|
|
4314
|
+
*
|
|
4315
|
+
* Only one of the parameters must be specified.
|
|
4316
|
+
*
|
|
4317
|
+
* </details>
|
|
4318
|
+
*
|
|
4319
|
+
* <details>
|
|
4320
|
+
* <summary><code>file_size</code></summary>
|
|
4321
|
+
*
|
|
4322
|
+
* Accept assets only inside a specified date range.
|
|
4323
|
+
*
|
|
4324
|
+
* | Parameter | Type | Required | Description |
|
|
4325
|
+
* | ----------- | ---------------------------- | -------- | ---------------------------------- |
|
|
4326
|
+
* | `min_value` | `Integer` | | Numeric value for minimum filesize |
|
|
4327
|
+
* | `min_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for minimum filesize |
|
|
4328
|
+
* | `max_value` | `Integer` | | Numeric value for maximum filesize |
|
|
4329
|
+
* | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
|
|
4330
|
+
*
|
|
4331
|
+
* At least one couple of value/unit must be specified.
|
|
4332
|
+
*
|
|
4333
|
+
* </details>
|
|
4334
|
+
*
|
|
4335
|
+
* <details>
|
|
4336
|
+
* <summary><code>format</code></summary>
|
|
4337
|
+
*
|
|
4338
|
+
* Only accept strings having a specific format.
|
|
4339
|
+
*
|
|
4340
|
+
* | Parameter | Type | Required | Description |
|
|
4341
|
+
* | -------------------- | ------------------------- | -------- | ---------------------------------- |
|
|
4342
|
+
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
4343
|
+
* | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
|
|
4344
|
+
*
|
|
4345
|
+
* Only one of the parameters must be specified.
|
|
4346
|
+
*
|
|
4347
|
+
* </details>
|
|
4348
|
+
*
|
|
4349
|
+
* <details>
|
|
4350
|
+
* <summary><code>slug_format</code></summary>
|
|
4351
|
+
*
|
|
4352
|
+
* Only accept slugs having a specific format.
|
|
4353
|
+
*
|
|
4354
|
+
* | Parameter | Type | Required | Description |
|
|
4355
|
+
* | -------------------- | ---------------- | -------- | ---------------------------------- |
|
|
4356
|
+
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
4357
|
+
* | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
|
|
4358
|
+
*
|
|
4359
|
+
* Only one of the parameters must be specified.
|
|
4360
|
+
*
|
|
4361
|
+
* </details>
|
|
4362
|
+
*
|
|
4363
|
+
* <details>
|
|
4364
|
+
* <summary><code>image_dimensions</code></summary>
|
|
4365
|
+
*
|
|
4366
|
+
* Accept assets only within a specified height/width range.
|
|
4367
|
+
*
|
|
4368
|
+
* | Parameter | Type | Required | Description |
|
|
4369
|
+
* | ------------------ | --------- | -------- | -------------------------------- |
|
|
4370
|
+
* | `width_min_value` | `Integer` | | Numeric value for minimum width |
|
|
4371
|
+
* | `width_max_value` | `Integer` | | Numeric value for maximum height |
|
|
4372
|
+
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
4373
|
+
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
4374
|
+
*
|
|
4375
|
+
* At least one parameter must be specified.
|
|
4376
|
+
*
|
|
4377
|
+
* </details>
|
|
4378
|
+
*
|
|
4379
|
+
* <details>
|
|
4380
|
+
* <summary><code>item_item_type</code></summary>
|
|
4381
|
+
*
|
|
4382
|
+
* Only accept references to records of the specified models.
|
|
4383
|
+
*
|
|
4384
|
+
* | Parameter | Type | Required | Description |
|
|
4385
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4386
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4387
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4388
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4389
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4390
|
+
*
|
|
4391
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4392
|
+
*
|
|
4393
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4394
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4395
|
+
*
|
|
4396
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4397
|
+
*
|
|
4398
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4399
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4400
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4401
|
+
*
|
|
4402
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4403
|
+
*
|
|
4404
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4405
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4406
|
+
* </details>
|
|
4407
|
+
*
|
|
4408
|
+
* <details>
|
|
4409
|
+
* <summary><code>items_item_type</code></summary>
|
|
4410
|
+
*
|
|
4411
|
+
* Only accept references to records of the specified models.
|
|
4412
|
+
*
|
|
4413
|
+
* | Parameter | Type | Required | Description |
|
|
4414
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4415
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4416
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4417
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4418
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4419
|
+
*
|
|
4420
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4421
|
+
*
|
|
4422
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4423
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4424
|
+
*
|
|
4425
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4426
|
+
*
|
|
4427
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4428
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4429
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4430
|
+
*
|
|
4431
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4432
|
+
*
|
|
4433
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4434
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4435
|
+
* </details>
|
|
4436
|
+
*
|
|
4437
|
+
* <details>
|
|
4438
|
+
* <summary><code>length</code></summary>
|
|
4439
|
+
*
|
|
4440
|
+
* Accept strings only with a specified number of characters.
|
|
4441
|
+
*
|
|
4442
|
+
* | Parameter | Type | Required | Description |
|
|
4443
|
+
* | --------- | --------- | -------- | --------------- |
|
|
4444
|
+
* | `min` | `Integer` | | Minimum length |
|
|
4445
|
+
* | `eq` | `Integer` | | Expected length |
|
|
4446
|
+
* | `max` | `Integer` | | Maximum length |
|
|
4447
|
+
*
|
|
4448
|
+
* At least one parameter must be specified.
|
|
4449
|
+
*
|
|
4450
|
+
* </details>
|
|
4451
|
+
*
|
|
4452
|
+
* <details>
|
|
4453
|
+
* <summary><code>number_range</code></summary>
|
|
4454
|
+
*
|
|
4455
|
+
* Accept numbers only inside a specified range.
|
|
4456
|
+
*
|
|
4457
|
+
* | Parameter | Type | Required | Description |
|
|
4458
|
+
* | --------- | ------- | -------- | ------------- |
|
|
4459
|
+
* | `min` | `Float` | | Minimum value |
|
|
4460
|
+
* | `max` | `Float` | | Maximum value |
|
|
4461
|
+
*
|
|
4462
|
+
* At least one of the parameters must be specified.
|
|
4463
|
+
*
|
|
4464
|
+
* </details>
|
|
4465
|
+
*
|
|
4466
|
+
* <details>
|
|
4467
|
+
* <summary><code>required</code></summary>
|
|
4468
|
+
*
|
|
4469
|
+
* Value must be specified or it won't be valid.
|
|
4470
|
+
*
|
|
4471
|
+
* </details>
|
|
4472
|
+
*
|
|
4473
|
+
* <details>
|
|
4474
|
+
* <summary><code>required_alt_title</code></summary>
|
|
4475
|
+
*
|
|
4476
|
+
* Assets contained in the field are required to specify custom title or alternate text, or they won't be valid.
|
|
4477
|
+
*
|
|
4478
|
+
* | Parameter | Type | Required | Description |
|
|
4479
|
+
* | --------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4480
|
+
* | `title` | `Boolean` | | Whether the title for the asset must be specified |
|
|
4481
|
+
* | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
|
|
4482
|
+
*
|
|
4483
|
+
* At least one of the parameters must be specified.
|
|
4484
|
+
*
|
|
4485
|
+
* </details>
|
|
4486
|
+
*
|
|
4487
|
+
* <details>
|
|
4488
|
+
* <summary><code>required_seo_fields</code></summary>
|
|
4489
|
+
*
|
|
4490
|
+
* SEO field is to specify one or more properties, or it won't be valid.
|
|
4491
|
+
*
|
|
4492
|
+
* | Parameter | Type | Required | Description |
|
|
4493
|
+
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
4494
|
+
* | `title` | `Boolean` | | Whether the meta title must be specified |
|
|
4495
|
+
* | `description` | `Boolean` | | Whether the meta description must be specified |
|
|
4496
|
+
* | `image` | `Boolean` | | Whether the social sharing image must be specified |
|
|
4497
|
+
* | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
|
|
4498
|
+
*
|
|
4499
|
+
* At least one of the parameters must be specified.
|
|
4500
|
+
*
|
|
4501
|
+
* </details>
|
|
4502
|
+
*
|
|
4503
|
+
* <details>
|
|
4504
|
+
* <summary><code>title_length</code></summary>
|
|
4505
|
+
*
|
|
4506
|
+
* Limits the length of the title for a SEO field. Search engines usually truncate title tags to 60 character so it is a good practice to keep the title around this length.
|
|
4507
|
+
*
|
|
4508
|
+
* | Parameter | Type | Required | Description |
|
|
4509
|
+
* | --------- | --------- | -------- | ------------- |
|
|
4510
|
+
* | `min` | `Integer` | | Minimum value |
|
|
4511
|
+
* | `max` | `Integer` | | Maximum value |
|
|
4512
|
+
*
|
|
4513
|
+
* At least one of the parameters must be specified.
|
|
4514
|
+
*
|
|
4515
|
+
* </details>
|
|
4516
|
+
*
|
|
4517
|
+
* <details>
|
|
4518
|
+
* <summary><code>description_length</code></summary>
|
|
4519
|
+
*
|
|
4520
|
+
* Limits the length of the description for a SEO field. Search engines usually truncate description tags to 160 character so it is a good practice to keep the description around this length.
|
|
4521
|
+
*
|
|
4522
|
+
* | Parameter | Type | Required | Description |
|
|
4523
|
+
* | --------- | --------- | -------- | ------------- |
|
|
4524
|
+
* | `min` | `Integer` | | Minimum value |
|
|
4525
|
+
* | `max` | `Integer` | | Maximum value |
|
|
4526
|
+
*
|
|
4527
|
+
* At least one of the parameters must be specified.
|
|
4528
|
+
*
|
|
4529
|
+
* </details>
|
|
4530
|
+
*
|
|
4531
|
+
* <details>
|
|
4532
|
+
* <summary><code>rich_text_blocks</code></summary>
|
|
4533
|
+
*
|
|
4534
|
+
* Only accept references to block records of the specified block models.
|
|
4535
|
+
*
|
|
4536
|
+
* | Parameter | Type | Required | Description |
|
|
4537
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4538
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4539
|
+
*
|
|
4540
|
+
* </details>
|
|
4541
|
+
*
|
|
4542
|
+
* <details>
|
|
4543
|
+
* <summary><code>structured_text_blocks</code></summary>
|
|
4544
|
+
*
|
|
4545
|
+
* Only accept references to block records of the specified block models.
|
|
4546
|
+
*
|
|
4547
|
+
* | Parameter | Type | Required | Description |
|
|
4548
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4549
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4550
|
+
*
|
|
4551
|
+
* </details>
|
|
4552
|
+
*
|
|
4553
|
+
* <details>
|
|
4554
|
+
* <summary><code>structured_text_links</code></summary>
|
|
4555
|
+
*
|
|
4556
|
+
* Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
|
|
4557
|
+
*
|
|
4558
|
+
* | Parameter | Type | Required | Description |
|
|
4559
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4560
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4561
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4562
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4563
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4564
|
+
*
|
|
4565
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4566
|
+
*
|
|
4567
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4568
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4569
|
+
*
|
|
4570
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4571
|
+
*
|
|
4572
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4573
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4574
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4575
|
+
*
|
|
4576
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4577
|
+
*
|
|
4578
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4579
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4580
|
+
* </details>
|
|
4581
|
+
*
|
|
4582
|
+
* <details>
|
|
4583
|
+
* <summary><code>size</code></summary>
|
|
4584
|
+
*
|
|
4585
|
+
* Only accept a number of items within the specified range.
|
|
4586
|
+
*
|
|
4587
|
+
* | Parameter | Type | Required | Description |
|
|
4588
|
+
* | ------------- | --------- | -------- | -------------------------------------------------- |
|
|
4589
|
+
* | `min` | `Integer` | | Minimum length |
|
|
4590
|
+
* | `eq` | `Integer` | | Expected length |
|
|
4591
|
+
* | `max` | `Integer` | | Maximum length |
|
|
4592
|
+
* | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
|
|
4593
|
+
*
|
|
4594
|
+
* At least one parameter must be specified.
|
|
4595
|
+
*
|
|
4596
|
+
* </details>
|
|
4597
|
+
*
|
|
4598
|
+
* <details>
|
|
4599
|
+
* <summary><code>slug_title_field</code></summary>
|
|
4600
|
+
*
|
|
4601
|
+
* Specifies the ID of the _Single-line string_ field that will be used to generate the slug
|
|
4602
|
+
*
|
|
4603
|
+
* | Parameter | Type | Required | Description |
|
|
4604
|
+
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4605
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
4606
|
+
*
|
|
4607
|
+
* </details>
|
|
4608
|
+
*
|
|
4609
|
+
* <details>
|
|
4610
|
+
* <summary><code>unique</code></summary>
|
|
4611
|
+
*
|
|
4612
|
+
* The value must be unique across the whole collection of records.
|
|
4613
|
+
*
|
|
4614
|
+
* </details>
|
|
4615
|
+
*
|
|
4616
|
+
* ### Configuration parameters for DatoCMS built-in field editors
|
|
4617
|
+
*
|
|
4618
|
+
* If a field editor is not specified in this table, just pass an empty object `{}` as its configuration parameters.
|
|
4619
|
+
*
|
|
4620
|
+
* <details>
|
|
4621
|
+
* <summary><code>boolean_radio_group</code></summary>
|
|
4622
|
+
*
|
|
4623
|
+
* Radio group input for _boolean_ fields.
|
|
4624
|
+
*
|
|
4625
|
+
* | Parameter | Type | Required | Description |
|
|
4626
|
+
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4627
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
4628
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
4629
|
+
*
|
|
4630
|
+
* </details>
|
|
4631
|
+
*
|
|
4632
|
+
* <details>
|
|
4633
|
+
* <summary><code>string_radio_group</code></summary>
|
|
4634
|
+
*
|
|
4635
|
+
* Radio group input for _string_ fields.
|
|
4636
|
+
*
|
|
4637
|
+
* | Parameter | Type | Required | Description |
|
|
4638
|
+
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4639
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
4640
|
+
*
|
|
4641
|
+
* </details>
|
|
4642
|
+
*
|
|
4643
|
+
* <details>
|
|
4644
|
+
* <summary><code>string_select</code></summary>
|
|
4645
|
+
*
|
|
4646
|
+
* Select input for _string_ fields.
|
|
4647
|
+
*
|
|
4648
|
+
* | Parameter | Type | Required | Description |
|
|
4649
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4650
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4651
|
+
*
|
|
4652
|
+
* </details>
|
|
4653
|
+
*
|
|
4654
|
+
* <details>
|
|
4655
|
+
* <summary><code>string_multi_select</code></summary>
|
|
4656
|
+
*
|
|
4657
|
+
* Select input for _JSON_ fields, to edit an array of strings.
|
|
4658
|
+
*
|
|
4659
|
+
* | Parameter | Type | Required | Description |
|
|
4660
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4661
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4662
|
+
*
|
|
4663
|
+
* </details>
|
|
4664
|
+
*
|
|
4665
|
+
* <details>
|
|
4666
|
+
* <summary><code>string_checkbox_group</code></summary>
|
|
4667
|
+
*
|
|
4668
|
+
* Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
|
|
4669
|
+
*
|
|
4670
|
+
* | Parameter | Type | Required | Description |
|
|
4671
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4672
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4673
|
+
*
|
|
4674
|
+
* </details>
|
|
4675
|
+
*
|
|
4676
|
+
* <details>
|
|
4677
|
+
* <summary><code>single_line</code></summary>
|
|
4678
|
+
*
|
|
4679
|
+
* Simple textual input for _Single-line string_ fields.
|
|
4680
|
+
*
|
|
4681
|
+
* | Parameter | Type | Required | Description |
|
|
4682
|
+
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4683
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
4684
|
+
*
|
|
4685
|
+
* </details>
|
|
4686
|
+
*
|
|
4687
|
+
* <details>
|
|
4688
|
+
* <summary><code>markdown</code></summary>
|
|
4689
|
+
*
|
|
4690
|
+
* Markdown editor for _Multiple-paragraph text_ fields.
|
|
4691
|
+
*
|
|
4692
|
+
* | Parameter | Type | Required | Description |
|
|
4693
|
+
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4694
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
|
|
4695
|
+
*
|
|
4696
|
+
* </details>
|
|
4697
|
+
*
|
|
4698
|
+
* <details>
|
|
4699
|
+
* <summary><code>wysiwyg</code></summary>
|
|
4700
|
+
*
|
|
4701
|
+
* HTML editor for _Multiple-paragraph text_ fields.
|
|
4702
|
+
*
|
|
4703
|
+
* | Parameter | Type | Required | Description |
|
|
4704
|
+
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4705
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
|
|
4706
|
+
*
|
|
4707
|
+
* </details>
|
|
4708
|
+
*
|
|
4709
|
+
* <details>
|
|
4710
|
+
* <summary><code>textarea</code></summary>
|
|
4711
|
+
*
|
|
4712
|
+
* Basic textarea editor for _Multiple-paragraph text_ fields.
|
|
4713
|
+
*
|
|
4714
|
+
* </details>
|
|
4715
|
+
*
|
|
4716
|
+
* <details>
|
|
4717
|
+
* <summary><code>color_picker</code></summary>
|
|
4718
|
+
*
|
|
4719
|
+
* Built-in editor for _Color_ fields.
|
|
4720
|
+
*
|
|
4721
|
+
* | Parameter | Type | Required | Description |
|
|
4722
|
+
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4723
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
4724
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
4725
|
+
*
|
|
4726
|
+
* </details>
|
|
4727
|
+
*
|
|
4728
|
+
* <details>
|
|
4729
|
+
* <summary><code>slug</code></summary>
|
|
4730
|
+
*
|
|
4731
|
+
* Built-in editor for _Slug_ fields.
|
|
4732
|
+
*
|
|
4733
|
+
* | Parameter | Type | Required | Description |
|
|
4734
|
+
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
4735
|
+
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |
|
|
4736
|
+
*
|
|
4737
|
+
* </details>
|
|
4738
|
+
*
|
|
4739
|
+
* <details>
|
|
4740
|
+
* <summary><code>rich_text</code></summary>
|
|
4741
|
+
*
|
|
4742
|
+
* Built-in editor for _Modular content_ fields.
|
|
4743
|
+
*
|
|
4744
|
+
* | Parameter | Type | Required | Description |
|
|
4745
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4746
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |
|
|
4747
|
+
*
|
|
4748
|
+
* </details>
|
|
4749
|
+
*
|
|
4750
|
+
* <details>
|
|
4751
|
+
* <summary><code>structured_text</code></summary>
|
|
4752
|
+
*
|
|
4753
|
+
* Built-in editor for _Structured text_ fields.
|
|
4754
|
+
*
|
|
4755
|
+
* | Parameter | Type | Required | Description |
|
|
4756
|
+
* | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4757
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
4758
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
4759
|
+
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
4760
|
+
* | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
|
|
4761
|
+
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|
|
4762
|
+
*
|
|
4763
|
+
* </details>
|
|
4764
|
+
*
|
|
4765
|
+
* <details>
|
|
4766
|
+
* <summary><code>link_select</code> and <code>links_select</code></summary>
|
|
4767
|
+
*
|
|
4768
|
+
* Use a select input with auto-completion to pick the records to reference inside the field.
|
|
4769
|
+
*
|
|
4770
|
+
* </details>
|
|
4771
|
+
*
|
|
4772
|
+
* <details>
|
|
4773
|
+
* <summary><code>link_embed</code> and <code>links_embed</code></summary>
|
|
4774
|
+
*
|
|
4775
|
+
* Use an expanded view with records' image preview to pick the records to reference inside the field.
|
|
4776
|
+
*
|
|
4777
|
+
* </details>
|
|
4778
|
+
*
|
|
3697
4779
|
*
|
|
3698
4780
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3699
4781
|
* via the `definition` "field".
|
|
@@ -3823,17 +4905,6 @@ export type FieldRelationships = {
|
|
|
3823
4905
|
};
|
|
3824
4906
|
};
|
|
3825
4907
|
|
|
3826
|
-
/**
|
|
3827
|
-
* JSON API data
|
|
3828
|
-
*
|
|
3829
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
3830
|
-
* via the `definition` "data".
|
|
3831
|
-
*/
|
|
3832
|
-
export type FieldsetData = {
|
|
3833
|
-
type: FieldsetType;
|
|
3834
|
-
id: FieldsetIdentity;
|
|
3835
|
-
};
|
|
3836
|
-
|
|
3837
4908
|
/**
|
|
3838
4909
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
3839
4910
|
* via the `create.schema` link.
|
|
@@ -4402,196 +5473,6 @@ export type SessionCreateTargetSchema = {
|
|
|
4402
5473
|
included: User[];
|
|
4403
5474
|
};
|
|
4404
5475
|
|
|
4405
|
-
/**
|
|
4406
|
-
* An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
|
|
4407
|
-
*
|
|
4408
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4409
|
-
* via the `definition` "access_token".
|
|
4410
|
-
*/
|
|
4411
|
-
export type AccessToken = {
|
|
4412
|
-
type: AccessTokenType;
|
|
4413
|
-
id: AccessTokenIdentity;
|
|
4414
|
-
attributes: AccessTokenAttributes;
|
|
4415
|
-
relationships: AccessTokenRelationships;
|
|
4416
|
-
};
|
|
4417
|
-
|
|
4418
|
-
/**
|
|
4419
|
-
* JSON API attributes
|
|
4420
|
-
*
|
|
4421
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4422
|
-
* via the `definition` "attributes".
|
|
4423
|
-
*/
|
|
4424
|
-
export type AccessTokenAttributes = {
|
|
4425
|
-
/**
|
|
4426
|
-
* Name of API token
|
|
4427
|
-
*/
|
|
4428
|
-
name: string;
|
|
4429
|
-
/**
|
|
4430
|
-
* The actual API token
|
|
4431
|
-
*/
|
|
4432
|
-
token?: string;
|
|
4433
|
-
/**
|
|
4434
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4435
|
-
*/
|
|
4436
|
-
can_access_cda: boolean;
|
|
4437
|
-
/**
|
|
4438
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4439
|
-
*/
|
|
4440
|
-
can_access_cda_preview: boolean;
|
|
4441
|
-
/**
|
|
4442
|
-
* Whether this API token can access the Content Management API
|
|
4443
|
-
*/
|
|
4444
|
-
can_access_cma: boolean;
|
|
4445
|
-
hardcoded_type: null | string;
|
|
4446
|
-
};
|
|
4447
|
-
|
|
4448
|
-
/**
|
|
4449
|
-
* JSON API links
|
|
4450
|
-
*
|
|
4451
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4452
|
-
* via the `definition` "relationships".
|
|
4453
|
-
*/
|
|
4454
|
-
export type AccessTokenRelationships = {
|
|
4455
|
-
/**
|
|
4456
|
-
* Role
|
|
4457
|
-
*/
|
|
4458
|
-
role: {
|
|
4459
|
-
data: RoleData | null;
|
|
4460
|
-
};
|
|
4461
|
-
};
|
|
4462
|
-
|
|
4463
|
-
/**
|
|
4464
|
-
* JSON API data
|
|
4465
|
-
*
|
|
4466
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4467
|
-
* via the `definition` "data".
|
|
4468
|
-
*/
|
|
4469
|
-
export type AccessTokenData = {
|
|
4470
|
-
type: AccessTokenType;
|
|
4471
|
-
id: AccessTokenIdentity;
|
|
4472
|
-
};
|
|
4473
|
-
|
|
4474
|
-
/**
|
|
4475
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4476
|
-
* via the `create.schema` link.
|
|
4477
|
-
*/
|
|
4478
|
-
export type AccessTokenCreateSchema = {
|
|
4479
|
-
data: {
|
|
4480
|
-
type: AccessTokenType;
|
|
4481
|
-
attributes: {
|
|
4482
|
-
/**
|
|
4483
|
-
* Name of API token
|
|
4484
|
-
*/
|
|
4485
|
-
name: string;
|
|
4486
|
-
/**
|
|
4487
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4488
|
-
*/
|
|
4489
|
-
can_access_cda: boolean;
|
|
4490
|
-
/**
|
|
4491
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4492
|
-
*/
|
|
4493
|
-
can_access_cda_preview: boolean;
|
|
4494
|
-
/**
|
|
4495
|
-
* Whether this API token can access the Content Management API
|
|
4496
|
-
*/
|
|
4497
|
-
can_access_cma: boolean;
|
|
4498
|
-
};
|
|
4499
|
-
relationships: {
|
|
4500
|
-
/**
|
|
4501
|
-
* Role
|
|
4502
|
-
*/
|
|
4503
|
-
role: {
|
|
4504
|
-
data: RoleData | null;
|
|
4505
|
-
};
|
|
4506
|
-
};
|
|
4507
|
-
};
|
|
4508
|
-
};
|
|
4509
|
-
|
|
4510
|
-
/**
|
|
4511
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4512
|
-
* via the `create.targetSchema` link.
|
|
4513
|
-
*/
|
|
4514
|
-
export type AccessTokenCreateTargetSchema = {
|
|
4515
|
-
data: AccessToken;
|
|
4516
|
-
};
|
|
4517
|
-
|
|
4518
|
-
/**
|
|
4519
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4520
|
-
* via the `update.schema` link.
|
|
4521
|
-
*/
|
|
4522
|
-
export type AccessTokenUpdateSchema = {
|
|
4523
|
-
data: {
|
|
4524
|
-
type: AccessTokenType;
|
|
4525
|
-
id: AccessTokenIdentity;
|
|
4526
|
-
attributes: {
|
|
4527
|
-
/**
|
|
4528
|
-
* Name of API token
|
|
4529
|
-
*/
|
|
4530
|
-
name: string;
|
|
4531
|
-
/**
|
|
4532
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4533
|
-
*/
|
|
4534
|
-
can_access_cda: boolean;
|
|
4535
|
-
/**
|
|
4536
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4537
|
-
*/
|
|
4538
|
-
can_access_cda_preview: boolean;
|
|
4539
|
-
/**
|
|
4540
|
-
* Whether this API token can access the Content Management API
|
|
4541
|
-
*/
|
|
4542
|
-
can_access_cma: boolean;
|
|
4543
|
-
};
|
|
4544
|
-
relationships: {
|
|
4545
|
-
/**
|
|
4546
|
-
* Role
|
|
4547
|
-
*/
|
|
4548
|
-
role: {
|
|
4549
|
-
data: RoleData | null;
|
|
4550
|
-
};
|
|
4551
|
-
};
|
|
4552
|
-
};
|
|
4553
|
-
};
|
|
4554
|
-
|
|
4555
|
-
/**
|
|
4556
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4557
|
-
* via the `update.targetSchema` link.
|
|
4558
|
-
*/
|
|
4559
|
-
export type AccessTokenUpdateTargetSchema = {
|
|
4560
|
-
data: AccessToken;
|
|
4561
|
-
};
|
|
4562
|
-
|
|
4563
|
-
/**
|
|
4564
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4565
|
-
* via the `instances.targetSchema` link.
|
|
4566
|
-
*/
|
|
4567
|
-
export type AccessTokenInstancesTargetSchema = {
|
|
4568
|
-
data: AccessToken[];
|
|
4569
|
-
};
|
|
4570
|
-
|
|
4571
|
-
/**
|
|
4572
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4573
|
-
* via the `self.targetSchema` link.
|
|
4574
|
-
*/
|
|
4575
|
-
export type AccessTokenSelfTargetSchema = {
|
|
4576
|
-
data: AccessToken;
|
|
4577
|
-
};
|
|
4578
|
-
|
|
4579
|
-
/**
|
|
4580
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4581
|
-
* via the `regenerate_token.targetSchema` link.
|
|
4582
|
-
*/
|
|
4583
|
-
export type AccessTokenRegenerateTokenTargetSchema = {
|
|
4584
|
-
data: AccessToken;
|
|
4585
|
-
};
|
|
4586
|
-
|
|
4587
|
-
/**
|
|
4588
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4589
|
-
* via the `destroy.targetSchema` link.
|
|
4590
|
-
*/
|
|
4591
|
-
export type AccessTokenDestroyTargetSchema = {
|
|
4592
|
-
data: AccessToken;
|
|
4593
|
-
};
|
|
4594
|
-
|
|
4595
5476
|
/**
|
|
4596
5477
|
* Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
|
|
4597
5478
|
*
|
|
@@ -6761,6 +7642,10 @@ export type EnvironmentMeta = {
|
|
|
6761
7642
|
* Is this environment the primary for the project?
|
|
6762
7643
|
*/
|
|
6763
7644
|
primary: boolean;
|
|
7645
|
+
/**
|
|
7646
|
+
* ID of the environment that's been forked to generate this one
|
|
7647
|
+
*/
|
|
7648
|
+
forked_from?: string | null;
|
|
6764
7649
|
};
|
|
6765
7650
|
|
|
6766
7651
|
/**
|
|
@@ -8675,6 +9560,7 @@ export type Site = {
|
|
|
8675
9560
|
id: SiteIdentity;
|
|
8676
9561
|
attributes: SiteAttributes;
|
|
8677
9562
|
relationships: SiteRelationships;
|
|
9563
|
+
meta: SiteMeta;
|
|
8678
9564
|
};
|
|
8679
9565
|
|
|
8680
9566
|
/**
|
|
@@ -8865,6 +9751,19 @@ export type SiteRelationships = {
|
|
|
8865
9751
|
};
|
|
8866
9752
|
};
|
|
8867
9753
|
|
|
9754
|
+
/**
|
|
9755
|
+
* Meta attributes
|
|
9756
|
+
*
|
|
9757
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
9758
|
+
* via the `definition` "meta".
|
|
9759
|
+
*/
|
|
9760
|
+
export type SiteMeta = {
|
|
9761
|
+
/**
|
|
9762
|
+
* Whether the Improved API Timezone Management option is active or not
|
|
9763
|
+
*/
|
|
9764
|
+
improved_timezone_management: boolean;
|
|
9765
|
+
};
|
|
9766
|
+
|
|
8868
9767
|
/**
|
|
8869
9768
|
* JSON API data
|
|
8870
9769
|
*
|
|
@@ -8882,7 +9781,18 @@ export type SiteData = {
|
|
|
8882
9781
|
*/
|
|
8883
9782
|
export type SiteSelfTargetSchema = {
|
|
8884
9783
|
data: Site;
|
|
8885
|
-
included?: (
|
|
9784
|
+
included?: (
|
|
9785
|
+
| MenuItem
|
|
9786
|
+
| User
|
|
9787
|
+
| ItemType
|
|
9788
|
+
| Role
|
|
9789
|
+
| Field
|
|
9790
|
+
| Upload
|
|
9791
|
+
| SsoUser
|
|
9792
|
+
| Fieldset
|
|
9793
|
+
| Item
|
|
9794
|
+
| Account
|
|
9795
|
+
)[];
|
|
8886
9796
|
};
|
|
8887
9797
|
|
|
8888
9798
|
/**
|
|
@@ -8996,6 +9906,12 @@ export type SiteUpdateSchema = {
|
|
|
8996
9906
|
*/
|
|
8997
9907
|
ip_tracking_enabled?: boolean;
|
|
8998
9908
|
};
|
|
9909
|
+
meta?: {
|
|
9910
|
+
/**
|
|
9911
|
+
* Whether the Improved API Timezone Management option is active or not
|
|
9912
|
+
*/
|
|
9913
|
+
improved_timezone_management?: boolean;
|
|
9914
|
+
};
|
|
8999
9915
|
relationships?: {
|
|
9000
9916
|
sso_default_role?: {
|
|
9001
9917
|
data: RoleData;
|
|
@@ -9020,6 +9936,22 @@ export type SiteUpdateJobSchema = {
|
|
|
9020
9936
|
data: Site;
|
|
9021
9937
|
};
|
|
9022
9938
|
|
|
9939
|
+
/**
|
|
9940
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
9941
|
+
* via the `activate_improved_timezone_management.targetSchema` link.
|
|
9942
|
+
*/
|
|
9943
|
+
export type SiteActivateImprovedTimezoneManagementTargetSchema = {
|
|
9944
|
+
data: Job;
|
|
9945
|
+
};
|
|
9946
|
+
|
|
9947
|
+
/**
|
|
9948
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
9949
|
+
* via the `activate_improved_timezone_management.jobSchema` link.
|
|
9950
|
+
*/
|
|
9951
|
+
export type SiteActivateImprovedTimezoneManagementJobSchema = {
|
|
9952
|
+
data: Site;
|
|
9953
|
+
};
|
|
9954
|
+
|
|
9023
9955
|
/**
|
|
9024
9956
|
* Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
|
|
9025
9957
|
*
|