@datocms/cma-client 1.1.4 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. package/dist/cjs/generated/resources/ItemType.js +4 -3
  2. package/dist/cjs/generated/resources/ItemType.js.map +1 -1
  3. package/dist/cjs/generated/resources/Upload.js +4 -4
  4. package/dist/cjs/generated/resources/Upload.js.map +1 -1
  5. package/dist/esm/generated/SchemaTypes.d.ts +11 -0
  6. package/dist/esm/generated/SimpleSchemaTypes.d.ts +11 -0
  7. package/dist/esm/generated/resources/ItemType.d.ts +2 -2
  8. package/dist/esm/generated/resources/ItemType.js +4 -3
  9. package/dist/esm/generated/resources/ItemType.js.map +1 -1
  10. package/dist/esm/generated/resources/Upload.d.ts +2 -2
  11. package/dist/esm/generated/resources/Upload.js +4 -4
  12. package/dist/esm/generated/resources/Upload.js.map +1 -1
  13. package/dist/types/generated/SchemaTypes.d.ts +11 -0
  14. package/dist/types/generated/SimpleSchemaTypes.d.ts +11 -0
  15. package/dist/types/generated/resources/ItemType.d.ts +2 -2
  16. package/dist/types/generated/resources/Upload.d.ts +2 -2
  17. package/package.json +3 -3
  18. package/resources.json +2278 -161
  19. package/src/generated/SchemaTypes.ts +11 -0
  20. package/src/generated/SimpleSchemaTypes.ts +11 -0
  21. package/src/generated/resources/ItemType.ts +7 -1
  22. package/src/generated/resources/Upload.ts +3 -3
package/resources.json CHANGED
@@ -3,32 +3,145 @@
3
3
  "jsonApiType": "role",
4
4
  "endpoints": [
5
5
  {
6
- "rel": "create",
7
6
  "returnsCollection": false,
7
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/create",
8
+ "rel": "create",
9
+ "urlTemplate": "/roles",
10
+ "method": "POST",
11
+ "comment": "Create a new role",
12
+ "requestBodyType": "RoleCreateSchema",
13
+ "requestStructure": {
14
+ "type": "role",
15
+ "attributes": [
16
+ "name",
17
+ "can_edit_favicon",
18
+ "can_edit_site",
19
+ "can_edit_schema",
20
+ "can_manage_menu",
21
+ "can_edit_environment",
22
+ "can_promote_environments",
23
+ "environments_access",
24
+ "can_manage_users",
25
+ "can_manage_shared_filters",
26
+ "can_manage_build_triggers",
27
+ "can_manage_webhooks",
28
+ "can_manage_environments",
29
+ "can_manage_sso",
30
+ "can_access_audit_log",
31
+ "can_manage_workflows",
32
+ "can_manage_access_tokens",
33
+ "can_perform_site_search",
34
+ "can_access_build_events_log",
35
+ "positive_item_type_permissions",
36
+ "negative_item_type_permissions",
37
+ "positive_upload_permissions",
38
+ "negative_upload_permissions",
39
+ "positive_build_trigger_permissions",
40
+ "negative_build_trigger_permissions"
41
+ ],
42
+ "relationships": [
43
+ "inherits_permissions_from"
44
+ ]
45
+ },
46
+ "queryParamsRequired": false,
47
+ "responseType": "RoleCreateTargetSchema",
8
48
  "name": "create",
9
49
  "rawName": "rawCreate"
10
50
  },
11
51
  {
12
- "rel": "update",
13
52
  "returnsCollection": false,
53
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/update",
54
+ "rel": "update",
55
+ "urlTemplate": "/roles/${roleId}",
56
+ "method": "PUT",
57
+ "comment": "Update a role",
58
+ "urlPlaceholder": {
59
+ "variableName": "roleId",
60
+ "isEntityId": true,
61
+ "relType": "RoleData"
62
+ },
63
+ "requestBodyType": "RoleUpdateSchema",
64
+ "requestStructure": {
65
+ "type": "role",
66
+ "attributes": [
67
+ "name",
68
+ "can_edit_favicon",
69
+ "can_edit_site",
70
+ "can_edit_schema",
71
+ "can_manage_menu",
72
+ "can_edit_environment",
73
+ "can_promote_environments",
74
+ "environments_access",
75
+ "can_manage_users",
76
+ "can_manage_shared_filters",
77
+ "can_manage_build_triggers",
78
+ "can_manage_webhooks",
79
+ "can_manage_environments",
80
+ "can_manage_sso",
81
+ "can_access_audit_log",
82
+ "can_manage_workflows",
83
+ "can_manage_access_tokens",
84
+ "can_perform_site_search",
85
+ "can_access_build_events_log",
86
+ "positive_item_type_permissions",
87
+ "negative_item_type_permissions",
88
+ "positive_upload_permissions",
89
+ "negative_upload_permissions",
90
+ "positive_build_trigger_permissions",
91
+ "negative_build_trigger_permissions"
92
+ ],
93
+ "relationships": [
94
+ "inherits_permissions_from"
95
+ ]
96
+ },
97
+ "queryParamsRequired": false,
98
+ "responseType": "RoleUpdateTargetSchema",
14
99
  "name": "update",
15
100
  "rawName": "rawUpdate"
16
101
  },
17
102
  {
18
- "rel": "instances",
19
103
  "returnsCollection": true,
104
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/instances",
105
+ "rel": "instances",
106
+ "urlTemplate": "/roles",
107
+ "method": "GET",
108
+ "comment": "List all roles",
109
+ "queryParamsRequired": false,
110
+ "responseType": "RoleInstancesTargetSchema",
20
111
  "name": "list",
21
112
  "rawName": "rawList"
22
113
  },
23
114
  {
24
- "rel": "self",
25
115
  "returnsCollection": false,
116
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/self",
117
+ "rel": "self",
118
+ "urlTemplate": "/roles/${roleId}",
119
+ "method": "GET",
120
+ "comment": "Retrieve a role",
121
+ "urlPlaceholder": {
122
+ "variableName": "roleId",
123
+ "isEntityId": true,
124
+ "relType": "RoleData"
125
+ },
126
+ "queryParamsRequired": false,
127
+ "responseType": "RoleSelfTargetSchema",
26
128
  "name": "find",
27
129
  "rawName": "rawFind"
28
130
  },
29
131
  {
30
- "rel": "destroy",
31
132
  "returnsCollection": false,
133
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/destroy",
134
+ "rel": "destroy",
135
+ "urlTemplate": "/roles/${roleId}",
136
+ "method": "DELETE",
137
+ "comment": "Delete a role",
138
+ "urlPlaceholder": {
139
+ "variableName": "roleId",
140
+ "isEntityId": true,
141
+ "relType": "RoleData"
142
+ },
143
+ "queryParamsRequired": false,
144
+ "responseType": "RoleDestroyTargetSchema",
32
145
  "name": "destroy",
33
146
  "rawName": "rawDestroy"
34
147
  }
@@ -40,32 +153,90 @@
40
153
  "jsonApiType": "user",
41
154
  "endpoints": [
42
155
  {
43
- "rel": "update",
44
156
  "returnsCollection": false,
157
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/update",
158
+ "rel": "update",
159
+ "urlTemplate": "/users/${userId}",
160
+ "method": "PUT",
161
+ "comment": "Update a collaborator",
162
+ "urlPlaceholder": {
163
+ "variableName": "userId",
164
+ "isEntityId": true,
165
+ "relType": "UserData"
166
+ },
167
+ "requestBodyType": "UserUpdateSchema",
168
+ "requestStructure": {
169
+ "type": "user",
170
+ "attributes": [
171
+ "is_active"
172
+ ],
173
+ "relationships": [
174
+ "role"
175
+ ]
176
+ },
177
+ "queryParamsRequired": false,
178
+ "responseType": "UserUpdateTargetSchema",
45
179
  "name": "update",
46
180
  "rawName": "rawUpdate"
47
181
  },
48
182
  {
49
- "rel": "instances",
50
183
  "returnsCollection": true,
184
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/instances",
185
+ "rel": "instances",
186
+ "urlTemplate": "/users",
187
+ "method": "GET",
188
+ "comment": "List all collaborators",
189
+ "queryParamsRequired": false,
190
+ "responseType": "UserInstancesTargetSchema",
51
191
  "name": "list",
52
192
  "rawName": "rawList"
53
193
  },
54
194
  {
55
- "rel": "self",
56
195
  "returnsCollection": false,
196
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/self",
197
+ "rel": "self",
198
+ "urlTemplate": "/users/${userId}",
199
+ "method": "GET",
200
+ "comment": "Retrieve a collaborator",
201
+ "urlPlaceholder": {
202
+ "variableName": "userId",
203
+ "isEntityId": true,
204
+ "relType": "UserData"
205
+ },
206
+ "queryParamsType": "UserSelfHrefSchema",
207
+ "queryParamsRequired": false,
208
+ "responseType": "UserSelfTargetSchema",
57
209
  "name": "find",
58
210
  "rawName": "rawFind"
59
211
  },
60
212
  {
61
- "rel": "me",
62
213
  "returnsCollection": false,
214
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/me",
215
+ "rel": "me",
216
+ "urlTemplate": "/users/me",
217
+ "method": "GET",
218
+ "comment": "Retrieve current signed-in user",
219
+ "queryParamsType": "UserMeHrefSchema",
220
+ "queryParamsRequired": false,
221
+ "responseType": "UserMeTargetSchema",
63
222
  "name": "findMe",
64
223
  "rawName": "rawFindMe"
65
224
  },
66
225
  {
67
- "rel": "destroy",
68
226
  "returnsCollection": false,
227
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/destroy",
228
+ "rel": "destroy",
229
+ "urlTemplate": "/users/${userId}",
230
+ "method": "DELETE",
231
+ "comment": "Delete a collaborator",
232
+ "urlPlaceholder": {
233
+ "variableName": "userId",
234
+ "isEntityId": true,
235
+ "relType": "UserData"
236
+ },
237
+ "queryParamsType": "UserDestroyHrefSchema",
238
+ "queryParamsRequired": false,
239
+ "responseType": "UserDestroyTargetSchema",
69
240
  "name": "destroy",
70
241
  "rawName": "rawDestroy"
71
242
  }
@@ -77,26 +248,61 @@
77
248
  "jsonApiType": "sso_user",
78
249
  "endpoints": [
79
250
  {
80
- "rel": "instances",
81
251
  "returnsCollection": true,
252
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/instances",
253
+ "rel": "instances",
254
+ "urlTemplate": "/sso-users",
255
+ "method": "GET",
256
+ "comment": "List all users",
257
+ "queryParamsRequired": false,
258
+ "responseType": "SsoUserInstancesTargetSchema",
82
259
  "name": "list",
83
260
  "rawName": "rawList"
84
261
  },
85
262
  {
86
- "rel": "self",
87
263
  "returnsCollection": false,
264
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/self",
265
+ "rel": "self",
266
+ "urlTemplate": "/sso-users/${userId}",
267
+ "method": "GET",
268
+ "comment": "Returns a SSO user",
269
+ "urlPlaceholder": {
270
+ "variableName": "userId",
271
+ "isEntityId": false,
272
+ "relType": "UserData"
273
+ },
274
+ "queryParamsRequired": false,
275
+ "responseType": "SsoUserSelfTargetSchema",
88
276
  "name": "find",
89
277
  "rawName": "rawFind"
90
278
  },
91
279
  {
92
- "rel": "copy_users",
93
280
  "returnsCollection": false,
281
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users",
282
+ "rel": "copy_users",
283
+ "urlTemplate": "/sso-users/copy-users",
284
+ "method": "POST",
285
+ "comment": "Copy editors as SSO users",
286
+ "queryParamsRequired": false,
287
+ "responseType": "SsoUserCopyUsersTargetSchema",
94
288
  "name": "copyUsers",
95
289
  "rawName": "rawCopyUsers"
96
290
  },
97
291
  {
98
- "rel": "destroy",
99
292
  "returnsCollection": false,
293
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy",
294
+ "rel": "destroy",
295
+ "urlTemplate": "/sso-users/${userId}",
296
+ "method": "DELETE",
297
+ "comment": "Delete a SSO user",
298
+ "urlPlaceholder": {
299
+ "variableName": "userId",
300
+ "isEntityId": false,
301
+ "relType": "UserData"
302
+ },
303
+ "queryParamsType": "SsoUserDestroyHrefSchema",
304
+ "queryParamsRequired": false,
305
+ "responseType": "SsoUserDestroyTargetSchema",
100
306
  "name": "destroy",
101
307
  "rawName": "rawDestroy"
102
308
  }
@@ -108,8 +314,24 @@
108
314
  "jsonApiType": "audit_log_event",
109
315
  "endpoints": [
110
316
  {
111
- "rel": "query",
112
317
  "returnsCollection": true,
318
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query",
319
+ "rel": "query",
320
+ "urlTemplate": "/audit-log-events/query",
321
+ "method": "POST",
322
+ "comment": "List Audit Log events",
323
+ "requestBodyType": "AuditLogEventQuerySchema",
324
+ "requestStructure": {
325
+ "type": "audit_log_query",
326
+ "attributes": [
327
+ "filter",
328
+ "next_token",
329
+ "detailed_log"
330
+ ],
331
+ "relationships": []
332
+ },
333
+ "queryParamsRequired": false,
334
+ "responseType": "AuditLogEventQueryTargetSchema",
113
335
  "name": "query",
114
336
  "rawName": "rawQuery"
115
337
  }
@@ -121,32 +343,108 @@
121
343
  "jsonApiType": "menu_item",
122
344
  "endpoints": [
123
345
  {
124
- "rel": "create",
125
346
  "returnsCollection": false,
347
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/create",
348
+ "rel": "create",
349
+ "urlTemplate": "/menu-items",
350
+ "method": "POST",
351
+ "comment": "Create a new menu item",
352
+ "requestBodyType": "MenuItemCreateSchema",
353
+ "requestStructure": {
354
+ "type": "menu_item",
355
+ "attributes": [
356
+ "label",
357
+ "external_url",
358
+ "position",
359
+ "open_in_new_tab"
360
+ ],
361
+ "relationships": [
362
+ "item_type",
363
+ "item_type_filter",
364
+ "parent"
365
+ ]
366
+ },
367
+ "queryParamsRequired": false,
368
+ "responseType": "MenuItemCreateTargetSchema",
126
369
  "name": "create",
127
370
  "rawName": "rawCreate"
128
371
  },
129
372
  {
130
- "rel": "update",
131
373
  "returnsCollection": false,
374
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/update",
375
+ "rel": "update",
376
+ "urlTemplate": "/menu-items/${menuItemId}",
377
+ "method": "PUT",
378
+ "comment": "Update a menu item",
379
+ "urlPlaceholder": {
380
+ "variableName": "menuItemId",
381
+ "isEntityId": true,
382
+ "relType": "MenuItemData"
383
+ },
384
+ "requestBodyType": "MenuItemUpdateSchema",
385
+ "requestStructure": {
386
+ "type": "menu_item",
387
+ "attributes": [
388
+ "label",
389
+ "external_url",
390
+ "position",
391
+ "open_in_new_tab"
392
+ ],
393
+ "relationships": [
394
+ "item_type",
395
+ "item_type_filter",
396
+ "parent"
397
+ ]
398
+ },
399
+ "queryParamsRequired": false,
400
+ "responseType": "MenuItemUpdateTargetSchema",
132
401
  "name": "update",
133
402
  "rawName": "rawUpdate"
134
403
  },
135
404
  {
136
- "rel": "instances",
137
405
  "returnsCollection": true,
406
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/instances",
407
+ "rel": "instances",
408
+ "urlTemplate": "/menu-items",
409
+ "method": "GET",
410
+ "comment": "List all menu items",
411
+ "queryParamsType": "MenuItemInstancesHrefSchema",
412
+ "queryParamsRequired": false,
413
+ "responseType": "MenuItemInstancesTargetSchema",
138
414
  "name": "list",
139
415
  "rawName": "rawList"
140
416
  },
141
417
  {
142
- "rel": "self",
143
418
  "returnsCollection": false,
419
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/self",
420
+ "rel": "self",
421
+ "urlTemplate": "/menu-items/${menuItemId}",
422
+ "method": "GET",
423
+ "comment": "Retrieve a menu item",
424
+ "urlPlaceholder": {
425
+ "variableName": "menuItemId",
426
+ "isEntityId": true,
427
+ "relType": "MenuItemData"
428
+ },
429
+ "queryParamsRequired": false,
430
+ "responseType": "MenuItemSelfTargetSchema",
144
431
  "name": "find",
145
432
  "rawName": "rawFind"
146
433
  },
147
434
  {
148
- "rel": "destroy",
149
435
  "returnsCollection": false,
436
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy",
437
+ "rel": "destroy",
438
+ "urlTemplate": "/menu-items/${menuItemId}",
439
+ "method": "DELETE",
440
+ "comment": "Delete a menu item",
441
+ "urlPlaceholder": {
442
+ "variableName": "menuItemId",
443
+ "isEntityId": true,
444
+ "relType": "MenuItemData"
445
+ },
446
+ "queryParamsRequired": false,
447
+ "responseType": "MenuItemDestroyTargetSchema",
150
448
  "name": "destroy",
151
449
  "rawName": "rawDestroy"
152
450
  }
@@ -158,38 +456,148 @@
158
456
  "jsonApiType": "item_type",
159
457
  "endpoints": [
160
458
  {
161
- "rel": "create",
162
459
  "returnsCollection": false,
460
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/create",
461
+ "rel": "create",
462
+ "urlTemplate": "/item-types",
463
+ "method": "POST",
464
+ "comment": "Create a new model",
465
+ "requestBodyType": "ItemTypeCreateSchema",
466
+ "requestStructure": {
467
+ "type": "item_type",
468
+ "attributes": [
469
+ "name",
470
+ "api_key",
471
+ "singleton",
472
+ "all_locales_required",
473
+ "sortable",
474
+ "modular_block",
475
+ "draft_mode_active",
476
+ "tree",
477
+ "ordering_direction",
478
+ "ordering_meta",
479
+ "collection_appeareance",
480
+ "collection_appearance",
481
+ "hint"
482
+ ],
483
+ "relationships": [
484
+ "ordering_field",
485
+ "title_field",
486
+ "image_preview_field",
487
+ "excerpt_field",
488
+ "workflow"
489
+ ]
490
+ },
491
+ "queryParamsType": "ItemTypeCreateHrefSchema",
492
+ "queryParamsRequired": false,
493
+ "responseType": "ItemTypeCreateTargetSchema",
163
494
  "name": "create",
164
495
  "rawName": "rawCreate"
165
496
  },
166
497
  {
167
- "rel": "update",
168
498
  "returnsCollection": false,
499
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/update",
500
+ "rel": "update",
501
+ "urlTemplate": "/item-types/${itemTypeId}",
502
+ "method": "PUT",
503
+ "comment": "Update a model",
504
+ "urlPlaceholder": {
505
+ "variableName": "itemTypeId",
506
+ "isEntityId": true,
507
+ "relType": "ItemTypeData"
508
+ },
509
+ "requestBodyType": "ItemTypeUpdateSchema",
510
+ "requestStructure": {
511
+ "type": "item_type",
512
+ "attributes": [
513
+ "name",
514
+ "api_key",
515
+ "collection_appeareance",
516
+ "collection_appearance",
517
+ "singleton",
518
+ "all_locales_required",
519
+ "sortable",
520
+ "modular_block",
521
+ "draft_mode_active",
522
+ "tree",
523
+ "ordering_direction",
524
+ "ordering_meta",
525
+ "has_singleton_item",
526
+ "hint"
527
+ ],
528
+ "relationships": [
529
+ "ordering_field",
530
+ "title_field",
531
+ "image_preview_field",
532
+ "excerpt_field",
533
+ "workflow"
534
+ ]
535
+ },
536
+ "queryParamsRequired": false,
537
+ "responseType": "ItemTypeUpdateJobSchema",
169
538
  "name": "update",
170
539
  "rawName": "rawUpdate"
171
540
  },
172
541
  {
173
- "rel": "instances",
174
542
  "returnsCollection": true,
543
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/instances",
544
+ "rel": "instances",
545
+ "urlTemplate": "/item-types",
546
+ "method": "GET",
547
+ "comment": "List all models",
548
+ "queryParamsRequired": false,
549
+ "responseType": "ItemTypeInstancesTargetSchema",
175
550
  "name": "list",
176
551
  "rawName": "rawList"
177
552
  },
178
553
  {
179
- "rel": "self",
180
554
  "returnsCollection": false,
555
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/self",
556
+ "rel": "self",
557
+ "urlTemplate": "/item-types/${itemTypeId}",
558
+ "method": "GET",
559
+ "comment": "Retrieve a model",
560
+ "urlPlaceholder": {
561
+ "variableName": "itemTypeId",
562
+ "isEntityId": true,
563
+ "relType": "ItemTypeData"
564
+ },
565
+ "queryParamsRequired": false,
566
+ "responseType": "ItemTypeSelfTargetSchema",
181
567
  "name": "find",
182
568
  "rawName": "rawFind"
183
569
  },
184
570
  {
185
- "rel": "duplicate",
186
571
  "returnsCollection": false,
572
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate",
573
+ "rel": "duplicate",
574
+ "urlTemplate": "/item-types/${itemTypeId}/duplicate",
575
+ "method": "POST",
576
+ "comment": "Duplicate model",
577
+ "urlPlaceholder": {
578
+ "variableName": "itemTypeId",
579
+ "isEntityId": true,
580
+ "relType": "ItemTypeData"
581
+ },
582
+ "queryParamsRequired": false,
583
+ "responseType": "ItemTypeDuplicateTargetSchema",
187
584
  "name": "duplicate",
188
585
  "rawName": "rawDuplicate"
189
586
  },
190
587
  {
191
- "rel": "destroy",
192
588
  "returnsCollection": false,
589
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/destroy",
590
+ "rel": "destroy",
591
+ "urlTemplate": "/item-types/${itemTypeId}",
592
+ "method": "DELETE",
593
+ "comment": "Delete a model",
594
+ "urlPlaceholder": {
595
+ "variableName": "itemTypeId",
596
+ "isEntityId": true,
597
+ "relType": "ItemTypeData"
598
+ },
599
+ "queryParamsRequired": false,
600
+ "responseType": "ItemTypeDestroyJobSchema",
193
601
  "name": "destroy",
194
602
  "rawName": "rawDestroy"
195
603
  }
@@ -201,50 +609,178 @@
201
609
  "jsonApiType": "field",
202
610
  "endpoints": [
203
611
  {
204
- "rel": "create",
205
612
  "returnsCollection": false,
613
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/create",
614
+ "rel": "create",
615
+ "urlTemplate": "/item-types/${itemTypeId}/fields",
616
+ "method": "POST",
617
+ "comment": "Create a new field",
618
+ "urlPlaceholder": {
619
+ "variableName": "itemTypeId",
620
+ "isEntityId": false,
621
+ "relType": "ItemTypeData"
622
+ },
623
+ "requestBodyType": "FieldCreateSchema",
624
+ "requestStructure": {
625
+ "type": "field",
626
+ "attributes": [
627
+ "label",
628
+ "field_type",
629
+ "api_key",
630
+ "localized",
631
+ "validators",
632
+ "appeareance",
633
+ "appearance",
634
+ "position",
635
+ "hint",
636
+ "default_value"
637
+ ],
638
+ "relationships": [
639
+ "fieldset"
640
+ ]
641
+ },
642
+ "queryParamsRequired": false,
643
+ "responseType": "FieldCreateJobSchema",
206
644
  "name": "create",
207
645
  "rawName": "rawCreate"
208
646
  },
209
647
  {
210
- "rel": "update",
211
648
  "returnsCollection": false,
649
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/update",
650
+ "rel": "update",
651
+ "urlTemplate": "/fields/${fieldId}",
652
+ "method": "PUT",
653
+ "comment": "Update a field",
654
+ "urlPlaceholder": {
655
+ "variableName": "fieldId",
656
+ "isEntityId": true,
657
+ "relType": "FieldData"
658
+ },
659
+ "requestBodyType": "FieldUpdateSchema",
660
+ "requestStructure": {
661
+ "type": "field",
662
+ "attributes": [
663
+ "default_value",
664
+ "label",
665
+ "api_key",
666
+ "localized",
667
+ "validators",
668
+ "appeareance",
669
+ "appearance",
670
+ "position",
671
+ "field_type",
672
+ "hint"
673
+ ],
674
+ "relationships": [
675
+ "fieldset"
676
+ ]
677
+ },
678
+ "queryParamsRequired": false,
679
+ "responseType": "FieldUpdateJobSchema",
212
680
  "name": "update",
213
681
  "rawName": "rawUpdate"
214
682
  },
215
683
  {
216
- "rel": "instances",
217
684
  "returnsCollection": true,
685
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/instances",
686
+ "rel": "instances",
687
+ "urlTemplate": "/item-types/${itemTypeId}/fields",
688
+ "method": "GET",
689
+ "comment": "List all fields",
690
+ "urlPlaceholder": {
691
+ "variableName": "itemTypeId",
692
+ "isEntityId": false,
693
+ "relType": "ItemTypeData"
694
+ },
695
+ "queryParamsRequired": false,
696
+ "responseType": "FieldInstancesTargetSchema",
218
697
  "name": "list",
219
698
  "rawName": "rawList"
220
699
  },
221
700
  {
222
- "rel": "referencing",
223
701
  "returnsCollection": false,
702
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/referencing",
703
+ "rel": "referencing",
704
+ "urlTemplate": "/item-types/${itemTypeId}/fields/referencing",
705
+ "method": "GET",
706
+ "comment": "List referenced fields",
707
+ "urlPlaceholder": {
708
+ "variableName": "itemTypeId",
709
+ "isEntityId": false,
710
+ "relType": "ItemTypeData"
711
+ },
712
+ "queryParamsRequired": false,
713
+ "responseType": "FieldReferencingTargetSchema",
714
+ "deprecated": "This API call is to be considered private and might change without notice",
224
715
  "name": "referencing",
225
716
  "rawName": "rawReferencing"
226
717
  },
227
718
  {
228
- "rel": "related",
229
719
  "returnsCollection": false,
720
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/related",
721
+ "rel": "related",
722
+ "urlTemplate": "/item-types/${itemTypeId}/fields/related",
723
+ "method": "GET",
724
+ "comment": "List related fields",
725
+ "urlPlaceholder": {
726
+ "variableName": "itemTypeId",
727
+ "isEntityId": false,
728
+ "relType": "ItemTypeData"
729
+ },
730
+ "queryParamsRequired": false,
731
+ "responseType": "FieldRelatedTargetSchema",
732
+ "deprecated": "This API call is to be considered private and might change without notice",
230
733
  "name": "related",
231
734
  "rawName": "rawRelated"
232
735
  },
233
736
  {
234
- "rel": "self",
235
737
  "returnsCollection": false,
738
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/self",
739
+ "rel": "self",
740
+ "urlTemplate": "/fields/${fieldId}",
741
+ "method": "GET",
742
+ "comment": "Retrieve a field",
743
+ "urlPlaceholder": {
744
+ "variableName": "fieldId",
745
+ "isEntityId": true,
746
+ "relType": "FieldData"
747
+ },
748
+ "queryParamsRequired": false,
749
+ "responseType": "FieldSelfTargetSchema",
236
750
  "name": "find",
237
751
  "rawName": "rawFind"
238
752
  },
239
753
  {
240
- "rel": "destroy",
241
754
  "returnsCollection": false,
755
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/destroy",
756
+ "rel": "destroy",
757
+ "urlTemplate": "/fields/${fieldId}",
758
+ "method": "DELETE",
759
+ "comment": "Delete a field",
760
+ "urlPlaceholder": {
761
+ "variableName": "fieldId",
762
+ "isEntityId": true,
763
+ "relType": "FieldData"
764
+ },
765
+ "queryParamsRequired": false,
766
+ "responseType": "FieldDestroyJobSchema",
242
767
  "name": "destroy",
243
768
  "rawName": "rawDestroy"
244
769
  },
245
770
  {
246
- "rel": "duplicate",
247
771
  "returnsCollection": false,
772
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/duplicate",
773
+ "rel": "duplicate",
774
+ "urlTemplate": "/fields/${fieldId}/duplicate",
775
+ "method": "POST",
776
+ "comment": "Duplicate a field",
777
+ "urlPlaceholder": {
778
+ "variableName": "fieldId",
779
+ "isEntityId": true,
780
+ "relType": "FieldData"
781
+ },
782
+ "queryParamsRequired": false,
783
+ "responseType": "FieldDuplicateJobSchema",
248
784
  "name": "duplicate",
249
785
  "rawName": "rawDuplicate"
250
786
  }
@@ -256,32 +792,111 @@
256
792
  "jsonApiType": "fieldset",
257
793
  "endpoints": [
258
794
  {
259
- "rel": "create",
260
795
  "returnsCollection": false,
796
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/create",
797
+ "rel": "create",
798
+ "urlTemplate": "/item-types/${itemTypeId}/fieldsets",
799
+ "method": "POST",
800
+ "comment": "Create a new fieldset",
801
+ "urlPlaceholder": {
802
+ "variableName": "itemTypeId",
803
+ "isEntityId": false,
804
+ "relType": "ItemTypeData"
805
+ },
806
+ "requestBodyType": "FieldsetCreateSchema",
807
+ "requestStructure": {
808
+ "type": "fieldset",
809
+ "attributes": [
810
+ "title",
811
+ "hint",
812
+ "position",
813
+ "collapsible",
814
+ "start_collapsed"
815
+ ],
816
+ "relationships": []
817
+ },
818
+ "queryParamsRequired": false,
819
+ "responseType": "FieldsetCreateTargetSchema",
261
820
  "name": "create",
262
821
  "rawName": "rawCreate"
263
822
  },
264
823
  {
265
- "rel": "update",
266
824
  "returnsCollection": false,
825
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/update",
826
+ "rel": "update",
827
+ "urlTemplate": "/fieldsets/${fieldsetId}",
828
+ "method": "PUT",
829
+ "comment": "Update a fieldset",
830
+ "urlPlaceholder": {
831
+ "variableName": "fieldsetId",
832
+ "isEntityId": true,
833
+ "relType": "FieldsetData"
834
+ },
835
+ "requestBodyType": "FieldsetUpdateSchema",
836
+ "requestStructure": {
837
+ "type": "fieldset",
838
+ "attributes": [
839
+ "title",
840
+ "hint",
841
+ "position",
842
+ "collapsible",
843
+ "start_collapsed"
844
+ ],
845
+ "relationships": []
846
+ },
847
+ "queryParamsRequired": false,
848
+ "responseType": "FieldsetUpdateTargetSchema",
267
849
  "name": "update",
268
850
  "rawName": "rawUpdate"
269
851
  },
270
852
  {
271
- "rel": "instances",
272
853
  "returnsCollection": true,
854
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/instances",
855
+ "rel": "instances",
856
+ "urlTemplate": "/item-types/${itemTypeId}/fieldsets",
857
+ "method": "GET",
858
+ "comment": "List all fieldsets",
859
+ "urlPlaceholder": {
860
+ "variableName": "itemTypeId",
861
+ "isEntityId": false,
862
+ "relType": "ItemTypeData"
863
+ },
864
+ "queryParamsRequired": false,
865
+ "responseType": "FieldsetInstancesTargetSchema",
273
866
  "name": "list",
274
867
  "rawName": "rawList"
275
868
  },
276
869
  {
277
- "rel": "self",
278
870
  "returnsCollection": false,
871
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/self",
872
+ "rel": "self",
873
+ "urlTemplate": "/fieldsets/${fieldsetId}",
874
+ "method": "GET",
875
+ "comment": "Retrieve a fieldset",
876
+ "urlPlaceholder": {
877
+ "variableName": "fieldsetId",
878
+ "isEntityId": true,
879
+ "relType": "FieldsetData"
880
+ },
881
+ "queryParamsRequired": false,
882
+ "responseType": "FieldsetSelfTargetSchema",
279
883
  "name": "find",
280
884
  "rawName": "rawFind"
281
885
  },
282
886
  {
283
- "rel": "destroy",
284
887
  "returnsCollection": false,
888
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy",
889
+ "rel": "destroy",
890
+ "urlTemplate": "/fieldsets/${fieldsetId}",
891
+ "method": "DELETE",
892
+ "comment": "Delete a fieldset",
893
+ "urlPlaceholder": {
894
+ "variableName": "fieldsetId",
895
+ "isEntityId": true,
896
+ "relType": "FieldsetData"
897
+ },
898
+ "queryParamsRequired": false,
899
+ "responseType": "FieldsetDestroyTargetSchema",
285
900
  "name": "destroy",
286
901
  "rawName": "rawDestroy"
287
902
  }
@@ -293,8 +908,25 @@
293
908
  "jsonApiType": "session",
294
909
  "endpoints": [
295
910
  {
296
- "rel": "create",
297
911
  "returnsCollection": false,
912
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/session/create",
913
+ "rel": "create",
914
+ "urlTemplate": "/sessions",
915
+ "method": "POST",
916
+ "comment": "Create a new session",
917
+ "requestBodyType": "SessionCreateSchema",
918
+ "requestStructure": {
919
+ "type": "email_credentials",
920
+ "attributes": [
921
+ "email",
922
+ "password",
923
+ "otp_code"
924
+ ],
925
+ "relationships": []
926
+ },
927
+ "queryParamsRequired": false,
928
+ "responseType": "SessionCreateTargetSchema",
929
+ "deprecated": "This API call is to be considered private and might change without notice",
298
930
  "name": "create",
299
931
  "rawName": "rawCreate"
300
932
  }
@@ -306,38 +938,121 @@
306
938
  "jsonApiType": "access_token",
307
939
  "endpoints": [
308
940
  {
309
- "rel": "create",
310
941
  "returnsCollection": false,
942
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/create",
943
+ "rel": "create",
944
+ "urlTemplate": "/access_tokens",
945
+ "method": "POST",
946
+ "comment": "Create a new API token",
947
+ "requestBodyType": "AccessTokenCreateSchema",
948
+ "requestStructure": {
949
+ "type": "access_token",
950
+ "attributes": [
951
+ "name",
952
+ "can_access_cda",
953
+ "can_access_cda_preview",
954
+ "can_access_cma"
955
+ ],
956
+ "relationships": [
957
+ "role"
958
+ ]
959
+ },
960
+ "queryParamsRequired": false,
961
+ "responseType": "AccessTokenCreateTargetSchema",
311
962
  "name": "create",
312
963
  "rawName": "rawCreate"
313
964
  },
314
965
  {
315
- "rel": "update",
316
966
  "returnsCollection": false,
967
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/update",
968
+ "rel": "update",
969
+ "urlTemplate": "/access_tokens/${accessTokenId}",
970
+ "method": "PUT",
971
+ "comment": "Update an API token",
972
+ "urlPlaceholder": {
973
+ "variableName": "accessTokenId",
974
+ "isEntityId": true,
975
+ "relType": "AccessTokenData"
976
+ },
977
+ "requestBodyType": "AccessTokenUpdateSchema",
978
+ "requestStructure": {
979
+ "type": "access_token",
980
+ "attributes": [
981
+ "name",
982
+ "can_access_cda",
983
+ "can_access_cda_preview",
984
+ "can_access_cma"
985
+ ],
986
+ "relationships": [
987
+ "role"
988
+ ]
989
+ },
990
+ "queryParamsRequired": false,
991
+ "responseType": "AccessTokenUpdateTargetSchema",
317
992
  "name": "update",
318
993
  "rawName": "rawUpdate"
319
994
  },
320
995
  {
321
- "rel": "instances",
322
996
  "returnsCollection": true,
997
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/instances",
998
+ "rel": "instances",
999
+ "urlTemplate": "/access_tokens",
1000
+ "method": "GET",
1001
+ "comment": "List all API tokens",
1002
+ "queryParamsRequired": false,
1003
+ "responseType": "AccessTokenInstancesTargetSchema",
323
1004
  "name": "list",
324
1005
  "rawName": "rawList"
325
1006
  },
326
1007
  {
327
- "rel": "self",
328
1008
  "returnsCollection": false,
1009
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/self",
1010
+ "rel": "self",
1011
+ "urlTemplate": "/access_tokens/${accessTokenId}",
1012
+ "method": "GET",
1013
+ "comment": "Retrieve an API token",
1014
+ "urlPlaceholder": {
1015
+ "variableName": "accessTokenId",
1016
+ "isEntityId": true,
1017
+ "relType": "AccessTokenData"
1018
+ },
1019
+ "queryParamsRequired": false,
1020
+ "responseType": "AccessTokenSelfTargetSchema",
329
1021
  "name": "find",
330
1022
  "rawName": "rawFind"
331
1023
  },
332
1024
  {
333
- "rel": "regenerate_token",
334
1025
  "returnsCollection": false,
1026
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token",
1027
+ "rel": "regenerate_token",
1028
+ "urlTemplate": "/access_tokens/${accessTokenId}/regenerate_token",
1029
+ "method": "POST",
1030
+ "comment": "Rotate API token",
1031
+ "urlPlaceholder": {
1032
+ "variableName": "accessTokenId",
1033
+ "isEntityId": true,
1034
+ "relType": "AccessTokenData"
1035
+ },
1036
+ "queryParamsRequired": false,
1037
+ "responseType": "AccessTokenRegenerateTokenTargetSchema",
335
1038
  "name": "regenerateToken",
336
1039
  "rawName": "rawRegenerateToken"
337
1040
  },
338
1041
  {
339
- "rel": "destroy",
340
1042
  "returnsCollection": false,
1043
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/access-token/destroy",
1044
+ "rel": "destroy",
1045
+ "urlTemplate": "/access_tokens/${accessTokenId}",
1046
+ "method": "DELETE",
1047
+ "comment": "Delete an API token",
1048
+ "urlPlaceholder": {
1049
+ "variableName": "accessTokenId",
1050
+ "isEntityId": true,
1051
+ "relType": "AccessTokenData"
1052
+ },
1053
+ "queryParamsType": "AccessTokenDestroyHrefSchema",
1054
+ "queryParamsRequired": false,
1055
+ "responseType": "AccessTokenDestroyTargetSchema",
341
1056
  "name": "destroy",
342
1057
  "rawName": "rawDestroy"
343
1058
  }
@@ -349,38 +1064,123 @@
349
1064
  "jsonApiType": "plugin",
350
1065
  "endpoints": [
351
1066
  {
352
- "rel": "create",
353
1067
  "returnsCollection": false,
1068
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/create",
1069
+ "rel": "create",
1070
+ "urlTemplate": "/plugins",
1071
+ "method": "POST",
1072
+ "comment": "Create a new plugin",
1073
+ "requestBodyType": "PluginCreateSchema",
1074
+ "requestStructure": {
1075
+ "type": "plugin",
1076
+ "attributes": [
1077
+ "package_name",
1078
+ "name",
1079
+ "description",
1080
+ "url",
1081
+ "permissions",
1082
+ "plugin_type",
1083
+ "field_types",
1084
+ "parameter_definitions",
1085
+ "package_version"
1086
+ ],
1087
+ "relationships": []
1088
+ },
1089
+ "queryParamsRequired": false,
1090
+ "responseType": "PluginCreateTargetSchema",
354
1091
  "name": "create",
355
1092
  "rawName": "rawCreate"
356
1093
  },
357
1094
  {
358
- "rel": "update",
359
1095
  "returnsCollection": false,
1096
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/update",
1097
+ "rel": "update",
1098
+ "urlTemplate": "/plugins/${pluginId}",
1099
+ "method": "PUT",
1100
+ "comment": "Update a plugin",
1101
+ "urlPlaceholder": {
1102
+ "variableName": "pluginId",
1103
+ "isEntityId": true,
1104
+ "relType": "PluginData"
1105
+ },
1106
+ "requestBodyType": "PluginUpdateSchema",
1107
+ "requestStructure": {
1108
+ "type": "plugin",
1109
+ "attributes": [
1110
+ "name",
1111
+ "description",
1112
+ "url",
1113
+ "parameters",
1114
+ "package_version",
1115
+ "permissions"
1116
+ ],
1117
+ "relationships": []
1118
+ },
1119
+ "queryParamsRequired": false,
1120
+ "responseType": "PluginUpdateTargetSchema",
360
1121
  "name": "update",
361
1122
  "rawName": "rawUpdate"
362
1123
  },
363
1124
  {
364
- "rel": "instances",
365
1125
  "returnsCollection": true,
1126
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/instances",
1127
+ "rel": "instances",
1128
+ "urlTemplate": "/plugins",
1129
+ "method": "GET",
1130
+ "comment": "List all plugins",
1131
+ "queryParamsRequired": false,
1132
+ "responseType": "PluginInstancesTargetSchema",
366
1133
  "name": "list",
367
1134
  "rawName": "rawList"
368
1135
  },
369
1136
  {
370
- "rel": "self",
371
1137
  "returnsCollection": false,
1138
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/self",
1139
+ "rel": "self",
1140
+ "urlTemplate": "/plugins/${pluginId}",
1141
+ "method": "GET",
1142
+ "comment": "Retrieve a plugins",
1143
+ "urlPlaceholder": {
1144
+ "variableName": "pluginId",
1145
+ "isEntityId": true,
1146
+ "relType": "PluginData"
1147
+ },
1148
+ "queryParamsRequired": false,
1149
+ "responseType": "PluginSelfTargetSchema",
372
1150
  "name": "find",
373
1151
  "rawName": "rawFind"
374
1152
  },
375
1153
  {
376
- "rel": "destroy",
377
1154
  "returnsCollection": false,
1155
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/destroy",
1156
+ "rel": "destroy",
1157
+ "urlTemplate": "/plugins/${pluginId}",
1158
+ "method": "DELETE",
1159
+ "comment": "Delete a plugin",
1160
+ "urlPlaceholder": {
1161
+ "variableName": "pluginId",
1162
+ "isEntityId": true,
1163
+ "relType": "PluginData"
1164
+ },
1165
+ "queryParamsRequired": false,
1166
+ "responseType": "PluginDestroyTargetSchema",
378
1167
  "name": "destroy",
379
1168
  "rawName": "rawDestroy"
380
1169
  },
381
1170
  {
382
- "rel": "fields",
383
1171
  "returnsCollection": false,
1172
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/plugin/fields",
1173
+ "rel": "fields",
1174
+ "urlTemplate": "/plugins/${pluginId}/fields",
1175
+ "method": "GET",
1176
+ "comment": "Retrieve all fields using the plugin",
1177
+ "urlPlaceholder": {
1178
+ "variableName": "pluginId",
1179
+ "isEntityId": true,
1180
+ "relType": "PluginData"
1181
+ },
1182
+ "queryParamsRequired": false,
1183
+ "responseType": "PluginFieldsTargetSchema",
384
1184
  "name": "fields",
385
1185
  "rawName": "rawFields"
386
1186
  }
@@ -392,8 +1192,19 @@
392
1192
  "jsonApiType": "job_result",
393
1193
  "endpoints": [
394
1194
  {
395
- "rel": "self",
396
1195
  "returnsCollection": false,
1196
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/job-result/self",
1197
+ "rel": "self",
1198
+ "urlTemplate": "/job-results/${jobResultId}",
1199
+ "method": "GET",
1200
+ "comment": "Retrieve a job result",
1201
+ "urlPlaceholder": {
1202
+ "variableName": "jobResultId",
1203
+ "isEntityId": true,
1204
+ "relType": "JobResultData"
1205
+ },
1206
+ "queryParamsRequired": false,
1207
+ "responseType": "JobResultSelfTargetSchema",
397
1208
  "name": "find",
398
1209
  "rawName": "rawFind"
399
1210
  }
@@ -405,14 +1216,31 @@
405
1216
  "jsonApiType": "subscription_limit",
406
1217
  "endpoints": [
407
1218
  {
408
- "rel": "instances",
409
1219
  "returnsCollection": true,
1220
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances",
1221
+ "rel": "instances",
1222
+ "urlTemplate": "/subscription-limits",
1223
+ "method": "GET",
1224
+ "comment": "Get all the subscription limits",
1225
+ "queryParamsRequired": false,
1226
+ "responseType": "SubscriptionLimitInstancesTargetSchema",
410
1227
  "name": "list",
411
1228
  "rawName": "rawList"
412
1229
  },
413
1230
  {
414
- "rel": "self",
415
1231
  "returnsCollection": false,
1232
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self",
1233
+ "rel": "self",
1234
+ "urlTemplate": "/subscription-limits/${subscriptionLimitId}",
1235
+ "method": "GET",
1236
+ "comment": "Get a single subscription limit",
1237
+ "urlPlaceholder": {
1238
+ "variableName": "subscriptionLimitId",
1239
+ "isEntityId": true,
1240
+ "relType": "SubscriptionLimitData"
1241
+ },
1242
+ "queryParamsRequired": false,
1243
+ "responseType": "SubscriptionLimitSelfTargetSchema",
416
1244
  "name": "find",
417
1245
  "rawName": "rawFind"
418
1246
  }
@@ -424,8 +1252,14 @@
424
1252
  "jsonApiType": "subscription_feature",
425
1253
  "endpoints": [
426
1254
  {
427
- "rel": "instances",
428
1255
  "returnsCollection": true,
1256
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances",
1257
+ "rel": "instances",
1258
+ "urlTemplate": "/subscription-features",
1259
+ "method": "GET",
1260
+ "comment": "Get all the subscription features",
1261
+ "queryParamsRequired": false,
1262
+ "responseType": "SubscriptionFeatureInstancesTargetSchema",
429
1263
  "name": "list",
430
1264
  "rawName": "rawList"
431
1265
  }
@@ -437,14 +1271,31 @@
437
1271
  "jsonApiType": "build_event",
438
1272
  "endpoints": [
439
1273
  {
440
- "rel": "instances",
441
1274
  "returnsCollection": true,
1275
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-event/instances",
1276
+ "rel": "instances",
1277
+ "urlTemplate": "/build-events",
1278
+ "method": "GET",
1279
+ "comment": "List all deploy events",
1280
+ "queryParamsRequired": false,
1281
+ "responseType": "BuildEventInstancesTargetSchema",
442
1282
  "name": "list",
443
1283
  "rawName": "rawList"
444
1284
  },
445
1285
  {
446
- "rel": "self",
447
1286
  "returnsCollection": false,
1287
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-event/self",
1288
+ "rel": "self",
1289
+ "urlTemplate": "/build-events/${buildEventId}",
1290
+ "method": "GET",
1291
+ "comment": "Retrieve a deploy event",
1292
+ "urlPlaceholder": {
1293
+ "variableName": "buildEventId",
1294
+ "isEntityId": true,
1295
+ "relType": "BuildEventData"
1296
+ },
1297
+ "queryParamsRequired": false,
1298
+ "responseType": "BuildEventSelfTargetSchema",
448
1299
  "name": "find",
449
1300
  "rawName": "rawFind"
450
1301
  }
@@ -456,8 +1307,15 @@
456
1307
  "jsonApiType": "item",
457
1308
  "endpoints": [
458
1309
  {
459
- "rel": "instances",
460
1310
  "returnsCollection": true,
1311
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/instances",
1312
+ "rel": "instances",
1313
+ "urlTemplate": "/items",
1314
+ "method": "GET",
1315
+ "comment": "List all records",
1316
+ "queryParamsType": "ItemInstancesHrefSchema",
1317
+ "queryParamsRequired": false,
1318
+ "responseType": "ItemInstancesTargetSchema",
461
1319
  "paginatedResponse": {
462
1320
  "defaultLimit": 30,
463
1321
  "maxLimit": 500
@@ -466,104 +1324,324 @@
466
1324
  "rawName": "rawList"
467
1325
  },
468
1326
  {
469
- "rel": "validate_existing",
470
1327
  "returnsCollection": false,
1328
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/validate_existing",
1329
+ "rel": "validate_existing",
1330
+ "urlTemplate": "/items/${itemId}/validate",
1331
+ "method": "POST",
1332
+ "comment": "Validates an existing record field",
1333
+ "urlPlaceholder": {
1334
+ "variableName": "itemId",
1335
+ "isEntityId": true,
1336
+ "relType": "ItemData"
1337
+ },
1338
+ "requestBodyType": "ItemValidateExistingSchema",
1339
+ "requestStructure": {
1340
+ "type": "item",
1341
+ "attributes": "*",
1342
+ "relationships": [
1343
+ "item_type",
1344
+ "creator"
1345
+ ]
1346
+ },
1347
+ "queryParamsRequired": false,
1348
+ "deprecated": "This API call is to be considered private and might change without notice",
471
1349
  "name": "validateExisting",
472
1350
  "rawName": "rawValidateExisting"
473
1351
  },
474
1352
  {
475
- "rel": "validate_new",
476
1353
  "returnsCollection": false,
1354
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/validate_new",
1355
+ "rel": "validate_new",
1356
+ "urlTemplate": "/items/validate",
1357
+ "method": "POST",
1358
+ "comment": "Validates a record field",
1359
+ "requestBodyType": "ItemValidateNewSchema",
1360
+ "requestStructure": {
1361
+ "type": "item",
1362
+ "attributes": "*",
1363
+ "relationships": [
1364
+ "item_type"
1365
+ ]
1366
+ },
1367
+ "queryParamsRequired": false,
1368
+ "deprecated": "This API call is to be considered private and might change without notice",
477
1369
  "name": "validateNew",
478
1370
  "rawName": "rawValidateNew"
479
1371
  },
480
1372
  {
481
- "rel": "create",
482
1373
  "returnsCollection": false,
1374
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/create",
1375
+ "rel": "create",
1376
+ "urlTemplate": "/items",
1377
+ "method": "POST",
1378
+ "comment": "Create a new record",
1379
+ "requestBodyType": "ItemCreateSchema",
1380
+ "requestStructure": {
1381
+ "type": "item",
1382
+ "attributes": "*",
1383
+ "relationships": [
1384
+ "item_type"
1385
+ ]
1386
+ },
1387
+ "queryParamsRequired": false,
1388
+ "responseType": "ItemCreateTargetSchema",
483
1389
  "name": "create",
484
1390
  "rawName": "rawCreate"
485
1391
  },
486
1392
  {
487
- "rel": "duplicate",
488
1393
  "returnsCollection": false,
1394
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/duplicate",
1395
+ "rel": "duplicate",
1396
+ "urlTemplate": "/items/${itemId}/duplicate",
1397
+ "method": "POST",
1398
+ "comment": "Duplicate a record",
1399
+ "urlPlaceholder": {
1400
+ "variableName": "itemId",
1401
+ "isEntityId": true,
1402
+ "relType": "ItemData"
1403
+ },
1404
+ "queryParamsRequired": false,
1405
+ "responseType": "ItemDuplicateJobSchema",
489
1406
  "name": "duplicate",
490
1407
  "rawName": "rawDuplicate"
491
1408
  },
492
1409
  {
493
- "rel": "update",
494
1410
  "returnsCollection": false,
1411
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/update",
1412
+ "rel": "update",
1413
+ "urlTemplate": "/items/${itemId}",
1414
+ "method": "PUT",
1415
+ "comment": "Update a record",
1416
+ "urlPlaceholder": {
1417
+ "variableName": "itemId",
1418
+ "isEntityId": true,
1419
+ "relType": "ItemData"
1420
+ },
1421
+ "requestBodyType": "ItemUpdateSchema",
1422
+ "requestStructure": {
1423
+ "type": "item",
1424
+ "attributes": "*",
1425
+ "relationships": [
1426
+ "item_type",
1427
+ "creator"
1428
+ ]
1429
+ },
1430
+ "queryParamsRequired": false,
1431
+ "responseType": "ItemUpdateTargetSchema",
495
1432
  "name": "update",
496
1433
  "rawName": "rawUpdate"
497
1434
  },
498
1435
  {
499
- "rel": "references",
500
1436
  "returnsCollection": false,
1437
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/references",
1438
+ "rel": "references",
1439
+ "urlTemplate": "/items/${itemId}/references",
1440
+ "method": "GET",
1441
+ "comment": "Referenced records",
1442
+ "urlPlaceholder": {
1443
+ "variableName": "itemId",
1444
+ "isEntityId": true,
1445
+ "relType": "ItemData"
1446
+ },
1447
+ "queryParamsType": "ItemReferencesHrefSchema",
1448
+ "queryParamsRequired": false,
1449
+ "responseType": "ItemReferencesTargetSchema",
501
1450
  "name": "references",
502
1451
  "rawName": "rawReferences"
503
1452
  },
504
1453
  {
505
- "rel": "self",
506
1454
  "returnsCollection": false,
1455
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/self",
1456
+ "rel": "self",
1457
+ "urlTemplate": "/items/${itemId}",
1458
+ "method": "GET",
1459
+ "comment": "Retrieve a record",
1460
+ "urlPlaceholder": {
1461
+ "variableName": "itemId",
1462
+ "isEntityId": true,
1463
+ "relType": "ItemData"
1464
+ },
1465
+ "queryParamsType": "ItemSelfHrefSchema",
1466
+ "queryParamsRequired": false,
1467
+ "responseType": "ItemSelfTargetSchema",
507
1468
  "name": "find",
508
1469
  "rawName": "rawFind"
509
1470
  },
510
1471
  {
511
- "rel": "destroy",
512
1472
  "returnsCollection": false,
1473
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/destroy",
1474
+ "rel": "destroy",
1475
+ "urlTemplate": "/items/${itemId}",
1476
+ "method": "DELETE",
1477
+ "comment": "Delete a record",
1478
+ "urlPlaceholder": {
1479
+ "variableName": "itemId",
1480
+ "isEntityId": true,
1481
+ "relType": "ItemData"
1482
+ },
1483
+ "queryParamsRequired": false,
1484
+ "responseType": "ItemDestroyJobSchema",
513
1485
  "name": "destroy",
514
1486
  "rawName": "rawDestroy"
515
1487
  },
516
1488
  {
517
- "rel": "batch_destroy",
518
1489
  "returnsCollection": false,
1490
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/batch_destroy",
1491
+ "rel": "batch_destroy",
1492
+ "urlTemplate": "/items",
1493
+ "method": "DELETE",
1494
+ "comment": "Delete multiple records",
1495
+ "queryParamsType": "ItemBatchDestroyHrefSchema",
1496
+ "queryParamsRequired": true,
1497
+ "responseType": "ItemBatchDestroyJobSchema",
1498
+ "deprecated": "This API call is to be considered private and might change without notice",
519
1499
  "name": "batchDestroy",
520
1500
  "rawName": "rawBatchDestroy"
521
1501
  },
522
1502
  {
523
- "rel": "batch_publish",
524
1503
  "returnsCollection": false,
1504
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/batch_publish",
1505
+ "rel": "batch_publish",
1506
+ "urlTemplate": "/items/publish",
1507
+ "method": "PUT",
1508
+ "comment": "Publish multiple records",
1509
+ "queryParamsType": "ItemBatchPublishHrefSchema",
1510
+ "queryParamsRequired": true,
1511
+ "responseType": "ItemBatchPublishJobSchema",
1512
+ "deprecated": "This API call is to be considered private and might change without notice",
525
1513
  "name": "batchPublish",
526
1514
  "rawName": "rawBatchPublish"
527
1515
  },
528
1516
  {
529
- "rel": "batch_unpublish",
530
1517
  "returnsCollection": false,
1518
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/batch_unpublish",
1519
+ "rel": "batch_unpublish",
1520
+ "urlTemplate": "/items/unpublish",
1521
+ "method": "PUT",
1522
+ "comment": "Unpublish multiple records",
1523
+ "queryParamsType": "ItemBatchUnpublishHrefSchema",
1524
+ "queryParamsRequired": true,
1525
+ "responseType": "ItemBatchUnpublishJobSchema",
1526
+ "deprecated": "This API call is to be considered private and might change without notice",
531
1527
  "name": "batchUnpublish",
532
1528
  "rawName": "rawBatchUnpublish"
533
1529
  },
534
1530
  {
535
- "rel": "publish",
536
1531
  "returnsCollection": false,
1532
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/publish",
1533
+ "rel": "publish",
1534
+ "urlTemplate": "/items/${itemId}/publish",
1535
+ "method": "PUT",
1536
+ "comment": "Publish a record",
1537
+ "urlPlaceholder": {
1538
+ "variableName": "itemId",
1539
+ "isEntityId": true,
1540
+ "relType": "ItemData"
1541
+ },
1542
+ "queryParamsType": "ItemPublishHrefSchema",
1543
+ "queryParamsRequired": false,
1544
+ "responseType": "ItemPublishTargetSchema",
537
1545
  "name": "publish",
538
1546
  "rawName": "rawPublish"
539
1547
  },
540
1548
  {
541
- "rel": "unpublish",
542
1549
  "returnsCollection": false,
1550
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/unpublish",
1551
+ "rel": "unpublish",
1552
+ "urlTemplate": "/items/${itemId}/unpublish",
1553
+ "method": "PUT",
1554
+ "comment": "Unpublish a record",
1555
+ "urlPlaceholder": {
1556
+ "variableName": "itemId",
1557
+ "isEntityId": true,
1558
+ "relType": "ItemData"
1559
+ },
1560
+ "queryParamsType": "ItemUnpublishHrefSchema",
1561
+ "queryParamsRequired": false,
1562
+ "responseType": "ItemUnpublishTargetSchema",
543
1563
  "name": "unpublish",
544
1564
  "rawName": "rawUnpublish"
545
1565
  },
546
1566
  {
547
- "rel": "bulk_publish",
548
1567
  "returnsCollection": false,
1568
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/bulk_publish",
1569
+ "rel": "bulk_publish",
1570
+ "urlTemplate": "/items/bulk/publish",
1571
+ "method": "POST",
1572
+ "comment": "Publish items in bulk",
1573
+ "requestBodyType": "ItemBulkPublishSchema",
1574
+ "requestStructure": {
1575
+ "type": "item_bulk_publish_operation",
1576
+ "attributes": [],
1577
+ "relationships": [
1578
+ "items"
1579
+ ]
1580
+ },
1581
+ "queryParamsRequired": false,
1582
+ "responseType": "ItemBulkPublishJobSchema",
549
1583
  "name": "bulkPublish",
550
1584
  "rawName": "rawBulkPublish"
551
1585
  },
552
1586
  {
553
- "rel": "bulk_unpublish",
554
1587
  "returnsCollection": false,
1588
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/bulk_unpublish",
1589
+ "rel": "bulk_unpublish",
1590
+ "urlTemplate": "/items/bulk/unpublish",
1591
+ "method": "POST",
1592
+ "comment": "Unpublish items in bulk",
1593
+ "requestBodyType": "ItemBulkUnpublishSchema",
1594
+ "requestStructure": {
1595
+ "type": "item_bulk_unpublish_operation",
1596
+ "attributes": [],
1597
+ "relationships": [
1598
+ "items"
1599
+ ]
1600
+ },
1601
+ "queryParamsRequired": false,
1602
+ "responseType": "ItemBulkUnpublishJobSchema",
555
1603
  "name": "bulkUnpublish",
556
1604
  "rawName": "rawBulkUnpublish"
557
1605
  },
558
1606
  {
559
- "rel": "bulk_destroy",
560
1607
  "returnsCollection": false,
1608
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/bulk_destroy",
1609
+ "rel": "bulk_destroy",
1610
+ "urlTemplate": "/items/bulk/destroy",
1611
+ "method": "POST",
1612
+ "comment": "Destroy items in bulk",
1613
+ "requestBodyType": "ItemBulkDestroySchema",
1614
+ "requestStructure": {
1615
+ "type": "item_bulk_destroy_operation",
1616
+ "attributes": [],
1617
+ "relationships": [
1618
+ "items"
1619
+ ]
1620
+ },
1621
+ "queryParamsRequired": false,
1622
+ "responseType": "ItemBulkDestroyJobSchema",
561
1623
  "name": "bulkDestroy",
562
1624
  "rawName": "rawBulkDestroy"
563
1625
  },
564
1626
  {
565
- "rel": "bulk_move_to_stage",
566
1627
  "returnsCollection": false,
1628
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/bulk_move_to_stage",
1629
+ "rel": "bulk_move_to_stage",
1630
+ "urlTemplate": "/items/bulk/move-to-stage",
1631
+ "method": "POST",
1632
+ "comment": "Move items to stage in bulk",
1633
+ "requestBodyType": "ItemBulkMoveToStageSchema",
1634
+ "requestStructure": {
1635
+ "type": "item_bulk_move_to_stage_operation",
1636
+ "attributes": [
1637
+ "stage"
1638
+ ],
1639
+ "relationships": [
1640
+ "items"
1641
+ ]
1642
+ },
1643
+ "queryParamsRequired": false,
1644
+ "responseType": "ItemBulkMoveToStageJobSchema",
567
1645
  "name": "bulkMoveToStage",
568
1646
  "rawName": "rawBulkMoveToStage"
569
1647
  }
@@ -575,14 +1653,37 @@
575
1653
  "jsonApiType": "item_version",
576
1654
  "endpoints": [
577
1655
  {
578
- "rel": "restore",
579
1656
  "returnsCollection": false,
1657
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-version/restore",
1658
+ "rel": "restore",
1659
+ "urlTemplate": "/versions/${itemVersionId}/restore",
1660
+ "method": "POST",
1661
+ "comment": "Restore an old record version",
1662
+ "urlPlaceholder": {
1663
+ "variableName": "itemVersionId",
1664
+ "isEntityId": true,
1665
+ "relType": "ItemVersionData"
1666
+ },
1667
+ "queryParamsRequired": false,
1668
+ "responseType": "ItemVersionRestoreJobSchema",
580
1669
  "name": "restore",
581
1670
  "rawName": "rawRestore"
582
1671
  },
583
1672
  {
584
- "rel": "instances",
585
1673
  "returnsCollection": true,
1674
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-version/instances",
1675
+ "rel": "instances",
1676
+ "urlTemplate": "/items/${itemId}/versions",
1677
+ "method": "GET",
1678
+ "comment": "List all record versions",
1679
+ "urlPlaceholder": {
1680
+ "variableName": "itemId",
1681
+ "isEntityId": false,
1682
+ "relType": "ItemData"
1683
+ },
1684
+ "queryParamsType": "ItemVersionInstancesHrefSchema",
1685
+ "queryParamsRequired": false,
1686
+ "responseType": "ItemVersionInstancesTargetSchema",
586
1687
  "paginatedResponse": {
587
1688
  "defaultLimit": 15,
588
1689
  "maxLimit": 50
@@ -591,8 +1692,19 @@
591
1692
  "rawName": "rawList"
592
1693
  },
593
1694
  {
594
- "rel": "self",
595
1695
  "returnsCollection": false,
1696
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-version/self",
1697
+ "rel": "self",
1698
+ "urlTemplate": "/versions/${itemVersionId}",
1699
+ "method": "GET",
1700
+ "comment": "Retrieve a record version",
1701
+ "urlPlaceholder": {
1702
+ "variableName": "itemVersionId",
1703
+ "isEntityId": true,
1704
+ "relType": "ItemVersionData"
1705
+ },
1706
+ "queryParamsRequired": false,
1707
+ "responseType": "ItemVersionSelfTargetSchema",
596
1708
  "name": "find",
597
1709
  "rawName": "rawFind"
598
1710
  }
@@ -604,14 +1716,40 @@
604
1716
  "jsonApiType": "upload",
605
1717
  "endpoints": [
606
1718
  {
607
- "rel": "create",
608
1719
  "returnsCollection": false,
1720
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/create",
1721
+ "rel": "create",
1722
+ "urlTemplate": "/uploads",
1723
+ "method": "POST",
1724
+ "comment": "Create a new upload",
1725
+ "requestBodyType": "UploadCreateSchema",
1726
+ "requestStructure": {
1727
+ "type": "upload",
1728
+ "attributes": [
1729
+ "path",
1730
+ "copyright",
1731
+ "author",
1732
+ "notes",
1733
+ "default_field_metadata",
1734
+ "tags"
1735
+ ],
1736
+ "relationships": []
1737
+ },
1738
+ "queryParamsRequired": false,
1739
+ "responseType": "UploadCreateJobSchema",
609
1740
  "name": "create",
610
1741
  "rawName": "rawCreate"
611
1742
  },
612
1743
  {
613
- "rel": "instances",
614
1744
  "returnsCollection": true,
1745
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/instances",
1746
+ "rel": "instances",
1747
+ "urlTemplate": "/uploads",
1748
+ "method": "GET",
1749
+ "comment": "List all uploads",
1750
+ "queryParamsType": "UploadInstancesHrefSchema",
1751
+ "queryParamsRequired": false,
1752
+ "responseType": "UploadInstancesTargetSchema",
615
1753
  "paginatedResponse": {
616
1754
  "defaultLimit": 30,
617
1755
  "maxLimit": 500
@@ -620,50 +1758,165 @@
620
1758
  "rawName": "rawList"
621
1759
  },
622
1760
  {
623
- "rel": "self",
624
1761
  "returnsCollection": false,
1762
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/self",
1763
+ "rel": "self",
1764
+ "urlTemplate": "/uploads/${uploadId}",
1765
+ "method": "GET",
1766
+ "comment": "Retrieve an upload",
1767
+ "urlPlaceholder": {
1768
+ "variableName": "uploadId",
1769
+ "isEntityId": true,
1770
+ "relType": "UploadData"
1771
+ },
1772
+ "queryParamsRequired": false,
1773
+ "responseType": "UploadSelfTargetSchema",
625
1774
  "name": "find",
626
1775
  "rawName": "rawFind"
627
1776
  },
628
1777
  {
629
- "rel": "destroy",
630
1778
  "returnsCollection": false,
1779
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/destroy",
1780
+ "rel": "destroy",
1781
+ "urlTemplate": "/uploads/${uploadId}",
1782
+ "method": "DELETE",
1783
+ "comment": "Delete an upload",
1784
+ "urlPlaceholder": {
1785
+ "variableName": "uploadId",
1786
+ "isEntityId": true,
1787
+ "relType": "UploadData"
1788
+ },
1789
+ "queryParamsRequired": false,
1790
+ "responseType": "UploadDestroyTargetSchema",
631
1791
  "name": "destroy",
632
1792
  "rawName": "rawDestroy"
633
1793
  },
634
1794
  {
635
- "rel": "update",
636
1795
  "returnsCollection": false,
1796
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/update",
1797
+ "rel": "update",
1798
+ "urlTemplate": "/uploads/${uploadId}",
1799
+ "method": "PUT",
1800
+ "comment": "Update an upload",
1801
+ "urlPlaceholder": {
1802
+ "variableName": "uploadId",
1803
+ "isEntityId": true,
1804
+ "relType": "UploadData"
1805
+ },
1806
+ "requestBodyType": "UploadUpdateSchema",
1807
+ "requestStructure": {
1808
+ "type": "upload",
1809
+ "attributes": [
1810
+ "path",
1811
+ "basename",
1812
+ "copyright",
1813
+ "author",
1814
+ "notes",
1815
+ "tags",
1816
+ "default_field_metadata"
1817
+ ],
1818
+ "relationships": [
1819
+ "creator"
1820
+ ]
1821
+ },
1822
+ "queryParamsRequired": false,
1823
+ "responseType": "UploadUpdateJobSchema",
637
1824
  "name": "update",
638
1825
  "rawName": "rawUpdate"
639
1826
  },
640
1827
  {
641
- "rel": "batch_add_tags",
642
1828
  "returnsCollection": false,
1829
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags",
1830
+ "rel": "batch_add_tags",
1831
+ "urlTemplate": "/uploads/batch-add-tags",
1832
+ "method": "PUT",
1833
+ "comment": "Batch add tags to uploads",
1834
+ "requestBodyType": "UploadBatchAddTagsSchema",
1835
+ "requestStructure": {
1836
+ "type": "upload",
1837
+ "attributes": [
1838
+ "tags"
1839
+ ],
1840
+ "relationships": []
1841
+ },
1842
+ "queryParamsType": "UploadBatchAddTagsHrefSchema",
1843
+ "queryParamsRequired": false,
1844
+ "responseType": "UploadBatchAddTagsJobSchema",
1845
+ "deprecated": "This API call is to be considered private and might change without notice",
643
1846
  "name": "batchAddTags",
644
1847
  "rawName": "rawBatchAddTags"
645
1848
  },
646
1849
  {
647
- "rel": "batch_destroy",
648
1850
  "returnsCollection": false,
1851
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy",
1852
+ "rel": "batch_destroy",
1853
+ "urlTemplate": "/uploads/batch-destroy",
1854
+ "method": "DELETE",
1855
+ "comment": "Delete multiple uploads",
1856
+ "queryParamsType": "UploadBatchDestroyHrefSchema",
1857
+ "queryParamsRequired": false,
1858
+ "responseType": "UploadBatchDestroyJobSchema",
1859
+ "deprecated": "This API call is to be considered private and might change without notice",
649
1860
  "name": "batchDestroy",
650
1861
  "rawName": "rawBatchDestroy"
651
1862
  },
652
1863
  {
653
- "rel": "references",
654
1864
  "returnsCollection": false,
1865
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/references",
1866
+ "rel": "references",
1867
+ "urlTemplate": "/uploads/${uploadId}/references",
1868
+ "method": "GET",
1869
+ "comment": "Referenced records",
1870
+ "urlPlaceholder": {
1871
+ "variableName": "uploadId",
1872
+ "isEntityId": true,
1873
+ "relType": "UploadData"
1874
+ },
1875
+ "queryParamsType": "UploadReferencesHrefSchema",
1876
+ "queryParamsRequired": false,
1877
+ "responseType": "UploadReferencesTargetSchema",
655
1878
  "name": "references",
656
1879
  "rawName": "rawReferences"
657
1880
  },
658
1881
  {
659
- "rel": "bulk_tag",
660
1882
  "returnsCollection": false,
1883
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag",
1884
+ "rel": "bulk_tag",
1885
+ "urlTemplate": "/uploads/bulk/tag",
1886
+ "method": "POST",
1887
+ "comment": "Add tags to assets in bulk",
1888
+ "requestBodyType": "UploadBulkTagSchema",
1889
+ "requestStructure": {
1890
+ "type": "upload_bulk_tag_operation",
1891
+ "attributes": [
1892
+ "tags"
1893
+ ],
1894
+ "relationships": [
1895
+ "uploads"
1896
+ ]
1897
+ },
1898
+ "queryParamsRequired": false,
1899
+ "responseType": "UploadBulkTagJobSchema",
661
1900
  "name": "bulkTag",
662
1901
  "rawName": "rawBulkTag"
663
1902
  },
664
1903
  {
665
- "rel": "bulk_destroy",
666
1904
  "returnsCollection": false,
1905
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy",
1906
+ "rel": "bulk_destroy",
1907
+ "urlTemplate": "/uploads/bulk/destroy",
1908
+ "method": "POST",
1909
+ "comment": "Destroy uploads",
1910
+ "requestBodyType": "UploadBulkDestroySchema",
1911
+ "requestStructure": {
1912
+ "type": "upload_bulk_destroy_operation",
1913
+ "attributes": [],
1914
+ "relationships": [
1915
+ "uploads"
1916
+ ]
1917
+ },
1918
+ "queryParamsRequired": false,
1919
+ "responseType": "UploadBulkDestroyJobSchema",
667
1920
  "name": "bulkDestroy",
668
1921
  "rawName": "rawBulkDestroy"
669
1922
  }
@@ -675,8 +1928,22 @@
675
1928
  "jsonApiType": "upload_request",
676
1929
  "endpoints": [
677
1930
  {
678
- "rel": "create",
679
1931
  "returnsCollection": false,
1932
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-request/create",
1933
+ "rel": "create",
1934
+ "urlTemplate": "/upload-requests",
1935
+ "method": "POST",
1936
+ "comment": "Request a new upload",
1937
+ "requestBodyType": "UploadRequestCreateSchema",
1938
+ "requestStructure": {
1939
+ "type": "upload_request",
1940
+ "attributes": [
1941
+ "filename"
1942
+ ],
1943
+ "relationships": []
1944
+ },
1945
+ "queryParamsRequired": false,
1946
+ "responseType": "UploadRequestCreateTargetSchema",
680
1947
  "name": "create",
681
1948
  "rawName": "rawCreate"
682
1949
  }
@@ -688,14 +1955,44 @@
688
1955
  "jsonApiType": "scheduled_publication",
689
1956
  "endpoints": [
690
1957
  {
691
- "rel": "create",
692
1958
  "returnsCollection": false,
1959
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create",
1960
+ "rel": "create",
1961
+ "urlTemplate": "/items/${itemId}/scheduled-publication",
1962
+ "method": "POST",
1963
+ "comment": "Create a new scheduled publication",
1964
+ "urlPlaceholder": {
1965
+ "variableName": "itemId",
1966
+ "isEntityId": false,
1967
+ "relType": "ItemData"
1968
+ },
1969
+ "requestBodyType": "ScheduledPublicationCreateSchema",
1970
+ "requestStructure": {
1971
+ "type": "scheduled_publication",
1972
+ "attributes": [
1973
+ "publication_scheduled_at"
1974
+ ],
1975
+ "relationships": []
1976
+ },
1977
+ "queryParamsRequired": false,
1978
+ "responseType": "ScheduledPublicationCreateTargetSchema",
693
1979
  "name": "create",
694
1980
  "rawName": "rawCreate"
695
1981
  },
696
1982
  {
697
- "rel": "destroy",
698
1983
  "returnsCollection": false,
1984
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy",
1985
+ "rel": "destroy",
1986
+ "urlTemplate": "/items/${itemId}/scheduled-publication",
1987
+ "method": "DELETE",
1988
+ "comment": "Delete a scheduled publication",
1989
+ "urlPlaceholder": {
1990
+ "variableName": "itemId",
1991
+ "isEntityId": false,
1992
+ "relType": "ItemData"
1993
+ },
1994
+ "queryParamsRequired": false,
1995
+ "responseType": "ScheduledPublicationDestroyTargetSchema",
699
1996
  "name": "destroy",
700
1997
  "rawName": "rawDestroy"
701
1998
  }
@@ -707,14 +2004,44 @@
707
2004
  "jsonApiType": "scheduled_unpublishing",
708
2005
  "endpoints": [
709
2006
  {
710
- "rel": "create",
711
2007
  "returnsCollection": false,
2008
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create",
2009
+ "rel": "create",
2010
+ "urlTemplate": "/items/${itemId}/scheduled-unpublishing",
2011
+ "method": "POST",
2012
+ "comment": "Create a new scheduled unpublishing",
2013
+ "urlPlaceholder": {
2014
+ "variableName": "itemId",
2015
+ "isEntityId": false,
2016
+ "relType": "ItemData"
2017
+ },
2018
+ "requestBodyType": "ScheduledUnpublishingCreateSchema",
2019
+ "requestStructure": {
2020
+ "type": "scheduled_unpublishing",
2021
+ "attributes": [
2022
+ "unpublishing_scheduled_at"
2023
+ ],
2024
+ "relationships": []
2025
+ },
2026
+ "queryParamsRequired": false,
2027
+ "responseType": "ScheduledUnpublishingCreateTargetSchema",
712
2028
  "name": "create",
713
2029
  "rawName": "rawCreate"
714
2030
  },
715
2031
  {
716
- "rel": "destroy",
717
2032
  "returnsCollection": false,
2033
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy",
2034
+ "rel": "destroy",
2035
+ "urlTemplate": "/items/${itemId}/scheduled-unpublishing",
2036
+ "method": "DELETE",
2037
+ "comment": "Delete a scheduled unpublishing",
2038
+ "urlPlaceholder": {
2039
+ "variableName": "itemId",
2040
+ "isEntityId": false,
2041
+ "relType": "ItemData"
2042
+ },
2043
+ "queryParamsRequired": false,
2044
+ "responseType": "ScheduledUnpublishingDestroyTargetSchema",
718
2045
  "name": "destroy",
719
2046
  "rawName": "rawDestroy"
720
2047
  }
@@ -726,8 +2053,15 @@
726
2053
  "jsonApiType": "search_result",
727
2054
  "endpoints": [
728
2055
  {
729
- "rel": "instances",
730
2056
  "returnsCollection": true,
2057
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-result/instances",
2058
+ "rel": "instances",
2059
+ "urlTemplate": "/search-results",
2060
+ "method": "GET",
2061
+ "comment": "Search for results",
2062
+ "queryParamsType": "SearchResultInstancesHrefSchema",
2063
+ "queryParamsRequired": true,
2064
+ "responseType": "SearchResultInstancesTargetSchema",
731
2065
  "paginatedResponse": {
732
2066
  "defaultLimit": 20,
733
2067
  "maxLimit": 100
@@ -743,32 +2077,88 @@
743
2077
  "jsonApiType": "environment",
744
2078
  "endpoints": [
745
2079
  {
746
- "rel": "fork",
747
2080
  "returnsCollection": false,
2081
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/environment/fork",
2082
+ "rel": "fork",
2083
+ "urlTemplate": "/environments/${environmentId}/fork",
2084
+ "method": "POST",
2085
+ "comment": "Fork an existing environment",
2086
+ "urlPlaceholder": {
2087
+ "variableName": "environmentId",
2088
+ "isEntityId": true,
2089
+ "relType": "EnvironmentData"
2090
+ },
2091
+ "requestBodyType": "EnvironmentForkSchema",
2092
+ "requestStructure": {
2093
+ "type": "environment",
2094
+ "attributes": [],
2095
+ "relationships": []
2096
+ },
2097
+ "queryParamsRequired": false,
2098
+ "responseType": "EnvironmentForkJobSchema",
748
2099
  "name": "fork",
749
2100
  "rawName": "rawFork"
750
2101
  },
751
2102
  {
752
- "rel": "promote",
753
2103
  "returnsCollection": false,
2104
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/environment/promote",
2105
+ "rel": "promote",
2106
+ "urlTemplate": "/environments/${environmentId}/promote",
2107
+ "method": "PUT",
2108
+ "comment": "Promote an environment to primary",
2109
+ "urlPlaceholder": {
2110
+ "variableName": "environmentId",
2111
+ "isEntityId": true,
2112
+ "relType": "EnvironmentData"
2113
+ },
2114
+ "queryParamsRequired": false,
2115
+ "responseType": "EnvironmentPromoteTargetSchema",
754
2116
  "name": "promote",
755
2117
  "rawName": "rawPromote"
756
2118
  },
757
2119
  {
758
- "rel": "instances",
759
2120
  "returnsCollection": true,
2121
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/environment/instances",
2122
+ "rel": "instances",
2123
+ "urlTemplate": "/environments",
2124
+ "method": "GET",
2125
+ "comment": "List all environments",
2126
+ "queryParamsRequired": false,
2127
+ "responseType": "EnvironmentInstancesTargetSchema",
760
2128
  "name": "list",
761
2129
  "rawName": "rawList"
762
2130
  },
763
2131
  {
764
- "rel": "self",
765
2132
  "returnsCollection": false,
2133
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/environment/self",
2134
+ "rel": "self",
2135
+ "urlTemplate": "/environments/${environmentId}",
2136
+ "method": "GET",
2137
+ "comment": "Retrieve a environment",
2138
+ "urlPlaceholder": {
2139
+ "variableName": "environmentId",
2140
+ "isEntityId": true,
2141
+ "relType": "EnvironmentData"
2142
+ },
2143
+ "queryParamsRequired": false,
2144
+ "responseType": "EnvironmentSelfTargetSchema",
766
2145
  "name": "find",
767
2146
  "rawName": "rawFind"
768
2147
  },
769
2148
  {
770
- "rel": "destroy",
771
2149
  "returnsCollection": false,
2150
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/environment/destroy",
2151
+ "rel": "destroy",
2152
+ "urlTemplate": "/environments/${environmentId}",
2153
+ "method": "DELETE",
2154
+ "comment": "Delete a environment",
2155
+ "urlPlaceholder": {
2156
+ "variableName": "environmentId",
2157
+ "isEntityId": true,
2158
+ "relType": "EnvironmentData"
2159
+ },
2160
+ "queryParamsRequired": false,
2161
+ "responseType": "EnvironmentDestroyJobSchema",
772
2162
  "name": "destroy",
773
2163
  "rawName": "rawDestroy"
774
2164
  }
@@ -780,20 +2170,39 @@
780
2170
  "jsonApiType": "maintenance_mode",
781
2171
  "endpoints": [
782
2172
  {
783
- "rel": "self",
784
2173
  "returnsCollection": false,
2174
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self",
2175
+ "rel": "self",
2176
+ "urlTemplate": "/maintenance-mode",
2177
+ "method": "GET",
2178
+ "comment": "Retrieve maintenence mode",
2179
+ "queryParamsRequired": false,
2180
+ "responseType": "MaintenanceModeSelfTargetSchema",
785
2181
  "name": "find",
786
2182
  "rawName": "rawFind"
787
2183
  },
788
2184
  {
789
- "rel": "activate",
790
2185
  "returnsCollection": false,
2186
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate",
2187
+ "rel": "activate",
2188
+ "urlTemplate": "/maintenance-mode/activate",
2189
+ "method": "PUT",
2190
+ "comment": "Activate maintenance mode: this means that the primary environment will be read-only",
2191
+ "queryParamsType": "MaintenanceModeActivateHrefSchema",
2192
+ "queryParamsRequired": false,
2193
+ "responseType": "MaintenanceModeActivateTargetSchema",
791
2194
  "name": "activate",
792
2195
  "rawName": "rawActivate"
793
2196
  },
794
2197
  {
795
- "rel": "deactivate",
796
2198
  "returnsCollection": false,
2199
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate",
2200
+ "rel": "deactivate",
2201
+ "urlTemplate": "/maintenance-mode/deactivate",
2202
+ "method": "PUT",
2203
+ "comment": "De-activate maintenance mode",
2204
+ "queryParamsRequired": false,
2205
+ "responseType": "MaintenanceModeDeactivateTargetSchema",
797
2206
  "name": "deactivate",
798
2207
  "rawName": "rawDeactivate"
799
2208
  }
@@ -805,32 +2214,111 @@
805
2214
  "jsonApiType": "webhook",
806
2215
  "endpoints": [
807
2216
  {
808
- "rel": "create",
809
2217
  "returnsCollection": false,
2218
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/create",
2219
+ "rel": "create",
2220
+ "urlTemplate": "/webhooks",
2221
+ "method": "POST",
2222
+ "comment": "Create a new webhook",
2223
+ "requestBodyType": "WebhookCreateSchema",
2224
+ "requestStructure": {
2225
+ "type": "webhook",
2226
+ "attributes": [
2227
+ "name",
2228
+ "url",
2229
+ "custom_payload",
2230
+ "headers",
2231
+ "events",
2232
+ "http_basic_user",
2233
+ "http_basic_password",
2234
+ "enabled",
2235
+ "payload_api_version",
2236
+ "nested_items_in_payload"
2237
+ ],
2238
+ "relationships": []
2239
+ },
2240
+ "queryParamsRequired": false,
2241
+ "responseType": "WebhookCreateTargetSchema",
810
2242
  "name": "create",
811
2243
  "rawName": "rawCreate"
812
2244
  },
813
2245
  {
814
- "rel": "update",
815
2246
  "returnsCollection": false,
2247
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/update",
2248
+ "rel": "update",
2249
+ "urlTemplate": "/webhooks/${userId}",
2250
+ "method": "PUT",
2251
+ "comment": "Update a webhook",
2252
+ "urlPlaceholder": {
2253
+ "variableName": "userId",
2254
+ "isEntityId": false,
2255
+ "relType": "UserData"
2256
+ },
2257
+ "requestBodyType": "WebhookUpdateSchema",
2258
+ "requestStructure": {
2259
+ "type": "webhook",
2260
+ "attributes": [
2261
+ "name",
2262
+ "url",
2263
+ "custom_payload",
2264
+ "headers",
2265
+ "events",
2266
+ "http_basic_user",
2267
+ "http_basic_password",
2268
+ "enabled",
2269
+ "payload_api_version",
2270
+ "nested_items_in_payload"
2271
+ ],
2272
+ "relationships": []
2273
+ },
2274
+ "queryParamsRequired": false,
2275
+ "responseType": "WebhookUpdateTargetSchema",
816
2276
  "name": "update",
817
2277
  "rawName": "rawUpdate"
818
2278
  },
819
2279
  {
820
- "rel": "instances",
821
2280
  "returnsCollection": true,
2281
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/instances",
2282
+ "rel": "instances",
2283
+ "urlTemplate": "/webhooks",
2284
+ "method": "GET",
2285
+ "comment": "List all webhooks",
2286
+ "queryParamsRequired": false,
2287
+ "responseType": "WebhookInstancesTargetSchema",
822
2288
  "name": "list",
823
2289
  "rawName": "rawList"
824
2290
  },
825
2291
  {
826
- "rel": "self",
827
2292
  "returnsCollection": false,
2293
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/self",
2294
+ "rel": "self",
2295
+ "urlTemplate": "/webhooks/${userId}",
2296
+ "method": "GET",
2297
+ "comment": "Retrieve a webhook",
2298
+ "urlPlaceholder": {
2299
+ "variableName": "userId",
2300
+ "isEntityId": false,
2301
+ "relType": "UserData"
2302
+ },
2303
+ "queryParamsRequired": false,
2304
+ "responseType": "WebhookSelfTargetSchema",
828
2305
  "name": "find",
829
2306
  "rawName": "rawFind"
830
2307
  },
831
2308
  {
832
- "rel": "destroy",
833
2309
  "returnsCollection": false,
2310
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook/destroy",
2311
+ "rel": "destroy",
2312
+ "urlTemplate": "/webhooks/${userId}",
2313
+ "method": "DELETE",
2314
+ "comment": "Delete a webhook",
2315
+ "urlPlaceholder": {
2316
+ "variableName": "userId",
2317
+ "isEntityId": false,
2318
+ "relType": "UserData"
2319
+ },
2320
+ "queryParamsRequired": false,
2321
+ "responseType": "WebhookDestroyTargetSchema",
834
2322
  "name": "destroy",
835
2323
  "rawName": "rawDestroy"
836
2324
  }
@@ -842,8 +2330,15 @@
842
2330
  "jsonApiType": "webhook_call",
843
2331
  "endpoints": [
844
2332
  {
845
- "rel": "instances",
846
2333
  "returnsCollection": true,
2334
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances",
2335
+ "rel": "instances",
2336
+ "urlTemplate": "/webhook_calls",
2337
+ "method": "GET",
2338
+ "comment": "List all webhooks calls",
2339
+ "queryParamsType": "WebhookCallInstancesHrefSchema",
2340
+ "queryParamsRequired": false,
2341
+ "responseType": "WebhookCallInstancesTargetSchema",
847
2342
  "paginatedResponse": {
848
2343
  "defaultLimit": 30,
849
2344
  "maxLimit": 500
@@ -852,8 +2347,18 @@
852
2347
  "rawName": "rawList"
853
2348
  },
854
2349
  {
855
- "rel": "resend_webhook",
856
2350
  "returnsCollection": false,
2351
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook",
2352
+ "rel": "resend_webhook",
2353
+ "urlTemplate": "/webhook_calls/${userId}/resend_webhook",
2354
+ "method": "POST",
2355
+ "comment": "Re-send the webhook call",
2356
+ "urlPlaceholder": {
2357
+ "variableName": "userId",
2358
+ "isEntityId": false,
2359
+ "relType": "UserData"
2360
+ },
2361
+ "queryParamsRequired": false,
857
2362
  "name": "resendWebhook",
858
2363
  "rawName": "rawResendWebhook"
859
2364
  }
@@ -865,56 +2370,168 @@
865
2370
  "jsonApiType": "build_trigger",
866
2371
  "endpoints": [
867
2372
  {
868
- "rel": "instances",
869
2373
  "returnsCollection": true,
2374
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances",
2375
+ "rel": "instances",
2376
+ "urlTemplate": "/build-triggers",
2377
+ "method": "GET",
2378
+ "comment": "List all build triggers for a site",
2379
+ "queryParamsRequired": false,
2380
+ "responseType": "BuildTriggerInstancesTargetSchema",
870
2381
  "name": "list",
871
2382
  "rawName": "rawList"
872
2383
  },
873
2384
  {
874
- "rel": "self",
875
2385
  "returnsCollection": false,
2386
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/self",
2387
+ "rel": "self",
2388
+ "urlTemplate": "/build-triggers/${buildTriggerId}",
2389
+ "method": "GET",
2390
+ "comment": "Retrieve a build trigger",
2391
+ "urlPlaceholder": {
2392
+ "variableName": "buildTriggerId",
2393
+ "isEntityId": true,
2394
+ "relType": "BuildTriggerData"
2395
+ },
2396
+ "queryParamsRequired": false,
2397
+ "responseType": "BuildTriggerSelfTargetSchema",
876
2398
  "name": "find",
877
2399
  "rawName": "rawFind"
878
2400
  },
879
2401
  {
880
- "rel": "create",
881
2402
  "returnsCollection": false,
2403
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/create",
2404
+ "rel": "create",
2405
+ "urlTemplate": "/build-triggers",
2406
+ "method": "POST",
2407
+ "comment": "Create build trigger",
2408
+ "requestBodyType": "BuildTriggerCreateSchema",
2409
+ "requestStructure": {
2410
+ "type": "build_trigger",
2411
+ "attributes": [
2412
+ "name",
2413
+ "webhook_token",
2414
+ "adapter",
2415
+ "indexing_enabled",
2416
+ "frontend_url",
2417
+ "autotrigger_on_scheduled_publications",
2418
+ "adapter_settings"
2419
+ ],
2420
+ "relationships": []
2421
+ },
2422
+ "queryParamsRequired": false,
2423
+ "responseType": "BuildTriggerCreateTargetSchema",
882
2424
  "name": "create",
883
2425
  "rawName": "rawCreate"
884
2426
  },
885
2427
  {
886
- "rel": "update",
887
2428
  "returnsCollection": false,
2429
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/update",
2430
+ "rel": "update",
2431
+ "urlTemplate": "/build-triggers/${buildTriggerId}",
2432
+ "method": "PUT",
2433
+ "comment": "Update build trigger",
2434
+ "urlPlaceholder": {
2435
+ "variableName": "buildTriggerId",
2436
+ "isEntityId": true,
2437
+ "relType": "BuildTriggerData"
2438
+ },
2439
+ "requestBodyType": "BuildTriggerUpdateSchema",
2440
+ "requestStructure": {
2441
+ "type": "build_trigger",
2442
+ "attributes": [
2443
+ "name",
2444
+ "adapter",
2445
+ "indexing_enabled",
2446
+ "frontend_url",
2447
+ "autotrigger_on_scheduled_publications",
2448
+ "adapter_settings"
2449
+ ],
2450
+ "relationships": []
2451
+ },
2452
+ "queryParamsRequired": false,
2453
+ "responseType": "BuildTriggerUpdateTargetSchema",
888
2454
  "name": "update",
889
2455
  "rawName": "rawUpdate"
890
2456
  },
891
2457
  {
892
- "rel": "trigger",
893
2458
  "returnsCollection": false,
2459
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger",
2460
+ "rel": "trigger",
2461
+ "urlTemplate": "/build-triggers/${buildTriggerId}/trigger",
2462
+ "method": "POST",
2463
+ "comment": "Trigger a deploy",
2464
+ "urlPlaceholder": {
2465
+ "variableName": "buildTriggerId",
2466
+ "isEntityId": true,
2467
+ "relType": "BuildTriggerData"
2468
+ },
2469
+ "queryParamsRequired": false,
894
2470
  "name": "trigger",
895
2471
  "rawName": "rawTrigger"
896
2472
  },
897
2473
  {
898
- "rel": "abort",
899
2474
  "returnsCollection": false,
2475
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort",
2476
+ "rel": "abort",
2477
+ "urlTemplate": "/build-triggers/${buildTriggerId}/abort",
2478
+ "method": "DELETE",
2479
+ "comment": "Abort a deploy and mark it as failed",
2480
+ "urlPlaceholder": {
2481
+ "variableName": "buildTriggerId",
2482
+ "isEntityId": true,
2483
+ "relType": "BuildTriggerData"
2484
+ },
2485
+ "queryParamsRequired": false,
900
2486
  "name": "abort",
901
2487
  "rawName": "rawAbort"
902
2488
  },
903
2489
  {
904
- "rel": "abort_indexing",
905
2490
  "returnsCollection": false,
2491
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing",
2492
+ "rel": "abort_indexing",
2493
+ "urlTemplate": "/build-triggers/${buildTriggerId}/abort_indexing",
2494
+ "method": "DELETE",
2495
+ "comment": "Abort a site search spidering and mark it as failed",
2496
+ "urlPlaceholder": {
2497
+ "variableName": "buildTriggerId",
2498
+ "isEntityId": true,
2499
+ "relType": "BuildTriggerData"
2500
+ },
2501
+ "queryParamsRequired": false,
906
2502
  "name": "abortIndexing",
907
2503
  "rawName": "rawAbortIndexing"
908
2504
  },
909
2505
  {
910
- "rel": "reindex",
911
2506
  "returnsCollection": false,
2507
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex",
2508
+ "rel": "reindex",
2509
+ "urlTemplate": "/build-triggers/${buildTriggerId}/reindex",
2510
+ "method": "PUT",
2511
+ "comment": "Trigger a new site search spidering of the website",
2512
+ "urlPlaceholder": {
2513
+ "variableName": "buildTriggerId",
2514
+ "isEntityId": true,
2515
+ "relType": "BuildTriggerData"
2516
+ },
2517
+ "queryParamsRequired": false,
912
2518
  "name": "reindex",
913
2519
  "rawName": "rawReindex"
914
2520
  },
915
2521
  {
916
- "rel": "destroy",
917
2522
  "returnsCollection": false,
2523
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy",
2524
+ "rel": "destroy",
2525
+ "urlTemplate": "/build-triggers/${buildTriggerId}",
2526
+ "method": "DELETE",
2527
+ "comment": "Delete a build trigger",
2528
+ "urlPlaceholder": {
2529
+ "variableName": "buildTriggerId",
2530
+ "isEntityId": true,
2531
+ "relType": "BuildTriggerData"
2532
+ },
2533
+ "queryParamsRequired": false,
2534
+ "responseType": "BuildTriggerDestroyTargetSchema",
918
2535
  "name": "destroy",
919
2536
  "rawName": "rawDestroy"
920
2537
  }
@@ -926,32 +2543,105 @@
926
2543
  "jsonApiType": "item_type_filter",
927
2544
  "endpoints": [
928
2545
  {
929
- "rel": "create",
930
2546
  "returnsCollection": false,
2547
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type_filter/create",
2548
+ "rel": "create",
2549
+ "urlTemplate": "/item-type-filters",
2550
+ "method": "POST",
2551
+ "comment": "Create a new filter",
2552
+ "requestBodyType": "ItemTypeFilterCreateSchema",
2553
+ "requestStructure": {
2554
+ "type": "item_type_filter",
2555
+ "attributes": [
2556
+ "name",
2557
+ "filter",
2558
+ "columns",
2559
+ "order_by",
2560
+ "shared"
2561
+ ],
2562
+ "relationships": [
2563
+ "item_type"
2564
+ ]
2565
+ },
2566
+ "queryParamsRequired": false,
2567
+ "responseType": "ItemTypeFilterCreateTargetSchema",
931
2568
  "name": "create",
932
2569
  "rawName": "rawCreate"
933
2570
  },
934
2571
  {
935
- "rel": "update",
936
2572
  "returnsCollection": false,
2573
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type_filter/update",
2574
+ "rel": "update",
2575
+ "urlTemplate": "/item-type-filters/${itemTypeFilterId}",
2576
+ "method": "PUT",
2577
+ "comment": "Update a filter",
2578
+ "urlPlaceholder": {
2579
+ "variableName": "itemTypeFilterId",
2580
+ "isEntityId": true,
2581
+ "relType": "ItemTypeFilterData"
2582
+ },
2583
+ "requestBodyType": "ItemTypeFilterUpdateSchema",
2584
+ "requestStructure": {
2585
+ "type": "item_type_filter",
2586
+ "attributes": [
2587
+ "name",
2588
+ "columns",
2589
+ "order_by",
2590
+ "shared",
2591
+ "filter"
2592
+ ],
2593
+ "relationships": [
2594
+ "item_type"
2595
+ ]
2596
+ },
2597
+ "queryParamsRequired": false,
2598
+ "responseType": "ItemTypeFilterUpdateTargetSchema",
937
2599
  "name": "update",
938
2600
  "rawName": "rawUpdate"
939
2601
  },
940
2602
  {
941
- "rel": "instances",
942
2603
  "returnsCollection": true,
2604
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type_filter/instances",
2605
+ "rel": "instances",
2606
+ "urlTemplate": "/item-type-filters",
2607
+ "method": "GET",
2608
+ "comment": "List all filters",
2609
+ "queryParamsRequired": false,
2610
+ "responseType": "ItemTypeFilterInstancesTargetSchema",
943
2611
  "name": "list",
944
2612
  "rawName": "rawList"
945
2613
  },
946
2614
  {
947
- "rel": "self",
948
2615
  "returnsCollection": false,
2616
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type_filter/self",
2617
+ "rel": "self",
2618
+ "urlTemplate": "/item-type-filters/${itemTypeFilterId}",
2619
+ "method": "GET",
2620
+ "comment": "Retrieve a filter",
2621
+ "urlPlaceholder": {
2622
+ "variableName": "itemTypeFilterId",
2623
+ "isEntityId": true,
2624
+ "relType": "ItemTypeFilterData"
2625
+ },
2626
+ "queryParamsRequired": false,
2627
+ "responseType": "ItemTypeFilterSelfTargetSchema",
949
2628
  "name": "find",
950
2629
  "rawName": "rawFind"
951
2630
  },
952
2631
  {
953
- "rel": "destroy",
954
2632
  "returnsCollection": false,
2633
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type_filter/destroy",
2634
+ "rel": "destroy",
2635
+ "urlTemplate": "/item-type-filters/${itemTypeFilterId}",
2636
+ "method": "DELETE",
2637
+ "comment": "Delete a filter",
2638
+ "urlPlaceholder": {
2639
+ "variableName": "itemTypeFilterId",
2640
+ "isEntityId": true,
2641
+ "relType": "ItemTypeFilterData"
2642
+ },
2643
+ "queryParamsRequired": false,
2644
+ "responseType": "ItemTypeFilterDestroyTargetSchema",
955
2645
  "name": "destroy",
956
2646
  "rawName": "rawDestroy"
957
2647
  }
@@ -963,32 +2653,97 @@
963
2653
  "jsonApiType": "upload_filter",
964
2654
  "endpoints": [
965
2655
  {
966
- "rel": "create",
967
2656
  "returnsCollection": false,
2657
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-filter/create",
2658
+ "rel": "create",
2659
+ "urlTemplate": "/upload-filters",
2660
+ "method": "POST",
2661
+ "comment": "Create a new filter",
2662
+ "requestBodyType": "UploadFilterCreateSchema",
2663
+ "requestStructure": {
2664
+ "type": "upload_filter",
2665
+ "attributes": [
2666
+ "name",
2667
+ "filter",
2668
+ "shared"
2669
+ ],
2670
+ "relationships": []
2671
+ },
2672
+ "queryParamsRequired": false,
2673
+ "responseType": "UploadFilterCreateTargetSchema",
968
2674
  "name": "create",
969
2675
  "rawName": "rawCreate"
970
2676
  },
971
2677
  {
972
- "rel": "update",
973
2678
  "returnsCollection": false,
2679
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-filter/update",
2680
+ "rel": "update",
2681
+ "urlTemplate": "/upload-filters/${uploadFilterId}",
2682
+ "method": "PUT",
2683
+ "comment": "Update a filter",
2684
+ "urlPlaceholder": {
2685
+ "variableName": "uploadFilterId",
2686
+ "isEntityId": true,
2687
+ "relType": "UploadFilterData"
2688
+ },
2689
+ "requestBodyType": "UploadFilterUpdateSchema",
2690
+ "requestStructure": {
2691
+ "type": "upload_filter",
2692
+ "attributes": [
2693
+ "name",
2694
+ "shared",
2695
+ "filter"
2696
+ ],
2697
+ "relationships": []
2698
+ },
2699
+ "queryParamsRequired": false,
2700
+ "responseType": "UploadFilterUpdateTargetSchema",
974
2701
  "name": "update",
975
2702
  "rawName": "rawUpdate"
976
2703
  },
977
2704
  {
978
- "rel": "instances",
979
2705
  "returnsCollection": true,
2706
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances",
2707
+ "rel": "instances",
2708
+ "urlTemplate": "/upload-filters",
2709
+ "method": "GET",
2710
+ "comment": "List all filters",
2711
+ "queryParamsRequired": false,
2712
+ "responseType": "UploadFilterInstancesTargetSchema",
980
2713
  "name": "list",
981
2714
  "rawName": "rawList"
982
2715
  },
983
2716
  {
984
- "rel": "self",
985
2717
  "returnsCollection": false,
2718
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-filter/self",
2719
+ "rel": "self",
2720
+ "urlTemplate": "/upload-filters/${uploadFilterId}",
2721
+ "method": "GET",
2722
+ "comment": "Retrieve a filter",
2723
+ "urlPlaceholder": {
2724
+ "variableName": "uploadFilterId",
2725
+ "isEntityId": true,
2726
+ "relType": "UploadFilterData"
2727
+ },
2728
+ "queryParamsRequired": false,
2729
+ "responseType": "UploadFilterSelfTargetSchema",
986
2730
  "name": "find",
987
2731
  "rawName": "rawFind"
988
2732
  },
989
2733
  {
990
- "rel": "destroy",
991
2734
  "returnsCollection": false,
2735
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy",
2736
+ "rel": "destroy",
2737
+ "urlTemplate": "/upload-filters/${uploadFilterId}",
2738
+ "method": "DELETE",
2739
+ "comment": "Delete a filter",
2740
+ "urlPlaceholder": {
2741
+ "variableName": "uploadFilterId",
2742
+ "isEntityId": true,
2743
+ "relType": "UploadFilterData"
2744
+ },
2745
+ "queryParamsRequired": false,
2746
+ "responseType": "UploadFilterDestroyTargetSchema",
992
2747
  "name": "destroy",
993
2748
  "rawName": "rawDestroy"
994
2749
  }
@@ -1000,38 +2755,111 @@
1000
2755
  "jsonApiType": "site_invitation",
1001
2756
  "endpoints": [
1002
2757
  {
1003
- "rel": "create",
1004
2758
  "returnsCollection": false,
2759
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/create",
2760
+ "rel": "create",
2761
+ "urlTemplate": "/site-invitations",
2762
+ "method": "POST",
2763
+ "comment": "Invite a new user",
2764
+ "requestBodyType": "SiteInvitationCreateSchema",
2765
+ "requestStructure": {
2766
+ "type": "site_invitation",
2767
+ "attributes": [
2768
+ "email"
2769
+ ],
2770
+ "relationships": [
2771
+ "role"
2772
+ ]
2773
+ },
2774
+ "queryParamsRequired": false,
2775
+ "responseType": "SiteInvitationCreateTargetSchema",
1005
2776
  "name": "create",
1006
2777
  "rawName": "rawCreate"
1007
2778
  },
1008
2779
  {
1009
- "rel": "update",
1010
2780
  "returnsCollection": false,
2781
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/update",
2782
+ "rel": "update",
2783
+ "urlTemplate": "/site-invitations/${siteInvitationId}",
2784
+ "method": "PUT",
2785
+ "comment": "Update an invitation",
2786
+ "urlPlaceholder": {
2787
+ "variableName": "siteInvitationId",
2788
+ "isEntityId": true,
2789
+ "relType": "SiteInvitationData"
2790
+ },
2791
+ "requestBodyType": "SiteInvitationUpdateSchema",
2792
+ "requestStructure": {
2793
+ "type": "site_invitation",
2794
+ "attributes": [],
2795
+ "relationships": [
2796
+ "role"
2797
+ ]
2798
+ },
2799
+ "queryParamsRequired": false,
2800
+ "responseType": "SiteInvitationUpdateTargetSchema",
1011
2801
  "name": "update",
1012
2802
  "rawName": "rawUpdate"
1013
2803
  },
1014
2804
  {
1015
- "rel": "instances",
1016
2805
  "returnsCollection": true,
2806
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances",
2807
+ "rel": "instances",
2808
+ "urlTemplate": "/site-invitations",
2809
+ "method": "GET",
2810
+ "comment": "List all invitations",
2811
+ "queryParamsRequired": false,
2812
+ "responseType": "SiteInvitationInstancesTargetSchema",
1017
2813
  "name": "list",
1018
2814
  "rawName": "rawList"
1019
2815
  },
1020
2816
  {
1021
- "rel": "self",
1022
2817
  "returnsCollection": false,
2818
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/self",
2819
+ "rel": "self",
2820
+ "urlTemplate": "/site-invitations/${siteInvitationId}",
2821
+ "method": "GET",
2822
+ "comment": "Retrieve an invitation",
2823
+ "urlPlaceholder": {
2824
+ "variableName": "siteInvitationId",
2825
+ "isEntityId": true,
2826
+ "relType": "SiteInvitationData"
2827
+ },
2828
+ "queryParamsRequired": false,
2829
+ "responseType": "SiteInvitationSelfTargetSchema",
1023
2830
  "name": "find",
1024
2831
  "rawName": "rawFind"
1025
2832
  },
1026
2833
  {
1027
- "rel": "destroy",
1028
2834
  "returnsCollection": false,
2835
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy",
2836
+ "rel": "destroy",
2837
+ "urlTemplate": "/site-invitations/${siteInvitationId}",
2838
+ "method": "DELETE",
2839
+ "comment": "Delete an invitation",
2840
+ "urlPlaceholder": {
2841
+ "variableName": "siteInvitationId",
2842
+ "isEntityId": true,
2843
+ "relType": "SiteInvitationData"
2844
+ },
2845
+ "queryParamsRequired": false,
2846
+ "responseType": "SiteInvitationDestroyTargetSchema",
1029
2847
  "name": "destroy",
1030
2848
  "rawName": "rawDestroy"
1031
2849
  },
1032
2850
  {
1033
- "rel": "resend",
1034
2851
  "returnsCollection": false,
2852
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend",
2853
+ "rel": "resend",
2854
+ "urlTemplate": "/site-invitations/${siteInvitationId}/resend",
2855
+ "method": "POST",
2856
+ "comment": "Resend an invitation",
2857
+ "urlPlaceholder": {
2858
+ "variableName": "siteInvitationId",
2859
+ "isEntityId": true,
2860
+ "relType": "SiteInvitationData"
2861
+ },
2862
+ "queryParamsRequired": false,
1035
2863
  "name": "resend",
1036
2864
  "rawName": "rawResend"
1037
2865
  }
@@ -1043,19 +2871,60 @@
1043
2871
  "jsonApiType": "editing_session",
1044
2872
  "endpoints": [
1045
2873
  {
1046
- "rel": "instances",
1047
2874
  "returnsCollection": true,
2875
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/editing-session/instances",
2876
+ "rel": "instances",
2877
+ "urlTemplate": "/editing-sessions",
2878
+ "method": "GET",
2879
+ "comment": "List all editing sessions",
2880
+ "queryParamsRequired": false,
2881
+ "responseType": "EditingSessionInstancesTargetSchema",
2882
+ "deprecated": "This API call is to be considered private and might change without notice",
1048
2883
  "name": "list",
1049
2884
  "rawName": "rawList"
1050
2885
  },
1051
2886
  {
1052
- "rel": "update",
1053
2887
  "returnsCollection": false,
2888
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/editing-session/update",
2889
+ "rel": "update",
2890
+ "urlTemplate": "/editing-sessions/${editingSessionId}",
2891
+ "method": "PUT",
2892
+ "comment": "Allows all actions on editing sessions",
2893
+ "urlPlaceholder": {
2894
+ "variableName": "editingSessionId",
2895
+ "isEntityId": true,
2896
+ "relType": "EditingSessionData"
2897
+ },
2898
+ "requestBodyType": "EditingSessionUpdateSchema",
2899
+ "requestStructure": {
2900
+ "type": "*",
2901
+ "attributes": [],
2902
+ "relationships": [
2903
+ "item",
2904
+ "item",
2905
+ "item"
2906
+ ]
2907
+ },
2908
+ "queryParamsRequired": false,
2909
+ "responseType": "EditingSessionUpdateTargetSchema",
2910
+ "deprecated": "This API call is to be considered private and might change without notice",
1054
2911
  "rawName": "rawUpdate"
1055
2912
  },
1056
2913
  {
1057
- "rel": "destroy",
1058
2914
  "returnsCollection": false,
2915
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy",
2916
+ "rel": "destroy",
2917
+ "urlTemplate": "/editing-sessions/${editingSessionId}",
2918
+ "method": "DELETE",
2919
+ "comment": "Delete an editing session",
2920
+ "urlPlaceholder": {
2921
+ "variableName": "editingSessionId",
2922
+ "isEntityId": true,
2923
+ "relType": "EditingSessionData"
2924
+ },
2925
+ "queryParamsRequired": false,
2926
+ "responseType": "EditingSessionDestroyTargetSchema",
2927
+ "deprecated": "This API call is to be considered private and might change without notice",
1059
2928
  "name": "destroy",
1060
2929
  "rawName": "rawDestroy"
1061
2930
  }
@@ -1067,26 +2936,75 @@
1067
2936
  "jsonApiType": "sso_group",
1068
2937
  "endpoints": [
1069
2938
  {
1070
- "rel": "instances",
1071
2939
  "returnsCollection": true,
2940
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-group/instances",
2941
+ "rel": "instances",
2942
+ "urlTemplate": "/sso-groups",
2943
+ "method": "GET",
2944
+ "comment": "List all SSO groups",
2945
+ "queryParamsRequired": false,
2946
+ "responseType": "SsoGroupInstancesTargetSchema",
1072
2947
  "name": "list",
1073
2948
  "rawName": "rawList"
1074
2949
  },
1075
2950
  {
1076
- "rel": "copy_roles",
1077
2951
  "returnsCollection": false,
2952
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles",
2953
+ "rel": "copy_roles",
2954
+ "urlTemplate": "/sso-groups/${ssoGroupId}/copy-roles",
2955
+ "method": "POST",
2956
+ "comment": "Sync SSO provider groups to DatoCMS roles",
2957
+ "urlPlaceholder": {
2958
+ "variableName": "ssoGroupId",
2959
+ "isEntityId": true,
2960
+ "relType": "SsoGroupData"
2961
+ },
2962
+ "queryParamsRequired": false,
2963
+ "responseType": "SsoGroupCopyRolesTargetSchema",
1078
2964
  "name": "copyRoles",
1079
2965
  "rawName": "rawCopyRoles"
1080
2966
  },
1081
2967
  {
1082
- "rel": "update",
1083
2968
  "returnsCollection": false,
2969
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-group/update",
2970
+ "rel": "update",
2971
+ "urlTemplate": "/sso-groups/${ssoGroupId}",
2972
+ "method": "PUT",
2973
+ "comment": "Update a SSO group",
2974
+ "urlPlaceholder": {
2975
+ "variableName": "ssoGroupId",
2976
+ "isEntityId": true,
2977
+ "relType": "SsoGroupData"
2978
+ },
2979
+ "requestBodyType": "SsoGroupUpdateSchema",
2980
+ "requestStructure": {
2981
+ "type": "sso_group",
2982
+ "attributes": [
2983
+ "priority"
2984
+ ],
2985
+ "relationships": [
2986
+ "role"
2987
+ ]
2988
+ },
2989
+ "queryParamsRequired": false,
2990
+ "responseType": "SsoGroupUpdateTargetSchema",
1084
2991
  "name": "update",
1085
2992
  "rawName": "rawUpdate"
1086
2993
  },
1087
2994
  {
1088
- "rel": "destroy",
1089
2995
  "returnsCollection": false,
2996
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy",
2997
+ "rel": "destroy",
2998
+ "urlTemplate": "/sso-groups/${ssoGroupId}",
2999
+ "method": "DELETE",
3000
+ "comment": "Delete a group",
3001
+ "urlPlaceholder": {
3002
+ "variableName": "ssoGroupId",
3003
+ "isEntityId": true,
3004
+ "relType": "SsoGroupData"
3005
+ },
3006
+ "queryParamsRequired": false,
3007
+ "responseType": "SsoGroupDestroyTargetSchema",
1090
3008
  "name": "destroy",
1091
3009
  "rawName": "rawDestroy"
1092
3010
  }
@@ -1098,20 +3016,48 @@
1098
3016
  "jsonApiType": "sso_settings",
1099
3017
  "endpoints": [
1100
3018
  {
1101
- "rel": "self",
1102
3019
  "returnsCollection": false,
3020
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-settings/self",
3021
+ "rel": "self",
3022
+ "urlTemplate": "/sso-settings",
3023
+ "method": "GET",
3024
+ "comment": "Retrieve SSO Settings",
3025
+ "queryParamsRequired": false,
3026
+ "responseType": "SsoSettingsSelfTargetSchema",
1103
3027
  "name": "find",
1104
3028
  "rawName": "rawFind"
1105
3029
  },
1106
3030
  {
1107
- "rel": "generate_token",
1108
3031
  "returnsCollection": false,
3032
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token",
3033
+ "rel": "generate_token",
3034
+ "urlTemplate": "/sso-settings/generate-token",
3035
+ "method": "PUT",
3036
+ "comment": "Generate SSO token",
3037
+ "queryParamsRequired": false,
3038
+ "responseType": "SsoSettingsGenerateTokenTargetSchema",
1109
3039
  "name": "generateToken",
1110
3040
  "rawName": "rawGenerateToken"
1111
3041
  },
1112
3042
  {
1113
- "rel": "update",
1114
3043
  "returnsCollection": false,
3044
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-settings/update",
3045
+ "rel": "update",
3046
+ "urlTemplate": "/sso-settings",
3047
+ "method": "PUT",
3048
+ "comment": "Update SSO Settings",
3049
+ "requestBodyType": "SsoSettingsUpdateSchema",
3050
+ "requestStructure": {
3051
+ "type": "sso_settings",
3052
+ "attributes": [
3053
+ "idp_saml_metadata_url"
3054
+ ],
3055
+ "relationships": [
3056
+ "default_role"
3057
+ ]
3058
+ },
3059
+ "queryParamsRequired": false,
3060
+ "responseType": "SsoSettingsUpdateTargetSchema",
1115
3061
  "name": "update",
1116
3062
  "rawName": "rawUpdate"
1117
3063
  }
@@ -1123,14 +3069,34 @@
1123
3069
  "jsonApiType": "white_label_settings",
1124
3070
  "endpoints": [
1125
3071
  {
1126
- "rel": "self",
1127
3072
  "returnsCollection": false,
3073
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self",
3074
+ "rel": "self",
3075
+ "urlTemplate": "/white-label-settings",
3076
+ "method": "GET",
3077
+ "comment": "Retrieve white-label settings",
3078
+ "queryParamsRequired": false,
3079
+ "responseType": "WhiteLabelSettingsSelfTargetSchema",
1128
3080
  "name": "find",
1129
3081
  "rawName": "rawFind"
1130
3082
  },
1131
3083
  {
1132
- "rel": "update",
1133
3084
  "returnsCollection": false,
3085
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update",
3086
+ "rel": "update",
3087
+ "urlTemplate": "/white-label-settings",
3088
+ "method": "PUT",
3089
+ "comment": "Update white-label settings",
3090
+ "requestBodyType": "WhiteLabelSettingsUpdateSchema",
3091
+ "requestStructure": {
3092
+ "type": "white_label_settings",
3093
+ "attributes": [
3094
+ "custom_i18n_messages_template_url"
3095
+ ],
3096
+ "relationships": []
3097
+ },
3098
+ "queryParamsRequired": false,
3099
+ "responseType": "WhiteLabelSettingsUpdateTargetSchema",
1134
3100
  "name": "update",
1135
3101
  "rawName": "rawUpdate"
1136
3102
  }
@@ -1142,8 +3108,14 @@
1142
3108
  "jsonApiType": "public_info",
1143
3109
  "endpoints": [
1144
3110
  {
1145
- "rel": "self",
1146
3111
  "returnsCollection": false,
3112
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/public-info/self",
3113
+ "rel": "self",
3114
+ "urlTemplate": "/public-info",
3115
+ "method": "GET",
3116
+ "comment": "Retrieve public site info",
3117
+ "queryParamsRequired": false,
3118
+ "responseType": "PublicInfoSelfTargetSchema",
1147
3119
  "name": "find",
1148
3120
  "rawName": "rawFind"
1149
3121
  }
@@ -1155,8 +3127,14 @@
1155
3127
  "jsonApiType": "daily_usage",
1156
3128
  "endpoints": [
1157
3129
  {
1158
- "rel": "instances",
1159
3130
  "returnsCollection": true,
3131
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances",
3132
+ "rel": "instances",
3133
+ "urlTemplate": "/daily-site-usages",
3134
+ "method": "GET",
3135
+ "comment": "Retrieve project's daily usage info",
3136
+ "queryParamsRequired": false,
3137
+ "responseType": "DailyUsageInstancesTargetSchema",
1160
3138
  "name": "list",
1161
3139
  "rawName": "rawList"
1162
3140
  }
@@ -1168,8 +3146,20 @@
1168
3146
  "jsonApiType": "usage_counter",
1169
3147
  "endpoints": [
1170
3148
  {
1171
- "rel": "self",
1172
3149
  "returnsCollection": false,
3150
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/usage-counter/self",
3151
+ "rel": "self",
3152
+ "urlTemplate": "/usage-log-counters/${usageCounterId}",
3153
+ "method": "GET",
3154
+ "comment": "Retrieve a project's usage counter",
3155
+ "urlPlaceholder": {
3156
+ "variableName": "usageCounterId",
3157
+ "isEntityId": true,
3158
+ "relType": "UsageCounterData"
3159
+ },
3160
+ "queryParamsType": "UsageCounterSelfHrefSchema",
3161
+ "queryParamsRequired": false,
3162
+ "responseType": "UsageCounterSelfTargetSchema",
1173
3163
  "name": "find",
1174
3164
  "rawName": "rawFind"
1175
3165
  }
@@ -1181,8 +3171,15 @@
1181
3171
  "jsonApiType": "upload_tag",
1182
3172
  "endpoints": [
1183
3173
  {
1184
- "rel": "instances",
1185
3174
  "returnsCollection": true,
3175
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances",
3176
+ "rel": "instances",
3177
+ "urlTemplate": "/upload-tags",
3178
+ "method": "GET",
3179
+ "comment": "List all manually created upload tags",
3180
+ "queryParamsType": "UploadTagInstancesHrefSchema",
3181
+ "queryParamsRequired": false,
3182
+ "responseType": "UploadTagInstancesTargetSchema",
1186
3183
  "paginatedResponse": {
1187
3184
  "defaultLimit": 50,
1188
3185
  "maxLimit": 500
@@ -1191,8 +3188,22 @@
1191
3188
  "rawName": "rawList"
1192
3189
  },
1193
3190
  {
1194
- "rel": "create",
1195
3191
  "returnsCollection": false,
3192
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-tag/create",
3193
+ "rel": "create",
3194
+ "urlTemplate": "/upload-tags",
3195
+ "method": "POST",
3196
+ "comment": "Create a new upload tag",
3197
+ "requestBodyType": "UploadTagCreateSchema",
3198
+ "requestStructure": {
3199
+ "type": "upload_tag",
3200
+ "attributes": [
3201
+ "name"
3202
+ ],
3203
+ "relationships": []
3204
+ },
3205
+ "queryParamsRequired": false,
3206
+ "responseType": "UploadTagCreateTargetSchema",
1196
3207
  "name": "create",
1197
3208
  "rawName": "rawCreate"
1198
3209
  }
@@ -1204,8 +3215,15 @@
1204
3215
  "jsonApiType": "upload_smart_tag",
1205
3216
  "endpoints": [
1206
3217
  {
1207
- "rel": "instances",
1208
3218
  "returnsCollection": true,
3219
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances",
3220
+ "rel": "instances",
3221
+ "urlTemplate": "/upload-smart-tags",
3222
+ "method": "GET",
3223
+ "comment": "List all automatically created upload tags",
3224
+ "queryParamsType": "UploadSmartTagInstancesHrefSchema",
3225
+ "queryParamsRequired": false,
3226
+ "responseType": "UploadSmartTagInstancesTargetSchema",
1209
3227
  "paginatedResponse": {
1210
3228
  "defaultLimit": 50,
1211
3229
  "maxLimit": 500
@@ -1221,20 +3239,57 @@
1221
3239
  "jsonApiType": "site",
1222
3240
  "endpoints": [
1223
3241
  {
1224
- "rel": "self",
1225
3242
  "returnsCollection": false,
3243
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site/self",
3244
+ "rel": "self",
3245
+ "urlTemplate": "/site",
3246
+ "method": "GET",
3247
+ "comment": "Retrieve the site",
3248
+ "queryParamsType": "SiteSelfHrefSchema",
3249
+ "queryParamsRequired": false,
3250
+ "responseType": "SiteSelfTargetSchema",
1226
3251
  "name": "find",
1227
3252
  "rawName": "rawFind"
1228
3253
  },
1229
3254
  {
1230
- "rel": "update",
1231
3255
  "returnsCollection": false,
3256
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site/update",
3257
+ "rel": "update",
3258
+ "urlTemplate": "/site",
3259
+ "method": "PUT",
3260
+ "comment": "Update the site's settings",
3261
+ "requestBodyType": "SiteUpdateSchema",
3262
+ "requestStructure": {
3263
+ "type": "site",
3264
+ "attributes": [
3265
+ "no_index",
3266
+ "favicon",
3267
+ "global_seo",
3268
+ "name",
3269
+ "theme",
3270
+ "locales",
3271
+ "timezone",
3272
+ "require_2fa",
3273
+ "ip_tracking_enabled"
3274
+ ],
3275
+ "relationships": [
3276
+ "sso_default_role"
3277
+ ]
3278
+ },
3279
+ "queryParamsRequired": false,
3280
+ "responseType": "SiteUpdateJobSchema",
1232
3281
  "name": "update",
1233
3282
  "rawName": "rawUpdate"
1234
3283
  },
1235
3284
  {
1236
- "rel": "activate_improved_timezone_management",
1237
3285
  "returnsCollection": false,
3286
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management",
3287
+ "rel": "activate_improved_timezone_management",
3288
+ "urlTemplate": "/site/activate-improved-timezone-management",
3289
+ "method": "PUT",
3290
+ "comment": "Activate improved timezone management",
3291
+ "queryParamsRequired": false,
3292
+ "responseType": "SiteActivateImprovedTimezoneManagementJobSchema",
1238
3293
  "name": "activateImprovedTimezoneManagement",
1239
3294
  "rawName": "rawActivateImprovedTimezoneManagement"
1240
3295
  }
@@ -1246,32 +3301,94 @@
1246
3301
  "jsonApiType": "workflow",
1247
3302
  "endpoints": [
1248
3303
  {
1249
- "rel": "create",
1250
3304
  "returnsCollection": false,
3305
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/workflow/create",
3306
+ "rel": "create",
3307
+ "urlTemplate": "/workflows",
3308
+ "method": "POST",
3309
+ "comment": "Create a new workflow",
3310
+ "requestBodyType": "WorkflowCreateSchema",
3311
+ "requestStructure": {
3312
+ "type": "workflow",
3313
+ "attributes": [
3314
+ "name",
3315
+ "stages"
3316
+ ],
3317
+ "relationships": []
3318
+ },
3319
+ "queryParamsRequired": false,
3320
+ "responseType": "WorkflowCreateTargetSchema",
1251
3321
  "name": "create",
1252
3322
  "rawName": "rawCreate"
1253
3323
  },
1254
3324
  {
1255
- "rel": "update",
1256
3325
  "returnsCollection": false,
3326
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/workflow/update",
3327
+ "rel": "update",
3328
+ "urlTemplate": "/workflows/${workflowId}",
3329
+ "method": "PUT",
3330
+ "comment": "Update a workflow",
3331
+ "urlPlaceholder": {
3332
+ "variableName": "workflowId",
3333
+ "isEntityId": true,
3334
+ "relType": "WorkflowData"
3335
+ },
3336
+ "requestBodyType": "WorkflowUpdateSchema",
3337
+ "requestStructure": {
3338
+ "type": "workflow",
3339
+ "attributes": [
3340
+ "name",
3341
+ "stages"
3342
+ ],
3343
+ "relationships": []
3344
+ },
3345
+ "queryParamsRequired": false,
3346
+ "responseType": "WorkflowUpdateTargetSchema",
1257
3347
  "name": "update",
1258
3348
  "rawName": "rawUpdate"
1259
3349
  },
1260
3350
  {
1261
- "rel": "instances",
1262
3351
  "returnsCollection": true,
3352
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/workflow/instances",
3353
+ "rel": "instances",
3354
+ "urlTemplate": "/workflows",
3355
+ "method": "GET",
3356
+ "comment": "List all workflows",
3357
+ "queryParamsRequired": false,
3358
+ "responseType": "WorkflowInstancesTargetSchema",
1263
3359
  "name": "list",
1264
3360
  "rawName": "rawList"
1265
3361
  },
1266
3362
  {
1267
- "rel": "self",
1268
3363
  "returnsCollection": false,
3364
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/workflow/self",
3365
+ "rel": "self",
3366
+ "urlTemplate": "/workflows/${workflowId}",
3367
+ "method": "GET",
3368
+ "comment": "Retrieve a workflow",
3369
+ "urlPlaceholder": {
3370
+ "variableName": "workflowId",
3371
+ "isEntityId": true,
3372
+ "relType": "WorkflowData"
3373
+ },
3374
+ "queryParamsRequired": false,
3375
+ "responseType": "WorkflowSelfTargetSchema",
1269
3376
  "name": "find",
1270
3377
  "rawName": "rawFind"
1271
3378
  },
1272
3379
  {
1273
- "rel": "destroy",
1274
3380
  "returnsCollection": false,
3381
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/workflow/destroy",
3382
+ "rel": "destroy",
3383
+ "urlTemplate": "/workflows/${workflowId}",
3384
+ "method": "DELETE",
3385
+ "comment": "Delete a workflow",
3386
+ "urlPlaceholder": {
3387
+ "variableName": "workflowId",
3388
+ "isEntityId": true,
3389
+ "relType": "WorkflowData"
3390
+ },
3391
+ "queryParamsRequired": false,
1275
3392
  "name": "destroy",
1276
3393
  "rawName": "rawDestroy"
1277
3394
  }