picked 0.0.101 → 0.0.102-next.2

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 (36) hide show
  1. package/docs/reference/dashboard/workflow-test-runs.md +40 -17
  2. package/docs/reference/management-api/schema/action.md +67 -79
  3. package/docs/reference/management-api/schema/analytics-session.md +77 -94
  4. package/docs/reference/management-api/schema/analytics.md +16 -14
  5. package/docs/reference/management-api/schema/api-key.md +43 -51
  6. package/docs/reference/management-api/schema/auth.md +271 -404
  7. package/docs/reference/management-api/schema/cms-fields.md +348 -245
  8. package/docs/reference/management-api/schema/cms-models.md +369 -378
  9. package/docs/reference/management-api/schema/common.md +69 -130
  10. package/docs/reference/management-api/schema/condition.md +63 -74
  11. package/docs/reference/management-api/schema/design-system.md +59 -51
  12. package/docs/reference/management-api/schema/experience.md +388 -364
  13. package/docs/reference/management-api/schema/external-api.md +153 -171
  14. package/docs/reference/management-api/schema/feature.md +85 -103
  15. package/docs/reference/management-api/schema/feedback.md +27 -31
  16. package/docs/reference/management-api/schema/field.md +117 -135
  17. package/docs/reference/management-api/schema/index.md +184 -184
  18. package/docs/reference/management-api/schema/integration.md +72 -78
  19. package/docs/reference/management-api/schema/label.md +81 -137
  20. package/docs/reference/management-api/schema/lead.md +80 -119
  21. package/docs/reference/management-api/schema/mcp-server.md +73 -71
  22. package/docs/reference/management-api/schema/metric.md +6 -9
  23. package/docs/reference/management-api/schema/operation.md +17 -26
  24. package/docs/reference/management-api/schema/organization.md +198 -220
  25. package/docs/reference/management-api/schema/project.md +177 -186
  26. package/docs/reference/management-api/schema/report.md +69 -65
  27. package/docs/reference/management-api/schema/saved-view.md +71 -71
  28. package/docs/reference/management-api/schema/shopify.md +331 -204
  29. package/docs/reference/management-api/schema/step.md +72 -80
  30. package/docs/reference/management-api/schema/tenant-branding.md +48 -70
  31. package/docs/reference/management-api/schema/workbench.md +54 -66
  32. package/docs/reference/management-api/schema/workflow-run.md +66 -79
  33. package/docs/reference/management-api/schema/workflow.md +310 -353
  34. package/docs/reference/management-api/schema/workspace-version.md +212 -261
  35. package/docs/reference/management-api/schema/workspace.md +275 -328
  36. package/package.json +4 -4
@@ -6,43 +6,43 @@ generated: true
6
6
 
7
7
  # Cms fields schema
8
8
 
9
- The operations and types that `cms-fields.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
9
+ See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
10
10
 
11
11
  ## Types
12
12
 
13
13
  ### `ContentFieldType`
14
14
 
15
15
  ```graphql
16
- """All Content field kinds supported by the v1 schema editor."""
16
+ """The kind of a field in a content schema."""
17
17
  enum ContentFieldType {
18
- """Single-line text input."""
18
+ """Single-line text."""
19
19
  SINGLE_LINE_TEXT
20
- """Multi-line text input."""
20
+ """Multi-line text."""
21
21
  MULTI_LINE_TEXT
22
- """Markdown-formatted text input."""
22
+ """Markdown text."""
23
23
  MARKDOWN
24
- """URL-friendly slug input."""
24
+ """A URL-safe slug."""
25
25
  SLUG
26
- """Numeric input (integer or decimal)."""
26
+ """A number, integer or decimal."""
27
27
  NUMBER
28
- """Boolean (checkbox / toggle)."""
28
+ """A true or false value."""
29
29
  BOOLEAN
30
- """ISO date or date-time input."""
30
+ """A date, or a date and time."""
31
31
  DATE
32
- """Free-form JSON value."""
32
+ """Any JSON value."""
33
33
  JSON
34
- """Reference to a binary Asset (image, video, document)."""
34
+ """A reference to an asset."""
35
35
  ASSET
36
- """Reference to an HTML-document Asset (an uploaded `.html` file)."""
36
+ """A reference to an HTML asset, an uploaded `.html` file."""
37
37
  HTML_ASSET
38
- """Hex colour value (`#rrggbb`)."""
38
+ """A hex colour, `#rrggbb`."""
39
39
  COLOR
40
- """Embedded `ContentBlock` instance."""
40
+ """An embedded block instance."""
41
41
  CONTENT_BLOCK
42
- """Nested group of fields (sub-schema)."""
42
+ """A group of nested fields."""
43
43
  GROUP
44
44
  """
45
- Reference to one or more other `ContentEntry` rows, optionally constrained to a target `ContentModel`.
45
+ A reference to another content entry, optionally limited to one target model.
46
46
  """
47
47
  REFERENCE
48
48
  }
@@ -52,16 +52,18 @@ enum ContentFieldType {
52
52
 
53
53
  ```graphql
54
54
  """
55
- Format hint applied to string-valued single-line text fields. Controls how the editor renders the input and how the value is validated.
55
+ The format of a single-line text value, which sets how the value is checked.
56
56
  """
57
57
  enum TextFormat {
58
- """Plain text — no extra validation."""
58
+ """Any text."""
59
59
  PLAIN
60
- """URL — must parse as a URL."""
60
+ """A URL with the `http` or `https` scheme."""
61
61
  URL
62
- """Email address — must match RFC-5322 email syntax."""
62
+ """An email address."""
63
63
  EMAIL
64
- """Slug — must match `[a-z0-9-]+`."""
64
+ """
65
+ A slug. The value is lowercased, and runs of other characters become `-`.
66
+ """
65
67
  SLUG
66
68
  }
67
69
  ```
@@ -69,11 +71,9 @@ enum TextFormat {
69
71
  ### `ContentSchema`
70
72
 
71
73
  ```graphql
72
- """
73
- A strongly-typed CMS schema — list of field definitions. Used as the value of `ContentModel.schema` and `ContentBlock.schema`.
74
- """
74
+ """The set of fields that a model or a block defines."""
75
75
  type ContentSchema {
76
- """The field definitions making up the schema."""
76
+ """The fields of the schema, in order."""
77
77
  fields: [ContentFieldDefinition!]!
78
78
  }
79
79
  ```
@@ -82,24 +82,20 @@ type ContentSchema {
82
82
 
83
83
  ```graphql
84
84
  """
85
- One field definition inside a Content Schema. Implementations carry the
86
- per-kind extras (text format, number bounds, content-block category,
87
- group nested fields). Use `__typename` to discriminate.
85
+ One field in a content schema. Each implementation adds the settings of its kind.
88
86
  """
89
87
  interface ContentFieldDefinition {
90
- """
91
- Stable machine identifier — used as the key inside `ContentEntry.data`.
92
- """
88
+ """The key of the field, which names its value in the entry data."""
93
89
  key: String!
94
- """Human-readable label shown in the editor."""
90
+ """The label of the field."""
95
91
  name: String!
96
- """Optional author-facing description of the field's purpose."""
92
+ """The description of the field. Null when it has none."""
97
93
  description: String
98
- """Field kind discriminator — also encoded in `__typename`."""
94
+ """The kind of the field."""
99
95
  type: ContentFieldType!
100
- """When true, the value is stored as a list."""
96
+ """Whether the field holds a list of values."""
101
97
  repeatable: Boolean!
102
- """When true, validation rejects null / missing values."""
98
+ """Whether a filled content entry must hold a value for the field."""
103
99
  required: Boolean!
104
100
  }
105
101
  ```
@@ -107,21 +103,29 @@ interface ContentFieldDefinition {
107
103
  ### `SingleLineTextFieldDefinition`
108
104
 
109
105
  ```graphql
110
- """Single-line text field definition."""
106
+ """A single-line text field."""
111
107
  type SingleLineTextFieldDefinition implements ContentFieldDefinition {
108
+ """The key of the field, which names its value in the entry data."""
112
109
  key: String!
110
+ """The label of the field."""
113
111
  name: String!
112
+ """The description of the field. Null when it has none."""
114
113
  description: String
114
+ """The kind of the field."""
115
115
  type: ContentFieldType!
116
+ """Whether the field holds a list of values."""
116
117
  repeatable: Boolean!
118
+ """Whether a filled content entry must hold a value for the field."""
117
119
  required: Boolean!
118
- """When non-PLAIN, the value must match this format. Default `PLAIN`."""
120
+ """The format the value must have."""
119
121
  format: TextFormat!
120
- """Optional anchored regex applied after the format check."""
122
+ """
123
+ A regular expression the whole value must match, checked after the format. Null for none.
124
+ """
121
125
  pattern: String
122
- """Minimum number of characters (inclusive)."""
126
+ """The fewest characters allowed. Null for no minimum."""
123
127
  minLength: Int
124
- """Maximum number of characters (inclusive)."""
128
+ """The most characters allowed. Null for no maximum."""
125
129
  maxLength: Int
126
130
  }
127
131
  ```
@@ -129,17 +133,23 @@ type SingleLineTextFieldDefinition implements ContentFieldDefinition {
129
133
  ### `MultiLineTextFieldDefinition`
130
134
 
131
135
  ```graphql
132
- """Multi-line text field definition."""
136
+ """A multi-line text field."""
133
137
  type MultiLineTextFieldDefinition implements ContentFieldDefinition {
138
+ """The key of the field, which names its value in the entry data."""
134
139
  key: String!
140
+ """The label of the field."""
135
141
  name: String!
142
+ """The description of the field. Null when it has none."""
136
143
  description: String
144
+ """The kind of the field."""
137
145
  type: ContentFieldType!
146
+ """Whether the field holds a list of values."""
138
147
  repeatable: Boolean!
148
+ """Whether a filled content entry must hold a value for the field."""
139
149
  required: Boolean!
140
- """Minimum number of characters (inclusive)."""
150
+ """The fewest characters allowed. Null for no minimum."""
141
151
  minLength: Int
142
- """Maximum number of characters (inclusive)."""
152
+ """The most characters allowed. Null for no maximum."""
143
153
  maxLength: Int
144
154
  }
145
155
  ```
@@ -147,13 +157,19 @@ type MultiLineTextFieldDefinition implements ContentFieldDefinition {
147
157
  ### `MarkdownFieldDefinition`
148
158
 
149
159
  ```graphql
150
- """Markdown field definition. No per-kind extras."""
160
+ """A Markdown field."""
151
161
  type MarkdownFieldDefinition implements ContentFieldDefinition {
162
+ """The key of the field, which names its value in the entry data."""
152
163
  key: String!
164
+ """The label of the field."""
153
165
  name: String!
166
+ """The description of the field. Null when it has none."""
154
167
  description: String
168
+ """The kind of the field."""
155
169
  type: ContentFieldType!
170
+ """Whether the field holds a list of values."""
156
171
  repeatable: Boolean!
172
+ """Whether a filled content entry must hold a value for the field."""
157
173
  required: Boolean!
158
174
  }
159
175
  ```
@@ -161,15 +177,23 @@ type MarkdownFieldDefinition implements ContentFieldDefinition {
161
177
  ### `SlugFieldDefinition`
162
178
 
163
179
  ```graphql
164
- """Slug field definition. Slugs may optionally derive from another field."""
180
+ """A slug field."""
165
181
  type SlugFieldDefinition implements ContentFieldDefinition {
182
+ """The key of the field, which names its value in the entry data."""
166
183
  key: String!
184
+ """The label of the field."""
167
185
  name: String!
186
+ """The description of the field. Null when it has none."""
168
187
  description: String
188
+ """The kind of the field."""
169
189
  type: ContentFieldType!
190
+ """Whether the field holds a list of values."""
170
191
  repeatable: Boolean!
192
+ """Whether a filled content entry must hold a value for the field."""
171
193
  required: Boolean!
172
- """When set, the slug derives from another field's value (e.g. `title`)."""
194
+ """
195
+ The key of the field the slug derives from, such as `title`. Null when it derives from none.
196
+ """
173
197
  derivedFromKey: String
174
198
  }
175
199
  ```
@@ -177,19 +201,25 @@ type SlugFieldDefinition implements ContentFieldDefinition {
177
201
  ### `NumberFieldDefinition`
178
202
 
179
203
  ```graphql
180
- """Number field definition."""
204
+ """A number field."""
181
205
  type NumberFieldDefinition implements ContentFieldDefinition {
206
+ """The key of the field, which names its value in the entry data."""
182
207
  key: String!
208
+ """The label of the field."""
183
209
  name: String!
210
+ """The description of the field. Null when it has none."""
184
211
  description: String
212
+ """The kind of the field."""
185
213
  type: ContentFieldType!
214
+ """Whether the field holds a list of values."""
186
215
  repeatable: Boolean!
216
+ """Whether a filled content entry must hold a value for the field."""
187
217
  required: Boolean!
188
- """Minimum value (inclusive)."""
218
+ """The lowest value allowed. Null for no minimum."""
189
219
  min: Float
190
- """Maximum value (inclusive)."""
220
+ """The highest value allowed. Null for no maximum."""
191
221
  max: Float
192
- """When true, the value must be an integer."""
222
+ """Whether the value must be an integer."""
193
223
  integerOnly: Boolean!
194
224
  }
195
225
  ```
@@ -197,13 +227,19 @@ type NumberFieldDefinition implements ContentFieldDefinition {
197
227
  ### `BooleanFieldDefinition`
198
228
 
199
229
  ```graphql
200
- """Boolean field definition. No per-kind extras."""
230
+ """A boolean field."""
201
231
  type BooleanFieldDefinition implements ContentFieldDefinition {
232
+ """The key of the field, which names its value in the entry data."""
202
233
  key: String!
234
+ """The label of the field."""
203
235
  name: String!
236
+ """The description of the field. Null when it has none."""
204
237
  description: String
238
+ """The kind of the field."""
205
239
  type: ContentFieldType!
240
+ """Whether the field holds a list of values."""
206
241
  repeatable: Boolean!
242
+ """Whether a filled content entry must hold a value for the field."""
207
243
  required: Boolean!
208
244
  }
209
245
  ```
@@ -211,17 +247,21 @@ type BooleanFieldDefinition implements ContentFieldDefinition {
211
247
  ### `DateFieldDefinition`
212
248
 
213
249
  ```graphql
214
- """Date field definition. Optionally includes the time component."""
250
+ """A date field."""
215
251
  type DateFieldDefinition implements ContentFieldDefinition {
252
+ """The key of the field, which names its value in the entry data."""
216
253
  key: String!
254
+ """The label of the field."""
217
255
  name: String!
256
+ """The description of the field. Null when it has none."""
218
257
  description: String
258
+ """The kind of the field."""
219
259
  type: ContentFieldType!
260
+ """Whether the field holds a list of values."""
220
261
  repeatable: Boolean!
262
+ """Whether a filled content entry must hold a value for the field."""
221
263
  required: Boolean!
222
- """
223
- When true, the value carries both date and time. When false, time is stripped.
224
- """
264
+ """Whether the value holds a time as well as a date."""
225
265
  includeTime: Boolean!
226
266
  }
227
267
  ```
@@ -229,13 +269,19 @@ type DateFieldDefinition implements ContentFieldDefinition {
229
269
  ### `JsonFieldDefinition`
230
270
 
231
271
  ```graphql
232
- """JSON field definition — escape hatch for unstructured shapes."""
272
+ """A JSON field, for values with no fixed shape."""
233
273
  type JsonFieldDefinition implements ContentFieldDefinition {
274
+ """The key of the field, which names its value in the entry data."""
234
275
  key: String!
276
+ """The label of the field."""
235
277
  name: String!
278
+ """The description of the field. Null when it has none."""
236
279
  description: String
280
+ """The kind of the field."""
237
281
  type: ContentFieldType!
282
+ """Whether the field holds a list of values."""
238
283
  repeatable: Boolean!
284
+ """Whether a filled content entry must hold a value for the field."""
239
285
  required: Boolean!
240
286
  }
241
287
  ```
@@ -244,30 +290,42 @@ type JsonFieldDefinition implements ContentFieldDefinition {
244
290
 
245
291
  ```graphql
246
292
  """
247
- Asset field definition. Restricts which Assets can be referenced by MIME, size, and (for images) intrinsic dimensions.
293
+ An asset field, with optional limits on the MIME type, size and image dimensions of the asset.
248
294
  """
249
295
  type AssetFieldDefinition implements ContentFieldDefinition {
296
+ """The key of the field, which names its value in the entry data."""
250
297
  key: String!
298
+ """The label of the field."""
251
299
  name: String!
300
+ """The description of the field. Null when it has none."""
252
301
  description: String
302
+ """The kind of the field."""
253
303
  type: ContentFieldType!
304
+ """Whether the field holds a list of values."""
254
305
  repeatable: Boolean!
306
+ """Whether a filled content entry must hold a value for the field."""
255
307
  required: Boolean!
256
308
  """
257
- Allowlist of accepted MIME types (e.g. `["image/png", "image/jpeg"]`). When set, the codec rejects assets whose `mimeType` is not in the list.
309
+ The MIME types the asset may have, such as `["image/png", "image/jpeg"]`. Null for any.
258
310
  """
259
311
  acceptedMimeTypes: [String!]
260
- """Maximum file size in bytes. The codec rejects assets larger than this."""
312
+ """The largest file size allowed, in bytes. Null for no limit."""
261
313
  maxBytes: Int
262
314
  """
263
- Image-only: minimum width in pixels. Applied when the asset's MIME type begins with `image/`.
315
+ The smallest image width allowed, in pixels. Applies to images only. Null for no limit.
264
316
  """
265
317
  minWidth: Int
266
- """Image-only: maximum width in pixels."""
318
+ """
319
+ The largest image width allowed, in pixels. Applies to images only. Null for no limit.
320
+ """
267
321
  maxWidth: Int
268
- """Image-only: minimum height in pixels."""
322
+ """
323
+ The smallest image height allowed, in pixels. Applies to images only. Null for no limit.
324
+ """
269
325
  minHeight: Int
270
- """Image-only: maximum height in pixels."""
326
+ """
327
+ The largest image height allowed, in pixels. Applies to images only. Null for no limit.
328
+ """
271
329
  maxHeight: Int
272
330
  }
273
331
  ```
@@ -276,16 +334,22 @@ type AssetFieldDefinition implements ContentFieldDefinition {
276
334
 
277
335
  ```graphql
278
336
  """
279
- HTML-asset field definition. Like `AssetFieldDefinition` but the referenced Asset is always an uploaded `.html` file (`text/html`); only the file-size cap is author-configurable.
337
+ An HTML asset field, which accepts only an uploaded `.html` file (`text/html`).
280
338
  """
281
339
  type HtmlAssetFieldDefinition implements ContentFieldDefinition {
340
+ """The key of the field, which names its value in the entry data."""
282
341
  key: String!
342
+ """The label of the field."""
283
343
  name: String!
344
+ """The description of the field. Null when it has none."""
284
345
  description: String
346
+ """The kind of the field."""
285
347
  type: ContentFieldType!
348
+ """Whether the field holds a list of values."""
286
349
  repeatable: Boolean!
350
+ """Whether a filled content entry must hold a value for the field."""
287
351
  required: Boolean!
288
- """Maximum file size in bytes. The codec rejects assets larger than this."""
352
+ """The largest file size allowed, in bytes. Null for no limit."""
289
353
  maxBytes: Int
290
354
  }
291
355
  ```
@@ -293,13 +357,19 @@ type HtmlAssetFieldDefinition implements ContentFieldDefinition {
293
357
  ### `ColorFieldDefinition`
294
358
 
295
359
  ```graphql
296
- """Color field definition. Values are lowercase hex with leading `#`."""
360
+ """A colour field. Values are lowercase hex with a leading `#`."""
297
361
  type ColorFieldDefinition implements ContentFieldDefinition {
362
+ """The key of the field, which names its value in the entry data."""
298
363
  key: String!
364
+ """The label of the field."""
299
365
  name: String!
366
+ """The description of the field. Null when it has none."""
300
367
  description: String
368
+ """The kind of the field."""
301
369
  type: ContentFieldType!
370
+ """Whether the field holds a list of values."""
302
371
  repeatable: Boolean!
372
+ """Whether a filled content entry must hold a value for the field."""
303
373
  required: Boolean!
304
374
  }
305
375
  ```
@@ -307,18 +377,22 @@ type ColorFieldDefinition implements ContentFieldDefinition {
307
377
  ### `ContentBlockFieldDefinition`
308
378
 
309
379
  ```graphql
310
- """
311
- Content Block field definition — embeds Block instances of the configured category.
312
- """
380
+ """A block field, which embeds block instances."""
313
381
  type ContentBlockFieldDefinition implements ContentFieldDefinition {
382
+ """The key of the field, which names its value in the entry data."""
314
383
  key: String!
384
+ """The label of the field."""
315
385
  name: String!
386
+ """The description of the field. Null when it has none."""
316
387
  description: String
388
+ """The kind of the field."""
317
389
  type: ContentFieldType!
390
+ """Whether the field holds a list of values."""
318
391
  repeatable: Boolean!
392
+ """Whether a filled content entry must hold a value for the field."""
319
393
  required: Boolean!
320
394
  """
321
- The Content Block category whose Blocks may be embedded here. Null means any category may be embedded.
395
+ The category of block the field accepts. Null when it accepts any category.
322
396
  """
323
397
  contentBlockCategory: ContentBlockCategory
324
398
  }
@@ -327,17 +401,21 @@ type ContentBlockFieldDefinition implements ContentFieldDefinition {
327
401
  ### `GroupFieldDefinition`
328
402
 
329
403
  ```graphql
330
- """Group field definition — nests a sub-schema."""
404
+ """A group field, which nests a set of fields."""
331
405
  type GroupFieldDefinition implements ContentFieldDefinition {
406
+ """The key of the field, which names its value in the entry data."""
332
407
  key: String!
408
+ """The label of the field."""
333
409
  name: String!
410
+ """The description of the field. Null when it has none."""
334
411
  description: String
412
+ """The kind of the field."""
335
413
  type: ContentFieldType!
414
+ """Whether the field holds a list of values."""
336
415
  repeatable: Boolean!
416
+ """Whether a filled content entry must hold a value for the field."""
337
417
  required: Boolean!
338
- """
339
- Nested field definitions (max nesting depth 3 enforced by the validator).
340
- """
418
+ """The nested fields. Groups nest at most three levels deep."""
341
419
  nestedFields: [ContentFieldDefinition!]!
342
420
  }
343
421
  ```
@@ -345,18 +423,22 @@ type GroupFieldDefinition implements ContentFieldDefinition {
345
423
  ### `ReferenceFieldDefinition`
346
424
 
347
425
  ```graphql
348
- """
349
- Reference field definition — points at one or more other Content Entries.
350
- """
426
+ """A reference field, which points at other content entries."""
351
427
  type ReferenceFieldDefinition implements ContentFieldDefinition {
428
+ """The key of the field, which names its value in the entry data."""
352
429
  key: String!
430
+ """The label of the field."""
353
431
  name: String!
432
+ """The description of the field. Null when it has none."""
354
433
  description: String
434
+ """The kind of the field."""
355
435
  type: ContentFieldType!
436
+ """Whether the field holds a list of values."""
356
437
  repeatable: Boolean!
438
+ """Whether a filled content entry must hold a value for the field."""
357
439
  required: Boolean!
358
440
  """
359
- The target Content Model `key` whose entries may be referenced. Null means any Content Model in the workspace may be referenced.
441
+ The key of the target model. Null when entries of any model in the workspace are accepted.
360
442
  """
361
443
  contentModelKey: String
362
444
  }
@@ -366,12 +448,11 @@ type ReferenceFieldDefinition implements ContentFieldDefinition {
366
448
 
367
449
  ```graphql
368
450
  """
369
- Strongly-typed Content Entry data. Reused as the body of `GroupFieldValue` and `EmbeddedContentBlock` (same shape, different nesting position).
451
+ The values of a content entry, typed by its schema. Group values and embedded blocks hold the same
452
+ shape.
370
453
  """
371
454
  type ContentEntryData {
372
- """
373
- The values keyed by field key — order matches the parent schema's `fields`.
374
- """
455
+ """The values, one per field, in the order of the schema's fields."""
375
456
  values: [ContentFieldValue!]!
376
457
  }
377
458
  ```
@@ -380,14 +461,13 @@ type ContentEntryData {
380
461
 
381
462
  ```graphql
382
463
  """
383
- One value inside a Content Entry. The `__typename` discriminates the
384
- kind; the corresponding singular / plural field carries the value
385
- (singular when the parent field is not repeatable, plural otherwise).
464
+ One value in a content entry. The singular member holds the value when the field is not
465
+ repeatable, and the plural member when it is.
386
466
  """
387
467
  interface ContentFieldValue {
388
- """The field key from the parent schema."""
468
+ """The key of the field in the schema."""
389
469
  key: String!
390
- """Field kind discriminator — also encoded in `__typename`."""
470
+ """The kind of the field."""
391
471
  type: ContentFieldType!
392
472
  }
393
473
  ```
@@ -395,13 +475,15 @@ interface ContentFieldValue {
395
475
  ### `SingleLineTextFieldValue`
396
476
 
397
477
  ```graphql
398
- """Single-line text value."""
478
+ """A single-line text value."""
399
479
  type SingleLineTextFieldValue implements ContentFieldValue {
480
+ """The key of the field in the schema."""
400
481
  key: String!
482
+ """The kind of the field."""
401
483
  type: ContentFieldType!
402
- """Singular value when the field is not repeatable."""
484
+ """The value. Null when the field is repeatable or has no value."""
403
485
  text: String
404
- """Plural values when the field is repeatable."""
486
+ """The values. Null when the field is not repeatable."""
405
487
  texts: [String!]
406
488
  }
407
489
  ```
@@ -409,13 +491,15 @@ type SingleLineTextFieldValue implements ContentFieldValue {
409
491
  ### `MultiLineTextFieldValue`
410
492
 
411
493
  ```graphql
412
- """Multi-line text value."""
494
+ """A multi-line text value."""
413
495
  type MultiLineTextFieldValue implements ContentFieldValue {
496
+ """The key of the field in the schema."""
414
497
  key: String!
498
+ """The kind of the field."""
415
499
  type: ContentFieldType!
416
- """Singular value when the field is not repeatable."""
500
+ """The value. Null when the field is repeatable or has no value."""
417
501
  text: String
418
- """Plural values when the field is repeatable."""
502
+ """The values. Null when the field is not repeatable."""
419
503
  texts: [String!]
420
504
  }
421
505
  ```
@@ -423,13 +507,15 @@ type MultiLineTextFieldValue implements ContentFieldValue {
423
507
  ### `MarkdownFieldValue`
424
508
 
425
509
  ```graphql
426
- """Markdown value."""
510
+ """A Markdown value."""
427
511
  type MarkdownFieldValue implements ContentFieldValue {
512
+ """The key of the field in the schema."""
428
513
  key: String!
514
+ """The kind of the field."""
429
515
  type: ContentFieldType!
430
- """Singular value when the field is not repeatable."""
516
+ """The value. Null when the field is repeatable or has no value."""
431
517
  markdown: String
432
- """Plural values when the field is repeatable."""
518
+ """The values. Null when the field is not repeatable."""
433
519
  markdowns: [String!]
434
520
  }
435
521
  ```
@@ -437,13 +523,15 @@ type MarkdownFieldValue implements ContentFieldValue {
437
523
  ### `SlugFieldValue`
438
524
 
439
525
  ```graphql
440
- """Slug value."""
526
+ """A slug value."""
441
527
  type SlugFieldValue implements ContentFieldValue {
528
+ """The key of the field in the schema."""
442
529
  key: String!
530
+ """The kind of the field."""
443
531
  type: ContentFieldType!
444
- """Singular value when the field is not repeatable."""
532
+ """The value. Null when the field is repeatable or has no value."""
445
533
  slug: String
446
- """Plural values when the field is repeatable."""
534
+ """The values. Null when the field is not repeatable."""
447
535
  slugs: [String!]
448
536
  }
449
537
  ```
@@ -451,13 +539,15 @@ type SlugFieldValue implements ContentFieldValue {
451
539
  ### `NumberFieldValue`
452
540
 
453
541
  ```graphql
454
- """Number value."""
542
+ """A number value."""
455
543
  type NumberFieldValue implements ContentFieldValue {
544
+ """The key of the field in the schema."""
456
545
  key: String!
546
+ """The kind of the field."""
457
547
  type: ContentFieldType!
458
- """Singular value when the field is not repeatable."""
548
+ """The value. Null when the field is repeatable or has no value."""
459
549
  number: Float
460
- """Plural values when the field is repeatable."""
550
+ """The values. Null when the field is not repeatable."""
461
551
  numbers: [Float!]
462
552
  }
463
553
  ```
@@ -465,13 +555,15 @@ type NumberFieldValue implements ContentFieldValue {
465
555
  ### `BooleanFieldValue`
466
556
 
467
557
  ```graphql
468
- """Boolean value."""
558
+ """A boolean value."""
469
559
  type BooleanFieldValue implements ContentFieldValue {
560
+ """The key of the field in the schema."""
470
561
  key: String!
562
+ """The kind of the field."""
471
563
  type: ContentFieldType!
472
- """Singular value when the field is not repeatable."""
564
+ """The value. Null when the field is repeatable or has no value."""
473
565
  boolean: Boolean
474
- """Plural values when the field is repeatable."""
566
+ """The values. Null when the field is not repeatable."""
475
567
  booleans: [Boolean!]
476
568
  }
477
569
  ```
@@ -479,13 +571,15 @@ type BooleanFieldValue implements ContentFieldValue {
479
571
  ### `DateFieldValue`
480
572
 
481
573
  ```graphql
482
- """Date / date-time value."""
574
+ """A date value."""
483
575
  type DateFieldValue implements ContentFieldValue {
576
+ """The key of the field in the schema."""
484
577
  key: String!
578
+ """The kind of the field."""
485
579
  type: ContentFieldType!
486
- """Singular value when the field is not repeatable."""
580
+ """The value. Null when the field is repeatable or has no value."""
487
581
  date: IsoDate
488
- """Plural values when the field is repeatable."""
582
+ """The values. Null when the field is not repeatable."""
489
583
  dates: [IsoDate!]
490
584
  }
491
585
  ```
@@ -493,13 +587,15 @@ type DateFieldValue implements ContentFieldValue {
493
587
  ### `JsonFieldValue`
494
588
 
495
589
  ```graphql
496
- """JSON value — escape hatch preserved as-is."""
590
+ """A JSON value, stored as given."""
497
591
  type JsonFieldValue implements ContentFieldValue {
592
+ """The key of the field in the schema."""
498
593
  key: String!
594
+ """The kind of the field."""
499
595
  type: ContentFieldType!
500
- """Singular JSON value when the field is not repeatable."""
596
+ """The value. Null when the field is repeatable or has no value."""
501
597
  json: JSON
502
- """Plural JSON values when the field is repeatable."""
598
+ """The values. Null when the field is not repeatable."""
503
599
  jsons: [JSON!]
504
600
  }
505
601
  ```
@@ -508,17 +604,17 @@ type JsonFieldValue implements ContentFieldValue {
508
604
 
509
605
  ```graphql
510
606
  """
511
- An asset reference resolved to the specific version it is pinned to (or its
512
- oldest-version fallback for a legacy reference).
607
+ A reference to an asset, resolved to the version it pins, or to the asset's oldest version when it
608
+ pins none.
513
609
  """
514
610
  type AssetRef {
515
611
  """
516
- The referenced Asset. Its top-level byte fields reflect the CURRENT version;
517
- read `version` for the pinned version's bytes.
612
+ The referenced asset. Its own file fields describe its current version; `version` describes the
613
+ pinned one.
518
614
  """
519
615
  asset: Asset!
520
616
  """
521
- The pinned (or oldest-fallback) version. Null only on a version loader miss.
617
+ The version the reference resolves to. Null when that version cannot be found.
522
618
  """
523
619
  version: AssetVersion
524
620
  }
@@ -527,13 +623,17 @@ type AssetRef {
527
623
  ### `AssetFieldValue`
528
624
 
529
625
  ```graphql
530
- """Asset reference value."""
626
+ """An asset value."""
531
627
  type AssetFieldValue implements ContentFieldValue {
628
+ """The key of the field in the schema."""
532
629
  key: String!
630
+ """The kind of the field."""
533
631
  type: ContentFieldType!
534
- """Singular Asset reference when the field is not repeatable."""
632
+ """
633
+ The asset reference. Null when the field is repeatable or has no value.
634
+ """
535
635
  assetRef: AssetRef
536
- """Plural Asset references when the field is repeatable."""
636
+ """The asset references. Null when the field is not repeatable."""
537
637
  assetRefs: [AssetRef!]
538
638
  }
539
639
  ```
@@ -541,15 +641,17 @@ type AssetFieldValue implements ContentFieldValue {
541
641
  ### `HtmlAssetFieldValue`
542
642
 
543
643
  ```graphql
544
- """
545
- HTML-asset reference value. Carries the same resolved `Asset` as `AssetFieldValue`; distinct `__typename` so the field kind round-trips.
546
- """
644
+ """An HTML asset value."""
547
645
  type HtmlAssetFieldValue implements ContentFieldValue {
646
+ """The key of the field in the schema."""
548
647
  key: String!
648
+ """The kind of the field."""
549
649
  type: ContentFieldType!
550
- """Singular Asset reference when the field is not repeatable."""
650
+ """
651
+ The asset reference. Null when the field is repeatable or has no value.
652
+ """
551
653
  assetRef: AssetRef
552
- """Plural Asset references when the field is repeatable."""
654
+ """The asset references. Null when the field is not repeatable."""
553
655
  assetRefs: [AssetRef!]
554
656
  }
555
657
  ```
@@ -557,15 +659,18 @@ type HtmlAssetFieldValue implements ContentFieldValue {
557
659
  ### `ColorFieldValue`
558
660
 
559
661
  ```graphql
560
- """Color value."""
662
+ """A colour value."""
561
663
  type ColorFieldValue implements ContentFieldValue {
664
+ """The key of the field in the schema."""
562
665
  key: String!
666
+ """The kind of the field."""
563
667
  type: ContentFieldType!
564
668
  """
565
- Singular color value — lowercase hex with leading `#` (e.g. `#ff0000`).
669
+ The colour, lowercase hex with a leading `#`, such as `#ff0000`. Null when the field is repeatable
670
+ or has no value.
566
671
  """
567
672
  color: String
568
- """Plural color values."""
673
+ """The colours. Null when the field is not repeatable."""
569
674
  colors: [String!]
570
675
  }
571
676
  ```
@@ -573,13 +678,15 @@ type ColorFieldValue implements ContentFieldValue {
573
678
  ### `ContentBlockFieldValue`
574
679
 
575
680
  ```graphql
576
- """Embedded Content Block value."""
681
+ """An embedded block value."""
577
682
  type ContentBlockFieldValue implements ContentFieldValue {
683
+ """The key of the field in the schema."""
578
684
  key: String!
685
+ """The kind of the field."""
579
686
  type: ContentFieldType!
580
- """Singular embedded block when the field is not repeatable."""
687
+ """The embedded block. Null when the field is repeatable or has no value."""
581
688
  block: EmbeddedContentBlock
582
- """Plural embedded blocks when the field is repeatable."""
689
+ """The embedded blocks. Null when the field is not repeatable."""
583
690
  blocks: [EmbeddedContentBlock!]
584
691
  }
585
692
  ```
@@ -587,13 +694,17 @@ type ContentBlockFieldValue implements ContentFieldValue {
587
694
  ### `GroupFieldValue`
588
695
 
589
696
  ```graphql
590
- """Nested group value — carries a sub-shaped `ContentEntryData`."""
697
+ """A group value."""
591
698
  type GroupFieldValue implements ContentFieldValue {
699
+ """The key of the field in the schema."""
592
700
  key: String!
701
+ """The kind of the field."""
593
702
  type: ContentFieldType!
594
- """Singular nested group value when the field is not repeatable."""
703
+ """
704
+ The values of the group. Null when the field is repeatable or has no value.
705
+ """
595
706
  group: ContentEntryData
596
- """Plural nested group values when the field is repeatable."""
707
+ """The values of each group. Null when the field is not repeatable."""
597
708
  groups: [ContentEntryData!]
598
709
  }
599
710
  ```
@@ -602,12 +713,12 @@ type GroupFieldValue implements ContentFieldValue {
602
713
 
603
714
  ```graphql
604
715
  """
605
- A Content Block instance embedded inside a Content Entry. Pairs the referenced Block (which carries the schema) with its data.
716
+ A block instance inside a content entry: the block, which carries the schema, and its values.
606
717
  """
607
718
  type EmbeddedContentBlock {
608
- """The referenced Content Block — resolves the schema and category."""
719
+ """The embedded block."""
609
720
  contentBlock: ContentBlock!
610
- """Block-shaped data, recursively typed."""
721
+ """The values of the instance, typed by the block's schema."""
611
722
  data: ContentEntryData!
612
723
  }
613
724
  ```
@@ -615,13 +726,18 @@ type EmbeddedContentBlock {
615
726
  ### `ReferenceFieldValue`
616
727
 
617
728
  ```graphql
618
- """Reference value — resolves the referenced Content Entry/Entries."""
729
+ """A reference value."""
619
730
  type ReferenceFieldValue implements ContentFieldValue {
731
+ """The key of the field in the schema."""
620
732
  key: String!
733
+ """The kind of the field."""
621
734
  type: ContentFieldType!
622
- """Singular referenced Content Entry when the field is not repeatable."""
735
+ """
736
+ The referenced content entry. Null when the field is repeatable, has no value, or names a missing
737
+ entry.
738
+ """
623
739
  contentEntry: ContentEntry
624
- """Plural referenced Content Entries when the field is repeatable."""
740
+ """The referenced content entries. Null when the field is not repeatable."""
625
741
  contentEntries: [ContentEntry!]
626
742
  }
627
743
  ```
@@ -629,9 +745,9 @@ type ReferenceFieldValue implements ContentFieldValue {
629
745
  ### `ContentSchemaInput`
630
746
 
631
747
  ```graphql
632
- """A schema input — list of field definitions."""
748
+ """The fields of a content schema."""
633
749
  input ContentSchemaInput {
634
- """The field definitions making up the schema."""
750
+ """The fields of the schema, in order."""
635
751
  fields: [ContentFieldDefinitionInput!]!
636
752
  }
637
753
  ```
@@ -640,46 +756,47 @@ input ContentSchemaInput {
640
756
 
641
757
  ```graphql
642
758
  """
643
- One field-definition input. Exactly one of the field-kind sub-inputs (`singleLineText`, `number`, `contentBlock`, …) must be set; the resolver rejects with INVALID_INPUT otherwise.
759
+ One field in a content schema. Set exactly one kind input, such as `singleLineText` or `number`;
760
+ any other count fails with `INVALID_INPUT`.
644
761
  """
645
762
  input ContentFieldDefinitionInput {
646
- """Stable machine identifier."""
763
+ """The key of the field, which names its value in the entry data."""
647
764
  key: String!
648
- """Human-readable label."""
765
+ """The label of the field."""
649
766
  name: String!
650
- """Optional author-facing description of the field's purpose."""
767
+ """The description of the field."""
651
768
  description: String
652
- """When true, the value is stored as a list."""
769
+ """Whether the field holds a list of values."""
653
770
  repeatable: Boolean = false
654
- """When true, validation rejects null / missing values."""
771
+ """Whether a filled content entry must hold a value for the field."""
655
772
  required: Boolean = false
656
- """Single-line text sub-input."""
773
+ """The settings of a single-line text field."""
657
774
  singleLineText: SingleLineTextFieldInput
658
- """Multi-line text sub-input."""
775
+ """The settings of a multi-line text field."""
659
776
  multiLineText: MultiLineTextFieldInput
660
- """Markdown sub-input."""
777
+ """Makes the field a Markdown field."""
661
778
  markdown: MarkdownFieldInput
662
- """Slug sub-input."""
779
+ """The settings of a slug field."""
663
780
  slug: SlugFieldInput
664
- """Number sub-input."""
781
+ """The settings of a number field."""
665
782
  number: NumberFieldInput
666
- """Boolean sub-input."""
783
+ """Makes the field a boolean field."""
667
784
  boolean: BooleanFieldInput
668
- """Date sub-input."""
785
+ """The settings of a date field."""
669
786
  date: DateFieldInput
670
- """JSON sub-input."""
787
+ """Makes the field a JSON field."""
671
788
  json: JsonFieldInput
672
- """Asset sub-input."""
789
+ """The settings of an asset field."""
673
790
  asset: AssetFieldInput
674
- """HTML-asset sub-input."""
791
+ """The settings of an HTML asset field."""
675
792
  htmlAsset: HtmlAssetFieldInput
676
- """Color sub-input."""
793
+ """Makes the field a colour field."""
677
794
  color: ColorFieldInput
678
- """Content Block sub-input."""
795
+ """The settings of a block field."""
679
796
  contentBlock: ContentBlockFieldInput
680
- """Group sub-input."""
797
+ """The settings of a group field."""
681
798
  group: GroupFieldInput
682
- """Reference sub-input."""
799
+ """The settings of a reference field."""
683
800
  reference: ReferenceFieldInput
684
801
  }
685
802
  ```
@@ -687,17 +804,17 @@ input ContentFieldDefinitionInput {
687
804
  ### `SingleLineTextFieldInput`
688
805
 
689
806
  ```graphql
690
- """Per-kind input for `SINGLE_LINE_TEXT` fields."""
807
+ """The settings of a `SINGLE_LINE_TEXT` field."""
691
808
  input SingleLineTextFieldInput {
809
+ """The format the value must have."""
810
+ format: TextFormat = PLAIN
692
811
  """
693
- Format hint — controls editor rendering and validation. Default `PLAIN`.
812
+ A regular expression the whole value must match, checked after the format.
694
813
  """
695
- format: TextFormat = PLAIN
696
- """Optional anchored regex applied after the format check."""
697
814
  pattern: String
698
- """Minimum length (inclusive)."""
815
+ """The fewest characters allowed."""
699
816
  minLength: Int
700
- """Maximum length (inclusive)."""
817
+ """The most characters allowed."""
701
818
  maxLength: Int
702
819
  }
703
820
  ```
@@ -705,11 +822,11 @@ input SingleLineTextFieldInput {
705
822
  ### `MultiLineTextFieldInput`
706
823
 
707
824
  ```graphql
708
- """Per-kind input for `MULTI_LINE_TEXT` fields."""
825
+ """The settings of a `MULTI_LINE_TEXT` field."""
709
826
  input MultiLineTextFieldInput {
710
- """Minimum length (inclusive)."""
827
+ """The fewest characters allowed."""
711
828
  minLength: Int
712
- """Maximum length (inclusive)."""
829
+ """The most characters allowed."""
713
830
  maxLength: Int
714
831
  }
715
832
  ```
@@ -717,11 +834,9 @@ input MultiLineTextFieldInput {
717
834
  ### `MarkdownFieldInput`
718
835
 
719
836
  ```graphql
720
- """
721
- Marker input — `MARKDOWN` field has no extras. Presence alone discriminates the field kind.
722
- """
837
+ """Marks a `MARKDOWN` field, which has no settings."""
723
838
  input MarkdownFieldInput {
724
- """Unused — required so the input is non-empty."""
839
+ """Unused."""
725
840
  _: Boolean
726
841
  }
727
842
  ```
@@ -729,9 +844,9 @@ input MarkdownFieldInput {
729
844
  ### `SlugFieldInput`
730
845
 
731
846
  ```graphql
732
- """Per-kind input for `SLUG` fields."""
847
+ """The settings of a `SLUG` field."""
733
848
  input SlugFieldInput {
734
- """When set, the slug derives from another field's value."""
849
+ """The key of the field the slug derives from."""
735
850
  derivedFromKey: String
736
851
  }
737
852
  ```
@@ -739,13 +854,13 @@ input SlugFieldInput {
739
854
  ### `NumberFieldInput`
740
855
 
741
856
  ```graphql
742
- """Per-kind input for `NUMBER` fields."""
857
+ """The settings of a `NUMBER` field."""
743
858
  input NumberFieldInput {
744
- """Minimum value (inclusive)."""
859
+ """The lowest value allowed."""
745
860
  min: Float
746
- """Maximum value (inclusive)."""
861
+ """The highest value allowed."""
747
862
  max: Float
748
- """When true, the value must be an integer. Default `false`."""
863
+ """Whether the value must be an integer."""
749
864
  integerOnly: Boolean = false
750
865
  }
751
866
  ```
@@ -753,9 +868,9 @@ input NumberFieldInput {
753
868
  ### `BooleanFieldInput`
754
869
 
755
870
  ```graphql
756
- """Marker input — `BOOLEAN` field has no extras."""
871
+ """Marks a `BOOLEAN` field, which has no settings."""
757
872
  input BooleanFieldInput {
758
- """Unused — required so the input is non-empty."""
873
+ """Unused."""
759
874
  _: Boolean
760
875
  }
761
876
  ```
@@ -763,9 +878,9 @@ input BooleanFieldInput {
763
878
  ### `DateFieldInput`
764
879
 
765
880
  ```graphql
766
- """Per-kind input for `DATE` fields."""
881
+ """The settings of a `DATE` field."""
767
882
  input DateFieldInput {
768
- """When true, the value carries both date and time. Default `false`."""
883
+ """Whether the value holds a time as well as a date."""
769
884
  includeTime: Boolean = false
770
885
  }
771
886
  ```
@@ -773,9 +888,9 @@ input DateFieldInput {
773
888
  ### `JsonFieldInput`
774
889
 
775
890
  ```graphql
776
- """Marker input — `JSON` field has no extras."""
891
+ """Marks a `JSON` field, which has no settings."""
777
892
  input JsonFieldInput {
778
- """Unused — required so the input is non-empty."""
893
+ """Unused."""
779
894
  _: Boolean
780
895
  }
781
896
  ```
@@ -783,23 +898,21 @@ input JsonFieldInput {
783
898
  ### `AssetFieldInput`
784
899
 
785
900
  ```graphql
786
- """
787
- Per-asset-field constraints applied by the codec at data-decode time. All fields are optional; an empty input behaves as a plain `asset` field.
788
- """
901
+ """The limits of an `ASSET` field. Every limit is optional."""
789
902
  input AssetFieldInput {
790
903
  """
791
- Allowlist of accepted MIME types. When set and non-empty, the asset's `mimeType` must be in the list.
904
+ The MIME types the asset may have. Omit it, or pass an empty list, to accept any.
792
905
  """
793
906
  acceptedMimeTypes: [String!]
794
- """Maximum file size in bytes."""
907
+ """The largest file size allowed, in bytes."""
795
908
  maxBytes: Int
796
- """Image-only: minimum width in pixels."""
909
+ """The smallest image width allowed, in pixels."""
797
910
  minWidth: Int
798
- """Image-only: maximum width in pixels."""
911
+ """The largest image width allowed, in pixels."""
799
912
  maxWidth: Int
800
- """Image-only: minimum height in pixels."""
913
+ """The smallest image height allowed, in pixels."""
801
914
  minHeight: Int
802
- """Image-only: maximum height in pixels."""
915
+ """The largest image height allowed, in pixels."""
803
916
  maxHeight: Int
804
917
  }
805
918
  ```
@@ -808,10 +921,10 @@ input AssetFieldInput {
808
921
 
809
922
  ```graphql
810
923
  """
811
- Per-html-asset-field constraints applied by the codec at data-decode time. The accepted MIME type is always locked to `text/html`; only the size cap is configurable.
924
+ The limits of an `HTML_ASSET` field. The MIME type is always `text/html`.
812
925
  """
813
926
  input HtmlAssetFieldInput {
814
- """Maximum file size in bytes."""
927
+ """The largest file size allowed, in bytes."""
815
928
  maxBytes: Int
816
929
  }
817
930
  ```
@@ -819,9 +932,9 @@ input HtmlAssetFieldInput {
819
932
  ### `ColorFieldInput`
820
933
 
821
934
  ```graphql
822
- """Marker input — `COLOR` field has no extras."""
935
+ """Marks a `COLOR` field, which has no settings."""
823
936
  input ColorFieldInput {
824
- """Unused — required so the input is non-empty."""
937
+ """Unused."""
825
938
  _: Boolean
826
939
  }
827
940
  ```
@@ -829,15 +942,12 @@ input ColorFieldInput {
829
942
  ### `AssetRefInput`
830
943
 
831
944
  ```graphql
832
- """
833
- A CMS asset reference for a content-field value input, with an optional pinned version.
834
- Omit `versionId` to store a legacy reference (reads back as the asset's oldest version).
835
- """
945
+ """A reference to an asset in a content entry value."""
836
946
  input AssetRefInput {
837
- """The referenced Asset id."""
947
+ """The ID of the asset."""
838
948
  assetId: ID!
839
949
  """
840
- The pinned AssetVersion id. Omitting it persists a legacy `{ id }`-only reference, which reads back as the asset's oldest version; the dashboard AssetInput always sets it.
950
+ The ID of the version to pin. Omit it to pin the asset's current version.
841
951
  """
842
952
  versionId: ID
843
953
  }
@@ -846,10 +956,10 @@ input AssetRefInput {
846
956
  ### `ContentBlockFieldInput`
847
957
 
848
958
  ```graphql
849
- """Per-kind input for `CONTENT_BLOCK` fields."""
959
+ """The settings of a `CONTENT_BLOCK` field."""
850
960
  input ContentBlockFieldInput {
851
961
  """
852
- The Content Block category whose Blocks may be embedded here. Omit (null) to allow any category.
962
+ The category of block the field accepts. Omit it to accept any category.
853
963
  """
854
964
  contentBlockCategory: ContentBlockCategory
855
965
  }
@@ -858,9 +968,9 @@ input ContentBlockFieldInput {
858
968
  ### `GroupFieldInput`
859
969
 
860
970
  ```graphql
861
- """Per-kind input for `GROUP` fields."""
971
+ """The settings of a `GROUP` field."""
862
972
  input GroupFieldInput {
863
- """Nested field definitions (max nesting depth 3 enforced by validator)."""
973
+ """The nested fields. Groups nest at most three levels deep."""
864
974
  nestedFields: [ContentFieldDefinitionInput!]!
865
975
  }
866
976
  ```
@@ -868,11 +978,9 @@ input GroupFieldInput {
868
978
  ### `ReferenceFieldInput`
869
979
 
870
980
  ```graphql
871
- """Per-kind input for `REFERENCE` fields."""
981
+ """The settings of a `REFERENCE` field."""
872
982
  input ReferenceFieldInput {
873
- """
874
- The target Content Model `key` whose entries may be referenced. Omit to allow any Content Model.
875
- """
983
+ """The key of the target model. Omit it to accept entries of any model."""
876
984
  contentModelKey: String
877
985
  }
878
986
  ```
@@ -880,11 +988,9 @@ input ReferenceFieldInput {
880
988
  ### `ContentEntryDataInput`
881
989
 
882
990
  ```graphql
883
- """
884
- A Content Entry data input — list of field values keyed by field key. Reused for nested groups and embedded Content Blocks.
885
- """
991
+ """The values of a content entry, a group, or an embedded block."""
886
992
  input ContentEntryDataInput {
887
- """The values keyed by field key."""
993
+ """The values, one per field."""
888
994
  values: [ContentFieldValueInput!]!
889
995
  }
890
996
  ```
@@ -893,48 +999,47 @@ input ContentEntryDataInput {
893
999
 
894
1000
  ```graphql
895
1001
  """
896
- One field-value input. The resolver matches the populated singular /
897
- plural pair against the parent schema's field type for `key`. Setting
898
- more than one populated pair is rejected with `INVALID_INPUT`.
1002
+ One value in a content entry. Set the member that matches the field's type: singular when the
1003
+ field is not repeatable, plural when it is. Markdown, slug and colour fields take `text`.
899
1004
  """
900
1005
  input ContentFieldValueInput {
901
- """The field key from the parent schema."""
1006
+ """The key of the field in the schema."""
902
1007
  key: String!
903
- """Singular text value."""
1008
+ """A text value."""
904
1009
  text: String
905
- """Plural text values."""
1010
+ """Text values."""
906
1011
  texts: [String!]
907
- """Singular number value."""
1012
+ """A number value."""
908
1013
  number: Float
909
- """Plural number values."""
1014
+ """Number values."""
910
1015
  numbers: [Float!]
911
- """Singular boolean value."""
1016
+ """A boolean value."""
912
1017
  boolean: Boolean
913
- """Plural boolean values."""
1018
+ """Boolean values."""
914
1019
  booleans: [Boolean!]
915
- """Singular date value."""
1020
+ """A date value."""
916
1021
  date: IsoDate
917
- """Plural date values."""
1022
+ """Date values."""
918
1023
  dates: [IsoDate!]
919
- """Singular JSON value."""
1024
+ """A JSON value."""
920
1025
  json: JSON
921
- """Plural JSON values."""
1026
+ """JSON values."""
922
1027
  jsons: [JSON!]
923
- """Singular Asset reference."""
1028
+ """An asset reference."""
924
1029
  assetRef: AssetRefInput
925
- """Plural Asset references."""
1030
+ """Asset references."""
926
1031
  assetRefs: [AssetRefInput!]
927
- """Singular embedded Content Block."""
1032
+ """An embedded block."""
928
1033
  block: EmbeddedContentBlockInput
929
- """Plural embedded Content Blocks."""
1034
+ """Embedded blocks."""
930
1035
  blocks: [EmbeddedContentBlockInput!]
931
- """Singular nested group value."""
1036
+ """The values of a group."""
932
1037
  group: ContentEntryDataInput
933
- """Plural nested group values."""
1038
+ """The values of each group."""
934
1039
  groups: [ContentEntryDataInput!]
935
- """Singular referenced Content Entry id."""
1040
+ """The ID of a referenced content entry."""
936
1041
  contentEntryId: ID
937
- """Plural referenced Content Entry ids."""
1042
+ """The IDs of referenced content entries."""
938
1043
  contentEntryIds: [ID!]
939
1044
  }
940
1045
  ```
@@ -942,13 +1047,11 @@ input ContentFieldValueInput {
942
1047
  ### `EmbeddedContentBlockInput`
943
1048
 
944
1049
  ```graphql
945
- """
946
- Input form of `EmbeddedContentBlock` — references a Content Block by id and supplies the block-shaped data.
947
- """
1050
+ """A block instance in a content entry value."""
948
1051
  input EmbeddedContentBlockInput {
949
- """The Content Block id to embed."""
1052
+ """The ID of the block to embed."""
950
1053
  contentBlockId: ID!
951
- """Block-shaped data, recursively typed."""
1054
+ """The values of the instance, typed by the block's schema."""
952
1055
  data: ContentEntryDataInput!
953
1056
  }
954
1057
  ```