@cloudcannon/configuration-types 0.0.53 → 0.0.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudcannon-collections.schema.json +956 -2187
- package/dist/cloudcannon-config.documentation.schema.json +487 -488
- package/dist/cloudcannon-config.latest.schema.json +248 -248
- package/dist/cloudcannon-config.legacy-eleventy.schema.json +312 -315
- package/dist/cloudcannon-config.legacy-hugo.schema.json +312 -315
- package/dist/cloudcannon-config.legacy-jekyll.schema.json +312 -315
- package/dist/cloudcannon-config.legacy-reader.schema.json +313 -316
- package/dist/cloudcannon-editables.schema.json +196 -332
- package/dist/cloudcannon-initial-site-settings.documentation.schema.json +15 -15
- package/dist/cloudcannon-initial-site-settings.schema.json +9 -9
- package/dist/cloudcannon-inputs.schema.json +177 -179
- package/dist/cloudcannon-routing.documentation.schema.json +23 -23
- package/dist/cloudcannon-routing.schema.json +13 -13
- package/dist/cloudcannon-schemas.schema.json +173 -173
- package/dist/cloudcannon-snippets-definitions.schema.json +21 -21
- package/dist/cloudcannon-snippets-imports.schema.json +55 -55
- package/dist/cloudcannon-snippets.schema.json +177 -177
- package/dist/cloudcannon-structure-value.schema.json +534 -533
- package/dist/cloudcannon-structures.schema.json +177 -179
- package/dist/documentation.json +10 -7
- package/package.json +4 -4
- package/src/inputs.ts +1 -4
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"title": "Structures",
|
|
4
|
-
"description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
|
|
5
3
|
"$id": "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-structures.schema.json",
|
|
6
4
|
"allOf": [
|
|
7
5
|
{
|
|
@@ -9,22 +7,7 @@
|
|
|
9
7
|
}
|
|
10
8
|
],
|
|
11
9
|
"definitions": {
|
|
12
|
-
"type._structures": {
|
|
13
|
-
"title": "Structures",
|
|
14
|
-
"description": "This key defines which structures are available for [Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/) and [Array\ninputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/) at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_structures` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/).\n\n## Examples\n\nIn this example, we want to populate an Array input in the `blog` Collection with Related Articles, including the `name`, `description`, and `url` fields.\n\n```yaml\ncollections_config:\n blog:\n _structures:\n related_articles:\n style: select\n values:\n - preview:\n text:\n - key: name\n subtext:\n - key: url\n value:\n name:\n description:\n url:\n```\n\nIn this example, we want to populate an Array input with Staff members, including the `name`, `job_description`, and `profile_picture` fields for all staff types, and the `url` field for Managers only.\n\n```yaml\n_structures:\n staff:\n style: modal\n hide_extra_inputs: false\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```",
|
|
15
|
-
"type": "object",
|
|
16
|
-
"propertyNames": {
|
|
17
|
-
"type": "string"
|
|
18
|
-
},
|
|
19
|
-
"additionalProperties": {
|
|
20
|
-
"$ref": "#/definitions/type.structure"
|
|
21
|
-
},
|
|
22
|
-
"documented": true,
|
|
23
|
-
"markdownDescription": "This key defines which structures are available for [Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/) and [Array\ninputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/) at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_structures` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/).\n\n## Examples\n\nIn this example, we want to populate an Array input in the `blog` Collection with Related Articles, including the `name`, `description`, and `url` fields.\n\n```yaml\ncollections_config:\n blog:\n _structures:\n related_articles:\n style: select\n values:\n - preview:\n text:\n - key: name\n subtext:\n - key: url\n value:\n name:\n description:\n url:\n```\n\nIn this example, we want to populate an Array input with Staff members, including the `name`, `job_description`, and `profile_picture` fields for all staff types, and the `url` field for Managers only.\n\n```yaml\n_structures:\n staff:\n style: modal\n hide_extra_inputs: false\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```"
|
|
24
|
-
},
|
|
25
10
|
"type.structure": {
|
|
26
|
-
"title": "Structure",
|
|
27
|
-
"description": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values.",
|
|
28
11
|
"type": "object",
|
|
29
12
|
"properties": {
|
|
30
13
|
"reorder_inputs": {
|
|
@@ -60,11 +43,11 @@
|
|
|
60
43
|
"markdownDescription": "This key toggles whether CloudCannon will remove inputs that are not present in a Structure from a file before loading it in an Editing Interface.\n\nSetting this key to `true` will remove inputs that are not present in a Structure from a file before loading it in an Editing Interface. Non-Structure inputs will not be visible in the [Visual Editor](https://cloudcannon.com/documentation/articles/what-is-the-visual-editor/), [Content\nEditor](https://cloudcannon.com/documentation/articles/what-is-the-content-editor/), or [Data Editor](https://cloudcannon.com/documentation/articles/what-is-the-data-editor/), and saving the file\nwill remove them from the file before persisting the changes to your Git repository.\n\nYou can also configure this behavior for specific values of a Structure using `values[*].remove_extra_inputs`.\n\n## Examples\n\nIn this example, we want to delete old inputs that are not in the Structure from the associated file.\n\n```yaml\n_structures:\n related_articles:\n remove_extra_inputs: true\n values:\n - value:\n name:\n description:\n url:\n```"
|
|
61
44
|
},
|
|
62
45
|
"values": {
|
|
63
|
-
"description": "This key defines the options available for a Structure.\n\nYou must define this key for the Structure to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add the `title`, `subtitle`, `author`, `featured_image`, and `url` fields to Object or Array inputs that reference this Structure.\n\n```yaml\n_structures:\n related_articles:\n values:\n - label: Blog\n id:\n default: true\n tabbed: false\n tags:\n - blog\n value:\n title:\n subtitle:\n author:\n featured_image:\n url:\n _inputs:\n featured_image:\n type: image\n options:\n width: 50\n height: 50\n groups:\n - heading: Titles\n inputs:\n - title\n - subtitle\n - heading: Details\n inputs:\n - author\n - image\n - url\n preview:\n text:\n - template: \"{title}\"\n subtext:\n - template: \"By {author}\"\n image:\n - key: image\n picker_preview:\n text: Blog\n subtext: Add a related blog\n icon: post_add\n```",
|
|
64
46
|
"type": "array",
|
|
65
47
|
"items": {
|
|
66
48
|
"$ref": "#/definitions/type.structure.values.[*]"
|
|
67
49
|
},
|
|
50
|
+
"description": "This key defines the options available for a Structure.\n\nYou must define this key for the Structure to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add the `title`, `subtitle`, `author`, `featured_image`, and `url` fields to Object or Array inputs that reference this Structure.\n\n```yaml\n_structures:\n related_articles:\n values:\n - label: Blog\n id:\n default: true\n tabbed: false\n tags:\n - blog\n value:\n title:\n subtitle:\n author:\n featured_image:\n url:\n _inputs:\n featured_image:\n type: image\n options:\n width: 50\n height: 50\n groups:\n - heading: Titles\n inputs:\n - title\n - subtitle\n - heading: Details\n inputs:\n - author\n - image\n - url\n preview:\n text:\n - template: \"{title}\"\n subtext:\n - template: \"By {author}\"\n image:\n - key: image\n picker_preview:\n text: Blog\n subtext: Add a related blog\n icon: post_add\n```",
|
|
68
51
|
"documented": true,
|
|
69
52
|
"title": "values",
|
|
70
53
|
"markdownDescription": "This key defines the options available for a Structure.\n\nYou must define this key for the Structure to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add the `title`, `subtitle`, `author`, `featured_image`, and `url` fields to Object or Array inputs that reference this Structure.\n\n```yaml\n_structures:\n related_articles:\n values:\n - label: Blog\n id:\n default: true\n tabbed: false\n tags:\n - blog\n value:\n title:\n subtitle:\n author:\n featured_image:\n url:\n _inputs:\n featured_image:\n type: image\n options:\n width: 50\n height: 50\n groups:\n - heading: Titles\n inputs:\n - title\n - subtitle\n - heading: Details\n inputs:\n - author\n - image\n - url\n preview:\n text:\n - template: \"{title}\"\n subtext:\n - template: \"By {author}\"\n image:\n - key: image\n picker_preview:\n text: Blog\n subtext: Add a related blog\n icon: post_add\n```"
|
|
@@ -108,12 +91,12 @@
|
|
|
108
91
|
"values"
|
|
109
92
|
],
|
|
110
93
|
"additionalProperties": false,
|
|
94
|
+
"title": "Structure",
|
|
95
|
+
"description": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values.",
|
|
111
96
|
"documented": true,
|
|
112
97
|
"markdownDescription": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values."
|
|
113
98
|
},
|
|
114
99
|
"type.structure.values.[*]": {
|
|
115
|
-
"title": "Structure Value",
|
|
116
|
-
"description": "This key represents a single value option within a structure, defining the data format and appearance for content editors.",
|
|
117
100
|
"type": "object",
|
|
118
101
|
"properties": {
|
|
119
102
|
"reorder_inputs": {
|
|
@@ -374,11 +357,12 @@
|
|
|
374
357
|
"value"
|
|
375
358
|
],
|
|
376
359
|
"additionalProperties": false,
|
|
360
|
+
"title": "Structure Value",
|
|
361
|
+
"description": "This key represents a single value option within a structure, defining the data format and appearance for content editors.",
|
|
377
362
|
"documented": true,
|
|
378
363
|
"markdownDescription": "This key represents a single value option within a structure, defining the data format and appearance for content editors."
|
|
379
364
|
},
|
|
380
365
|
"type.preview": {
|
|
381
|
-
"title": "Preview",
|
|
382
366
|
"type": "object",
|
|
383
367
|
"properties": {
|
|
384
368
|
"text": {
|
|
@@ -410,6 +394,7 @@
|
|
|
410
394
|
}
|
|
411
395
|
},
|
|
412
396
|
"additionalProperties": false,
|
|
397
|
+
"title": "Preview",
|
|
413
398
|
"documented": true,
|
|
414
399
|
"description": "This key defines the appearance of a Card.\n\nYou can configure Card preview for [Collections](https://cloudcannon.com/documentation/articles/what-is-a-collection/), [Schemas](https://cloudcannon.com/documentation/articles/what-is-a-schema/),\n[Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/), [Array inputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/), [Select\ninputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/), [Structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/), the Structure modal,\n[Snippets](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), and the Snippet modal.\n\nFor more information about previews, please read our documentation on [configuring card previews](https://cloudcannon.com/documentation/articles/configure-your-card-previews/).\n\n## Examples\n\nIn this example, we have configured the appearance of file Cards in the *Collection browser*.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n subtext:\n - key: author\n icon: edit_note\n icon_color:\n - key: color\n - '#ff0000'\n image:\n - key: image\n metadata:\n - template: [url]\n - icon: event\n text:\n - template: 'Published on {date|date_long}'\n gallery:\n - key: featured_image\n```\n\nIn this example, we have configured the appearance of Cards in inputs using the Structure `staff`.\n\n```yaml\n_structures:\n staff:\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```",
|
|
415
400
|
"markdownDescription": "This key defines the appearance of a Card.\n\nYou can configure Card preview for [Collections](https://cloudcannon.com/documentation/articles/what-is-a-collection/), [Schemas](https://cloudcannon.com/documentation/articles/what-is-a-schema/),\n[Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/), [Array inputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/), [Select\ninputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/), [Structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/), the Structure modal,\n[Snippets](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), and the Snippet modal.\n\nFor more information about previews, please read our documentation on [configuring card previews](https://cloudcannon.com/documentation/articles/configure-your-card-previews/).\n\n## Examples\n\nIn this example, we have configured the appearance of file Cards in the *Collection browser*.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n subtext:\n - key: author\n icon: edit_note\n icon_color:\n - key: color\n - '#ff0000'\n image:\n - key: image\n metadata:\n - template: [url]\n - icon: event\n text:\n - template: 'Published on {date|date_long}'\n gallery:\n - key: featured_image\n```\n\nIn this example, we have configured the appearance of Cards in inputs using the Structure `staff`.\n\n```yaml\n_structures:\n staff:\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```"
|
|
@@ -441,17 +426,16 @@
|
|
|
441
426
|
"title": "text(previewentries)"
|
|
442
427
|
},
|
|
443
428
|
"type.preview-entry.(array)": {
|
|
444
|
-
"title": "Array Preview Entry",
|
|
445
429
|
"type": "array",
|
|
446
430
|
"items": {
|
|
447
431
|
"$ref": "#/definitions/type.preview-entry"
|
|
448
432
|
},
|
|
433
|
+
"title": "Array Preview Entry",
|
|
449
434
|
"documented": true,
|
|
450
435
|
"description": "This key represents an array of preview entries for displaying data on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an array of preview entry objects, strings, or `false` values. Each preview entry object can contain a `key`, `template`, or `text` property. When multiple entries are provided, CloudCannon will use them in order as fallback options.\n\n## Examples\n\nIn this example, we have configured an array of preview entries with an array of values to provide fallback options. CloudCannon will use the value of `title` first, then the `{name}` template, and finally fall back to the static text value.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n - template: '{name}'\n - text: 'Untitled'\n```",
|
|
451
436
|
"markdownDescription": "This key represents an array of preview entries for displaying data on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an array of preview entry objects, strings, or `false` values. Each preview entry object can contain a `key`, `template`, or `text` property. When multiple entries are provided, CloudCannon will use them in order as fallback options.\n\n## Examples\n\nIn this example, we have configured an array of preview entries with an array of values to provide fallback options. CloudCannon will use the value of `title` first, then the `{name}` template, and finally fall back to the static text value.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n - template: '{name}'\n - text: 'Untitled'\n```"
|
|
452
437
|
},
|
|
453
438
|
"type.preview-entry": {
|
|
454
|
-
"title": "Preview Entry",
|
|
455
439
|
"anyOf": [
|
|
456
440
|
{
|
|
457
441
|
"$ref": "#/definitions/type.preview-entry.(key)"
|
|
@@ -469,17 +453,17 @@
|
|
|
469
453
|
"$ref": "#/definitions/type.preview-entry.(false)"
|
|
470
454
|
}
|
|
471
455
|
],
|
|
456
|
+
"title": "Preview Entry",
|
|
472
457
|
"documented": true,
|
|
473
458
|
"description": "This key defines a preview entry configuration for displaying data on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value can be an object with a `key`, `template`, or `text` property, a raw text string, `false`, or an array of these values. When multiple entries are provided, CloudCannon will use them in order as fallback options. Preview entries are used to configure how data is displayed in card previews.\n\n## Examples\n\nIn this example, we have configured a preview entry with an array of values to provide fallback options. CloudCannon will use the value of `title` first, then the `{name}` template, and finally fall back to the static text value.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n - template: '{name}'\n - text: 'Untitled'\n```\n\nIn this example, we have configured a preview entry to display the `title` key.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```",
|
|
474
459
|
"markdownDescription": "This key defines a preview entry configuration for displaying data on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value can be an object with a `key`, `template`, or `text` property, a raw text string, `false`, or an array of these values. When multiple entries are provided, CloudCannon will use them in order as fallback options. Preview entries are used to configure how data is displayed in card previews.\n\n## Examples\n\nIn this example, we have configured a preview entry with an array of values to provide fallback options. CloudCannon will use the value of `title` first, then the `{name}` template, and finally fall back to the static text value.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n - template: '{name}'\n - text: 'Untitled'\n```\n\nIn this example, we have configured a preview entry to display the `title` key.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```"
|
|
475
460
|
},
|
|
476
461
|
"type.preview-entry.(key)": {
|
|
477
|
-
"title": "Key Preview Entry",
|
|
478
462
|
"type": "object",
|
|
479
463
|
"properties": {
|
|
480
464
|
"key": {
|
|
481
|
-
"title": "Key Value",
|
|
482
465
|
"type": "string",
|
|
466
|
+
"title": "Key Value",
|
|
483
467
|
"documented": true,
|
|
484
468
|
"description": "This key defines the data key name to display in a key preview entry.\n\nThe value is a string that specifies the name of a data key whose value will be displayed on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the key value to display the `title` field.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```",
|
|
485
469
|
"markdownDescription": "This key defines the data key name to display in a key preview entry.\n\nThe value is a string that specifies the name of a data key whose value will be displayed on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the key value to display the `title` field.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```"
|
|
@@ -489,17 +473,17 @@
|
|
|
489
473
|
"key"
|
|
490
474
|
],
|
|
491
475
|
"additionalProperties": false,
|
|
476
|
+
"title": "Key Preview Entry",
|
|
492
477
|
"documented": true,
|
|
493
478
|
"description": "This key represents a key preview entry type for displaying data from a specific key on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `key` property with a string value. This displays the value of the specified data key in card previews.\n\n## Examples\n\nIn this example, we have configured a key preview entry to display the `title` key.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```",
|
|
494
479
|
"markdownDescription": "This key represents a key preview entry type for displaying data from a specific key on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `key` property with a string value. This displays the value of the specified data key in card previews.\n\n## Examples\n\nIn this example, we have configured a key preview entry to display the `title` key.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - key: title\n```"
|
|
495
480
|
},
|
|
496
481
|
"type.preview-entry.(template)": {
|
|
497
|
-
"title": "Template Preview Entry",
|
|
498
482
|
"type": "object",
|
|
499
483
|
"properties": {
|
|
500
484
|
"template": {
|
|
501
|
-
"title": "Template Value",
|
|
502
485
|
"type": "string",
|
|
486
|
+
"title": "Template Value",
|
|
503
487
|
"documented": true,
|
|
504
488
|
"description": "This key defines the template string to use in a template preview entry.\n\nThe value is a string that specifies a template with placeholders (e.g., `{name}`, `{date}`) that will be replaced with data values when displayed on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the template value to display author and date.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - template: '{author} - {date}'\n```",
|
|
505
489
|
"markdownDescription": "This key defines the template string to use in a template preview entry.\n\nThe value is a string that specifies a template with placeholders (e.g., `{name}`, `{date}`) that will be replaced with data values when displayed on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the template value to display author and date.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - template: '{author} - {date}'\n```"
|
|
@@ -509,17 +493,17 @@
|
|
|
509
493
|
"template"
|
|
510
494
|
],
|
|
511
495
|
"additionalProperties": false,
|
|
496
|
+
"title": "Template Preview Entry",
|
|
512
497
|
"documented": true,
|
|
513
498
|
"description": "This key represents a template preview entry type for displaying formatted text using a template on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `template` property with a string value. This displays formatted text using template syntax (e.g., `{name}`) in card previews.\n\n## Examples\n\nIn this example, we have configured a template preview entry to display formatted text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - template: '{author} - {date}'\n```",
|
|
514
499
|
"markdownDescription": "This key represents a template preview entry type for displaying formatted text using a template on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `template` property with a string value. This displays formatted text using template syntax (e.g., `{name}`) in card previews.\n\n## Examples\n\nIn this example, we have configured a template preview entry to display formatted text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - template: '{author} - {date}'\n```"
|
|
515
500
|
},
|
|
516
501
|
"type.preview-entry.(text)": {
|
|
517
|
-
"title": "Text Preview Entry",
|
|
518
502
|
"type": "object",
|
|
519
503
|
"properties": {
|
|
520
504
|
"text": {
|
|
521
|
-
"title": "Text Value",
|
|
522
505
|
"type": "string",
|
|
506
|
+
"title": "Text Value",
|
|
523
507
|
"documented": true,
|
|
524
508
|
"description": "This key defines the static text string to display in a text preview entry.\n\nThe value is a string that specifies static text to display on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the text value to display a static fallback message.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - text: 'Untitled'\n```",
|
|
525
509
|
"markdownDescription": "This key defines the static text string to display in a text preview entry.\n\nThe value is a string that specifies static text to display on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\n## Examples\n\nIn this example, we have configured the text value to display a static fallback message.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - text: 'Untitled'\n```"
|
|
@@ -529,21 +513,22 @@
|
|
|
529
513
|
"text"
|
|
530
514
|
],
|
|
531
515
|
"additionalProperties": false,
|
|
516
|
+
"title": "Text Preview Entry",
|
|
532
517
|
"documented": true,
|
|
533
518
|
"description": "This key represents a text preview entry type for displaying static text on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `text` property with a string value. This displays static text in card previews.\n\n## Examples\n\nIn this example, we have configured a text preview entry to display static text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - text: 'Untitled'\n```",
|
|
534
519
|
"markdownDescription": "This key represents a text preview entry type for displaying static text on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is an object that contains a `text` property with a string value. This displays static text in card previews.\n\n## Examples\n\nIn this example, we have configured a text preview entry to display static text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text:\n - text: 'Untitled'\n```"
|
|
535
520
|
},
|
|
536
521
|
"type.preview-entry.(raw-text)": {
|
|
537
|
-
"title": "Raw Text Preview Entry",
|
|
538
522
|
"type": "string",
|
|
523
|
+
"title": "Raw Text Preview Entry",
|
|
539
524
|
"documented": true,
|
|
540
525
|
"description": "This key represents a raw text preview entry type for displaying static text on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is a string that specifies static text to display in card previews. This is equivalent to using `{ text: \"...\" }` but in a simpler format.\n\n## Examples\n\nIn this example, we have configured a raw text preview entry to display static text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text: 'Untitled'\n```",
|
|
541
526
|
"markdownDescription": "This key represents a raw text preview entry type for displaying static text on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value is a string that specifies static text to display in card previews. This is equivalent to using `{ text: \"...\" }` but in a simpler format.\n\n## Examples\n\nIn this example, we have configured a raw text preview entry to display static text.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text: 'Untitled'\n```"
|
|
542
527
|
},
|
|
543
528
|
"type.preview-entry.(false)": {
|
|
544
|
-
"title": "False Preview Entry",
|
|
545
529
|
"type": "boolean",
|
|
546
530
|
"const": false,
|
|
531
|
+
"title": "False Preview Entry",
|
|
547
532
|
"documented": true,
|
|
548
533
|
"description": "This key represents a preview entry that disables the preview display for a specific field on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value must be `false`. Setting a preview entry to `false` will hide that preview element.\n\n## Examples\n\nIn this example, we have configured the preview text to be disabled.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text: false\n```",
|
|
549
534
|
"markdownDescription": "This key represents a preview entry that disables the preview display for a specific field on *Cards* in the *Collection browser*, *Structures*, and *Snippets*.\n\nThe value must be `false`. Setting a preview entry to `false` will hide that preview element.\n\n## Examples\n\nIn this example, we have configured the preview text to be disabled.\n\n```yaml\ncollections_config:\n blog:\n preview:\n text: false\n```"
|
|
@@ -720,8 +705,6 @@
|
|
|
720
705
|
"markdownDescription": "This key defines the appearance of a Card when choosing an item to create. This uses `preview` as a base, and keys inside this object are overrides.\n\nYou can configure Card preview for [Collections](https://cloudcannon.com/documentation/articles/what-is-a-collection/), [Schemas](https://cloudcannon.com/documentation/articles/what-is-a-schema/),\n[Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/), [Array inputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/), [Select\ninputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/), [Structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/), the Structure modal,\n[Snippets](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), and the Snippet modal.\n\nFor more information about previews, please read our documentation on [configuring card previews](https://cloudcannon.com/documentation/articles/configure-your-card-previews/).\n\n## Examples\n\nIn this example, we have configured the appearance of Cards in inputs using the Structure `staff` when adding items.\n\n```yaml\n_structures:\n staff:\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n picker_preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n picker_preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```"
|
|
721
706
|
},
|
|
722
707
|
"type._inputs": {
|
|
723
|
-
"title": "Inputs",
|
|
724
|
-
"description": "This key defines which inputs are available at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_inputs` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured the `date_created` key as a *Date and Time Input*, which will automatically populate when you create a file using this input. Editors cannot alter this input as the interface is disabled.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n comment: UTC +0 timezone\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n hidden: false\n disabled: true\n instance_value: NOW\n cascade: true\n options:\n timezone: Etc/UTC\n```\n\nIn this example, we have configured the `blog_tags` key as a *Multiselect Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n blog_tags:\n type: multiselect\n label: Blog type\n comment: Select a blog type\n context:\n open: false\n title: Help\n icon: help\n content: |\n Blog tags help our users filter articles by topic.\n options:\n values:\n - Opinion\n - Feature\n - Resource\n```",
|
|
725
708
|
"type": "object",
|
|
726
709
|
"propertyNames": {
|
|
727
710
|
"type": "string"
|
|
@@ -729,15 +712,14 @@
|
|
|
729
712
|
"additionalProperties": {
|
|
730
713
|
"$ref": "#/definitions/Input"
|
|
731
714
|
},
|
|
715
|
+
"title": "Inputs",
|
|
716
|
+
"description": "This key defines which inputs are available at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_inputs` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured the `date_created` key as a *Date and Time Input*, which will automatically populate when you create a file using this input. Editors cannot alter this input as the interface is disabled.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n comment: UTC +0 timezone\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n hidden: false\n disabled: true\n instance_value: NOW\n cascade: true\n options:\n timezone: Etc/UTC\n```\n\nIn this example, we have configured the `blog_tags` key as a *Multiselect Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n blog_tags:\n type: multiselect\n label: Blog type\n comment: Select a blog type\n context:\n open: false\n title: Help\n icon: help\n content: |\n Blog tags help our users filter articles by topic.\n options:\n values:\n - Opinion\n - Feature\n - Resource\n```",
|
|
732
717
|
"documented": true,
|
|
733
718
|
"markdownDescription": "This key defines which inputs are available at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_inputs` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured the `date_created` key as a *Date and Time Input*, which will automatically populate when you create a file using this input. Editors cannot alter this input as the interface is disabled.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n comment: UTC +0 timezone\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n hidden: false\n disabled: true\n instance_value: NOW\n cascade: true\n options:\n timezone: Etc/UTC\n```\n\nIn this example, we have configured the `blog_tags` key as a *Multiselect Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n blog_tags:\n type: multiselect\n label: Blog type\n comment: Select a blog type\n context:\n open: false\n title: Help\n icon: help\n content: |\n Blog tags help our users filter articles by topic.\n options:\n values:\n - Opinion\n - Feature\n - Resource\n```"
|
|
734
719
|
},
|
|
735
720
|
"Input": {
|
|
736
|
-
"title": "Input",
|
|
737
721
|
"anyOf": [
|
|
738
722
|
{
|
|
739
|
-
"title": "Known Input",
|
|
740
|
-
"description": "This key defines an input configuration at a given level of the configuration cascade.\n\nThe value is an object that can contain `type`, `label`, `options`, `disabled`, `hidden`, and other input-specific properties. Each input configuration defines how team members interact with data in the *Data Editor*.\n\nFor more information, please read our documentation on [inputs](https://cloudcannon.com/documentation/articles/what-are-inputs/).\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n title:\n type: text\n label: Title\n```",
|
|
741
723
|
"oneOf": [
|
|
742
724
|
{
|
|
743
725
|
"$ref": "#/definitions/TextInput"
|
|
@@ -797,6 +779,8 @@
|
|
|
797
779
|
"$ref": "#/definitions/AutoInput"
|
|
798
780
|
}
|
|
799
781
|
],
|
|
782
|
+
"title": "Known Input",
|
|
783
|
+
"description": "This key defines an input configuration at a given level of the configuration cascade.\n\nThe value is an object that can contain `type`, `label`, `options`, `disabled`, `hidden`, and other input-specific properties. Each input configuration defines how team members interact with data in the *Data Editor*.\n\nFor more information, please read our documentation on [inputs](https://cloudcannon.com/documentation/articles/what-are-inputs/).\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n title:\n type: text\n label: Title\n```",
|
|
800
784
|
"documented": true,
|
|
801
785
|
"markdownDescription": "This key defines an input configuration at a given level of the configuration cascade.\n\nThe value is an object that can contain `type`, `label`, `options`, `disabled`, `hidden`, and other input-specific properties. Each input configuration defines how team members interact with data in the *Data Editor*.\n\nFor more information, please read our documentation on [inputs](https://cloudcannon.com/documentation/articles/what-are-inputs/).\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n title:\n type: text\n label: Title\n```"
|
|
802
786
|
},
|
|
@@ -804,13 +788,12 @@
|
|
|
804
788
|
"$ref": "#/definitions/UnknownInput"
|
|
805
789
|
}
|
|
806
790
|
],
|
|
791
|
+
"title": "Input",
|
|
807
792
|
"documented": true,
|
|
808
793
|
"description": "This key defines an input configuration at a given level of the configuration cascade.\n\nThe value is an object that can contain `type`, `label`, `options`, `disabled`, `hidden`, and other input-specific properties. Each input configuration defines how team members interact with data in the *Data Editor*.\n\nFor more information, please read our documentation on [inputs](https://cloudcannon.com/documentation/articles/what-are-inputs/).\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n title:\n type: text\n label: Title\n```",
|
|
809
794
|
"markdownDescription": "This key defines an input configuration at a given level of the configuration cascade.\n\nThe value is an object that can contain `type`, `label`, `options`, `disabled`, `hidden`, and other input-specific properties. Each input configuration defines how team members interact with data in the *Data Editor*.\n\nFor more information, please read our documentation on [inputs](https://cloudcannon.com/documentation/articles/what-are-inputs/).\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _inputs:\n title:\n type: text\n label: Title\n```"
|
|
810
795
|
},
|
|
811
796
|
"TextInput": {
|
|
812
|
-
"title": "Text Input",
|
|
813
|
-
"description": "This key defines a simple editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input*.\n\n```yaml\n_inputs:\n title:\n type: text\n label: Blog Title\n```",
|
|
814
797
|
"type": "object",
|
|
815
798
|
"properties": {
|
|
816
799
|
"comment": {
|
|
@@ -855,8 +838,6 @@
|
|
|
855
838
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
856
839
|
},
|
|
857
840
|
"type": {
|
|
858
|
-
"title": "Type",
|
|
859
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* type.\n\n```yaml\n_inputs:\n title:\n type: text\n```",
|
|
860
841
|
"type": "string",
|
|
861
842
|
"enum": [
|
|
862
843
|
"text",
|
|
@@ -868,11 +849,12 @@
|
|
|
868
849
|
"github",
|
|
869
850
|
"instagram"
|
|
870
851
|
],
|
|
852
|
+
"title": "Type",
|
|
853
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* type.\n\n```yaml\n_inputs:\n title:\n type: text\n```",
|
|
871
854
|
"documented": true,
|
|
872
855
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input* type.\n\n```yaml\n_inputs:\n title:\n type: text\n```"
|
|
873
856
|
},
|
|
874
857
|
"options": {
|
|
875
|
-
"description": "This key defines options that are specific to Text Inputs.\n\n## Examples\n\nIn this example, we have configured *Text Input* options including comment and icon.\n\n```yaml\n_inputs:\n title:\n type: text\n options:\n comment: Enter a title\n icon: title\n```",
|
|
876
858
|
"type": "object",
|
|
877
859
|
"properties": {
|
|
878
860
|
"max_length": {
|
|
@@ -980,6 +962,7 @@
|
|
|
980
962
|
}
|
|
981
963
|
},
|
|
982
964
|
"additionalProperties": false,
|
|
965
|
+
"description": "This key defines options that are specific to Text Inputs.\n\n## Examples\n\nIn this example, we have configured *Text Input* options including comment and icon.\n\n```yaml\n_inputs:\n title:\n type: text\n options:\n comment: Enter a title\n icon: title\n```",
|
|
983
966
|
"documented": true,
|
|
984
967
|
"title": "options",
|
|
985
968
|
"markdownDescription": "This key defines options that are specific to Text Inputs.\n\n## Examples\n\nIn this example, we have configured *Text Input* options including comment and icon.\n\n```yaml\n_inputs:\n title:\n type: text\n options:\n comment: Enter a title\n icon: title\n```"
|
|
@@ -989,6 +972,8 @@
|
|
|
989
972
|
"type"
|
|
990
973
|
],
|
|
991
974
|
"additionalProperties": false,
|
|
975
|
+
"title": "Text Input",
|
|
976
|
+
"description": "This key defines a simple editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input*.\n\n```yaml\n_inputs:\n title:\n type: text\n label: Blog Title\n```",
|
|
992
977
|
"documented": true,
|
|
993
978
|
"markdownDescription": "This key defines a simple editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `title` key as a *Text Input*.\n\n```yaml\n_inputs:\n title:\n type: text\n label: Blog Title\n```"
|
|
994
979
|
},
|
|
@@ -1000,7 +985,6 @@
|
|
|
1000
985
|
"markdownDescription": "This key defines the subtitle text above an Input.\n\nCloudCannon supports a limited selection of Markdown formatting for the value of this key: links, bold, italic, subscript, superscript, and inline\ncode.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add helpful guidance for our `page_description` Input.\n\n```yaml\n_inputs:\n page_description:\n type: text\n label: Page Description\n comment: Enter a brief description of this page for search engines\n```"
|
|
1001
986
|
},
|
|
1002
987
|
"type._inputs.*.context": {
|
|
1003
|
-
"description": "This key defines a context box for extra information about an Input.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add a context box to our `date_created` Input to explain its purpose.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n instance_value: NOW\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n```",
|
|
1004
988
|
"type": "object",
|
|
1005
989
|
"properties": {
|
|
1006
990
|
"content": {
|
|
@@ -1038,13 +1022,12 @@
|
|
|
1038
1022
|
}
|
|
1039
1023
|
},
|
|
1040
1024
|
"additionalProperties": false,
|
|
1025
|
+
"description": "This key defines a context box for extra information about an Input.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add a context box to our `date_created` Input to explain its purpose.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n instance_value: NOW\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n```",
|
|
1041
1026
|
"documented": true,
|
|
1042
1027
|
"title": "context",
|
|
1043
1028
|
"markdownDescription": "This key defines a context box for extra information about an Input.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we want to add a context box to our `date_created` Input to explain its purpose.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n instance_value: NOW\n context:\n open: false\n title: Help\n icon: help\n content: This date field will automatically populate when you create an article.\n```"
|
|
1044
1029
|
},
|
|
1045
1030
|
"icon": {
|
|
1046
|
-
"title": "Icon",
|
|
1047
|
-
"description": "Material Symbol icon names available in CloudCannon for UI elements and content previews.",
|
|
1048
1031
|
"type": "string",
|
|
1049
1032
|
"enum": [
|
|
1050
1033
|
"123",
|
|
@@ -4632,17 +4615,17 @@
|
|
|
4632
4615
|
"zoom_out",
|
|
4633
4616
|
"zoom_out_map"
|
|
4634
4617
|
],
|
|
4618
|
+
"title": "Icon",
|
|
4619
|
+
"description": "Material Symbol icon names available in CloudCannon for UI elements and content previews.",
|
|
4635
4620
|
"documented": false,
|
|
4636
4621
|
"markdownDescription": "Material Symbol icon names available in CloudCannon for UI elements and content previews."
|
|
4637
4622
|
},
|
|
4638
4623
|
"type.documentation": {
|
|
4639
|
-
"title": "Documentation",
|
|
4640
|
-
"description": "This key defines the documentation link at the top of a *Collection browser*.\n\nCollection documentation is useful for assisting your team members.\n\n## Examples\n\nIn this example, the documentation link for the `data` Collection goes to [CloudCannon Documentation](https://cloudcannon.com/documentation/).\n\n```yaml\ncollections_config:\n data:\n documentation:\n url: https://cloudcannon.com/documentation/\n text: CloudCannon Documentation\n icon: star\n```",
|
|
4641
4624
|
"type": "object",
|
|
4642
4625
|
"properties": {
|
|
4643
4626
|
"url": {
|
|
4644
|
-
"description": "This key defines the URL for the documentation link at the top of a *Collection browser*.\n\nYou must define this key for the\n`documentation` object to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have configured the `blog` Collection documentation link to go to `example.com`.\n\n```yaml\ncollections_config:\n blog:\n documentation:\n url: https://example.com\n```",
|
|
4645
4627
|
"type": "string",
|
|
4628
|
+
"description": "This key defines the URL for the documentation link at the top of a *Collection browser*.\n\nYou must define this key for the\n`documentation` object to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have configured the `blog` Collection documentation link to go to `example.com`.\n\n```yaml\ncollections_config:\n blog:\n documentation:\n url: https://example.com\n```",
|
|
4646
4629
|
"documented": true,
|
|
4647
4630
|
"title": "url",
|
|
4648
4631
|
"markdownDescription": "This key defines the URL for the documentation link at the top of a *Collection browser*.\n\nYou must define this key for the\n`documentation` object to function.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have configured the `blog` Collection documentation link to go to `example.com`.\n\n```yaml\ncollections_config:\n blog:\n documentation:\n url: https://example.com\n```"
|
|
@@ -4671,6 +4654,8 @@
|
|
|
4671
4654
|
"url"
|
|
4672
4655
|
],
|
|
4673
4656
|
"additionalProperties": false,
|
|
4657
|
+
"title": "Documentation",
|
|
4658
|
+
"description": "This key defines the documentation link at the top of a *Collection browser*.\n\nCollection documentation is useful for assisting your team members.\n\n## Examples\n\nIn this example, the documentation link for the `data` Collection goes to [CloudCannon Documentation](https://cloudcannon.com/documentation/).\n\n```yaml\ncollections_config:\n data:\n documentation:\n url: https://cloudcannon.com/documentation/\n text: CloudCannon Documentation\n icon: star\n```",
|
|
4674
4659
|
"documented": true,
|
|
4675
4660
|
"markdownDescription": "This key defines the documentation link at the top of a *Collection browser*.\n\nCollection documentation is useful for assisting your team members.\n\n## Examples\n\nIn this example, the documentation link for the `data` Collection goes to [CloudCannon Documentation](https://cloudcannon.com/documentation/).\n\n```yaml\ncollections_config:\n data:\n documentation:\n url: https://cloudcannon.com/documentation/\n text: CloudCannon Documentation\n icon: star\n```"
|
|
4676
4661
|
},
|
|
@@ -4686,15 +4671,15 @@
|
|
|
4686
4671
|
"default": false,
|
|
4687
4672
|
"anyOf": [
|
|
4688
4673
|
{
|
|
4689
|
-
"title": "Boolean Hidden",
|
|
4690
4674
|
"type": "boolean",
|
|
4675
|
+
"title": "Boolean Hidden",
|
|
4691
4676
|
"documented": true,
|
|
4692
4677
|
"description": "This key represents a boolean value for the `hidden` key that toggles whether CloudCannon hides an input from view.\n\nWhen set to `true`, CloudCannon hides the input from the *Data Editor* and the sidebar of the *Visual Editor* or *Content Editor*. The input still exists in the file and can be edited in the *Source Editor*.\n\nWhen set to `false`, CloudCannon displays the input normally.\n\nBy default, this key follows the input naming convention where key names beginning with an underscore are hidden (`true`). Otherwise, this key defaults to `false` (i.e., the input is visible).\n\n## Examples\n\nIn this example, we have configured an input to be hidden using a boolean value, making it only editable in the *Source Editor*.\n\n```yaml\n_inputs:\n internal_id:\n type: text\n label: Internal ID\n hidden: true\n```",
|
|
4693
4678
|
"markdownDescription": "This key represents a boolean value for the `hidden` key that toggles whether CloudCannon hides an input from view.\n\nWhen set to `true`, CloudCannon hides the input from the *Data Editor* and the sidebar of the *Visual Editor* or *Content Editor*. The input still exists in the file and can be edited in the *Source Editor*.\n\nWhen set to `false`, CloudCannon displays the input normally.\n\nBy default, this key follows the input naming convention where key names beginning with an underscore are hidden (`true`). Otherwise, this key defaults to `false` (i.e., the input is visible).\n\n## Examples\n\nIn this example, we have configured an input to be hidden using a boolean value, making it only editable in the *Source Editor*.\n\n```yaml\n_inputs:\n internal_id:\n type: text\n label: Internal ID\n hidden: true\n```"
|
|
4694
4679
|
},
|
|
4695
4680
|
{
|
|
4696
|
-
"title": "Query String Hidden",
|
|
4697
4681
|
"type": "string",
|
|
4682
|
+
"title": "Query String Hidden",
|
|
4698
4683
|
"documented": true,
|
|
4699
4684
|
"description": "This key represents a query string value for the `hidden` key that conditionally hides an input based on another input's value.\n\nThe value is a string that references a sibling input key name. CloudCannon evaluates the referenced input's value to determine whether to hide this input.\n\nWhen the referenced input is truthy, CloudCannon hides this input. You can reverse this behavior by prefixing the string with `!`.\n\nFor reverse values in YAML files, the string should be wrapped in single or double quotation marks.\n\n## Examples\n\nIn this example, we have configured an input to be hidden when the `published` input is truthy.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n draft_notes:\n type: textarea\n label: Draft notes\n hidden: published\n```\n\nIn this example, we have configured an input to be hidden when the `published` input is falsy using the `!` prefix.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n publish_date:\n type: datetime\n label: Publish date\n hidden: '!published'\n```",
|
|
4700
4685
|
"markdownDescription": "This key represents a query string value for the `hidden` key that conditionally hides an input based on another input's value.\n\nThe value is a string that references a sibling input key name. CloudCannon evaluates the referenced input's value to determine whether to hide this input.\n\nWhen the referenced input is truthy, CloudCannon hides this input. You can reverse this behavior by prefixing the string with `!`.\n\nFor reverse values in YAML files, the string should be wrapped in single or double quotation marks.\n\n## Examples\n\nIn this example, we have configured an input to be hidden when the `published` input is truthy.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n draft_notes:\n type: textarea\n label: Draft notes\n hidden: published\n```\n\nIn this example, we have configured an input to be hidden when the `published` input is falsy using the `!` prefix.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n publish_date:\n type: datetime\n label: Publish date\n hidden: '!published'\n```"
|
|
@@ -4709,15 +4694,15 @@
|
|
|
4709
4694
|
"default": false,
|
|
4710
4695
|
"anyOf": [
|
|
4711
4696
|
{
|
|
4712
|
-
"title": "Boolean",
|
|
4713
4697
|
"type": "boolean",
|
|
4698
|
+
"title": "Boolean",
|
|
4714
4699
|
"documented": true,
|
|
4715
4700
|
"description": "This key represents a boolean value for the `disabled` key that toggles whether CloudCannon prevents editing of an input value.\n\nWhen set to `true`, CloudCannon prevents team members from editing the input value in the *Data Editor* or the sidebar of the *Visual Editor* or *Content Editor*. The input value is still displayed but cannot be modified outside of the *Source Editor*.\n\nWhen set to `false`, team members can edit the input value normally.\n\nBy default, this key is `false` (i.e., team members can edit input values).\n\n## Examples\n\nIn this example, we have configured a datetime input to be disabled using a boolean value, preventing editors from modifying the automatically generated date.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n disabled: true\n instance_value: NOW\n```",
|
|
4716
4701
|
"markdownDescription": "This key represents a boolean value for the `disabled` key that toggles whether CloudCannon prevents editing of an input value.\n\nWhen set to `true`, CloudCannon prevents team members from editing the input value in the *Data Editor* or the sidebar of the *Visual Editor* or *Content Editor*. The input value is still displayed but cannot be modified outside of the *Source Editor*.\n\nWhen set to `false`, team members can edit the input value normally.\n\nBy default, this key is `false` (i.e., team members can edit input values).\n\n## Examples\n\nIn this example, we have configured a datetime input to be disabled using a boolean value, preventing editors from modifying the automatically generated date.\n\n```yaml\n_inputs:\n date_created:\n type: datetime\n label: Date of article creation\n disabled: true\n instance_value: NOW\n```"
|
|
4717
4702
|
},
|
|
4718
4703
|
{
|
|
4719
|
-
"title": "Query String",
|
|
4720
4704
|
"type": "string",
|
|
4705
|
+
"title": "Query String",
|
|
4721
4706
|
"documented": true,
|
|
4722
4707
|
"description": "This key represents a query string value for the `disabled` key that conditionally prevents editing of an input value based on another input's value.\n\nThe value is a string that references a sibling input key name. CloudCannon evaluates the referenced input's value to determine whether to disable this input.\n\nWhen the referenced input is truthy, CloudCannon disables this input. You can reverse this behavior by prefixing the string with `!`.\n\nFor reverse values in YAML files, the string should be wrapped in single or double quotation marks.\n\n## Examples\n\nIn this example, we have configured an input to be disabled when the `published` input is truthy.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n edit_date:\n type: datetime\n label: Last edited\n disabled: published\n```\n\nIn this example, we have configured an input to be disabled when the `published` input is falsy using the `!` prefix.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n draft_notes:\n type: textarea\n label: Draft notes\n disabled: '!published'\n```",
|
|
4723
4708
|
"markdownDescription": "This key represents a query string value for the `disabled` key that conditionally prevents editing of an input value based on another input's value.\n\nThe value is a string that references a sibling input key name. CloudCannon evaluates the referenced input's value to determine whether to disable this input.\n\nWhen the referenced input is truthy, CloudCannon disables this input. You can reverse this behavior by prefixing the string with `!`.\n\nFor reverse values in YAML files, the string should be wrapped in single or double quotation marks.\n\n## Examples\n\nIn this example, we have configured an input to be disabled when the `published` input is truthy.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n edit_date:\n type: datetime\n label: Last edited\n disabled: published\n```\n\nIn this example, we have configured an input to be disabled when the `published` input is falsy using the `!` prefix.\n\n```yaml\n_inputs:\n published:\n type: checkbox\n label: Published\n draft_notes:\n type: textarea\n label: Draft notes\n disabled: '!published'\n```"
|
|
@@ -4933,8 +4918,8 @@
|
|
|
4933
4918
|
"markdownDescription": "This key defines a custom error message that explains why a value has failed the validation criteria from `options.required`.\n\nThis key requires you to define `options.required`.\n\nThis key has no default.\n\nThis key is available for Array, Code, Color, Date and Time, File, Number, Object, Select and Multiselect, Text, Rich Text, and URL Inputs.\n\n## Examples\n\nIn this example, we prompt our team to use enter an Input value using a required message.\n\n```yaml\n_inputs:\n author:\n type: text\n comment: Enter the name of the author for this blog post.\n options:\n required: true\n required_message: You are not allowed to leave this blank.\n```"
|
|
4934
4919
|
},
|
|
4935
4920
|
"type._inputs.*.options.empty_type(text)": {
|
|
4936
|
-
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.",
|
|
4937
4921
|
"default": "null",
|
|
4922
|
+
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.",
|
|
4938
4923
|
"type": "string",
|
|
4939
4924
|
"enum": [
|
|
4940
4925
|
"null",
|
|
@@ -4945,8 +4930,6 @@
|
|
|
4945
4930
|
"markdownDescription": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values."
|
|
4946
4931
|
},
|
|
4947
4932
|
"TextareaInput": {
|
|
4948
|
-
"title": "Textarea Input",
|
|
4949
|
-
"description": "This key defines an editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input*.\n\n```yaml\n_inputs:\n description:\n type: textarea\n label: Description\n```",
|
|
4950
4933
|
"type": "object",
|
|
4951
4934
|
"properties": {
|
|
4952
4935
|
"comment": {
|
|
@@ -4991,15 +4974,14 @@
|
|
|
4991
4974
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
4992
4975
|
},
|
|
4993
4976
|
"type": {
|
|
4994
|
-
"title": "Type",
|
|
4995
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input* type.\n\n```yaml\n_inputs:\n description:\n type: textarea\n```",
|
|
4996
4977
|
"type": "string",
|
|
4997
4978
|
"const": "textarea",
|
|
4979
|
+
"title": "Type",
|
|
4980
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input* type.\n\n```yaml\n_inputs:\n description:\n type: textarea\n```",
|
|
4998
4981
|
"documented": true,
|
|
4999
4982
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input* type.\n\n```yaml\n_inputs:\n description:\n type: textarea\n```"
|
|
5000
4983
|
},
|
|
5001
4984
|
"options": {
|
|
5002
|
-
"description": "This key defines options that are specific to Textarea Inputs.\n\n## Examples\n\nIn this example, we have configured *Textarea Input* options including comment and character count.\n\n```yaml\n_inputs:\n description:\n type: textarea\n options:\n comment: Enter a description\n show_count: true\n```",
|
|
5003
4985
|
"type": "object",
|
|
5004
4986
|
"properties": {
|
|
5005
4987
|
"max_length": {
|
|
@@ -5082,6 +5064,7 @@
|
|
|
5082
5064
|
}
|
|
5083
5065
|
},
|
|
5084
5066
|
"additionalProperties": false,
|
|
5067
|
+
"description": "This key defines options that are specific to Textarea Inputs.\n\n## Examples\n\nIn this example, we have configured *Textarea Input* options including comment and character count.\n\n```yaml\n_inputs:\n description:\n type: textarea\n options:\n comment: Enter a description\n show_count: true\n```",
|
|
5085
5068
|
"documented": true,
|
|
5086
5069
|
"title": "options",
|
|
5087
5070
|
"markdownDescription": "This key defines options that are specific to Textarea Inputs.\n\n## Examples\n\nIn this example, we have configured *Textarea Input* options including comment and character count.\n\n```yaml\n_inputs:\n description:\n type: textarea\n options:\n comment: Enter a description\n show_count: true\n```"
|
|
@@ -5091,12 +5074,12 @@
|
|
|
5091
5074
|
"type"
|
|
5092
5075
|
],
|
|
5093
5076
|
"additionalProperties": false,
|
|
5077
|
+
"title": "Textarea Input",
|
|
5078
|
+
"description": "This key defines an editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input*.\n\n```yaml\n_inputs:\n description:\n type: textarea\n label: Description\n```",
|
|
5094
5079
|
"documented": true,
|
|
5095
5080
|
"markdownDescription": "This key defines an editing interface for plain text.\n\n## Examples\n\nIn this example, we have configured the `description` key as a *Textarea Input*.\n\n```yaml\n_inputs:\n description:\n type: textarea\n label: Description\n```"
|
|
5096
5081
|
},
|
|
5097
5082
|
"CodeInput": {
|
|
5098
|
-
"title": "Code Input",
|
|
5099
|
-
"description": "This key defines an editing interface for code or mono-spaced plain text content.",
|
|
5100
5083
|
"type": "object",
|
|
5101
5084
|
"properties": {
|
|
5102
5085
|
"comment": {
|
|
@@ -5141,15 +5124,14 @@
|
|
|
5141
5124
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5142
5125
|
},
|
|
5143
5126
|
"type": {
|
|
5144
|
-
"title": "Type",
|
|
5145
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5146
5127
|
"type": "string",
|
|
5147
5128
|
"const": "code",
|
|
5129
|
+
"title": "Type",
|
|
5130
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5148
5131
|
"documented": true,
|
|
5149
5132
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5150
5133
|
},
|
|
5151
5134
|
"options": {
|
|
5152
|
-
"description": "This key defines options that are specific to Code Inputs.",
|
|
5153
5135
|
"type": "object",
|
|
5154
5136
|
"properties": {
|
|
5155
5137
|
"tab_size": {
|
|
@@ -5278,6 +5260,7 @@
|
|
|
5278
5260
|
}
|
|
5279
5261
|
},
|
|
5280
5262
|
"additionalProperties": false,
|
|
5263
|
+
"description": "This key defines options that are specific to Code Inputs.",
|
|
5281
5264
|
"documented": true,
|
|
5282
5265
|
"title": "options",
|
|
5283
5266
|
"markdownDescription": "This key defines options that are specific to Code Inputs."
|
|
@@ -5287,6 +5270,8 @@
|
|
|
5287
5270
|
"type"
|
|
5288
5271
|
],
|
|
5289
5272
|
"additionalProperties": false,
|
|
5273
|
+
"title": "Code Input",
|
|
5274
|
+
"description": "This key defines an editing interface for code or mono-spaced plain text content.",
|
|
5290
5275
|
"documented": true,
|
|
5291
5276
|
"markdownDescription": "This key defines an editing interface for code or mono-spaced plain text content."
|
|
5292
5277
|
},
|
|
@@ -5323,8 +5308,6 @@
|
|
|
5323
5308
|
"title": "theme(theme)"
|
|
5324
5309
|
},
|
|
5325
5310
|
"Syntax": {
|
|
5326
|
-
"title": "Syntax",
|
|
5327
|
-
"description": "Available syntax highlighting languages for code editors in CloudCannon.",
|
|
5328
5311
|
"type": "string",
|
|
5329
5312
|
"enum": [
|
|
5330
5313
|
"c_cpp",
|
|
@@ -5396,12 +5379,12 @@
|
|
|
5396
5379
|
"xquery",
|
|
5397
5380
|
"yaml"
|
|
5398
5381
|
],
|
|
5382
|
+
"title": "Syntax",
|
|
5383
|
+
"description": "Available syntax highlighting languages for code editors in CloudCannon.",
|
|
5399
5384
|
"documented": false,
|
|
5400
5385
|
"markdownDescription": "Available syntax highlighting languages for code editors in CloudCannon."
|
|
5401
5386
|
},
|
|
5402
5387
|
"ColorInput": {
|
|
5403
|
-
"title": "Color Input",
|
|
5404
|
-
"description": "This key defines an editing interface for color values.",
|
|
5405
5388
|
"type": "object",
|
|
5406
5389
|
"properties": {
|
|
5407
5390
|
"comment": {
|
|
@@ -5446,15 +5429,14 @@
|
|
|
5446
5429
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5447
5430
|
},
|
|
5448
5431
|
"type": {
|
|
5449
|
-
"title": "Type",
|
|
5450
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5451
5432
|
"type": "string",
|
|
5452
5433
|
"const": "color",
|
|
5434
|
+
"title": "Type",
|
|
5435
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5453
5436
|
"documented": true,
|
|
5454
5437
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5455
5438
|
},
|
|
5456
5439
|
"options": {
|
|
5457
|
-
"description": "This key defines options that are specific to Color Inputs.",
|
|
5458
5440
|
"type": "object",
|
|
5459
5441
|
"properties": {
|
|
5460
5442
|
"max_length": {
|
|
@@ -5564,6 +5546,7 @@
|
|
|
5564
5546
|
}
|
|
5565
5547
|
},
|
|
5566
5548
|
"additionalProperties": false,
|
|
5549
|
+
"description": "This key defines options that are specific to Color Inputs.",
|
|
5567
5550
|
"documented": true,
|
|
5568
5551
|
"title": "options",
|
|
5569
5552
|
"markdownDescription": "This key defines options that are specific to Color Inputs."
|
|
@@ -5573,12 +5556,12 @@
|
|
|
5573
5556
|
"type"
|
|
5574
5557
|
],
|
|
5575
5558
|
"additionalProperties": false,
|
|
5559
|
+
"title": "Color Input",
|
|
5560
|
+
"description": "This key defines an editing interface for color values.",
|
|
5576
5561
|
"documented": true,
|
|
5577
5562
|
"markdownDescription": "This key defines an editing interface for color values."
|
|
5578
5563
|
},
|
|
5579
5564
|
"BooleanInput": {
|
|
5580
|
-
"title": "Boolean Input",
|
|
5581
|
-
"description": "This key defines an editing interface for true or false values.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input*.\n\n```yaml\n_inputs:\n featured:\n type: switch\n label: Featured\n```",
|
|
5582
5565
|
"type": "object",
|
|
5583
5566
|
"properties": {
|
|
5584
5567
|
"comment": {
|
|
@@ -5623,13 +5606,13 @@
|
|
|
5623
5606
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5624
5607
|
},
|
|
5625
5608
|
"type": {
|
|
5626
|
-
"title": "Type",
|
|
5627
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input* type.\n\n```yaml\n_inputs:\n featured:\n type: switch\n```",
|
|
5628
5609
|
"type": "string",
|
|
5629
5610
|
"enum": [
|
|
5630
5611
|
"checkbox",
|
|
5631
5612
|
"switch"
|
|
5632
5613
|
],
|
|
5614
|
+
"title": "Type",
|
|
5615
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input* type.\n\n```yaml\n_inputs:\n featured:\n type: switch\n```",
|
|
5633
5616
|
"documented": true,
|
|
5634
5617
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input* type.\n\n```yaml\n_inputs:\n featured:\n type: switch\n```"
|
|
5635
5618
|
}
|
|
@@ -5638,12 +5621,12 @@
|
|
|
5638
5621
|
"type"
|
|
5639
5622
|
],
|
|
5640
5623
|
"additionalProperties": false,
|
|
5624
|
+
"title": "Boolean Input",
|
|
5625
|
+
"description": "This key defines an editing interface for true or false values.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input*.\n\n```yaml\n_inputs:\n featured:\n type: switch\n label: Featured\n```",
|
|
5641
5626
|
"documented": true,
|
|
5642
5627
|
"markdownDescription": "This key defines an editing interface for true or false values.\n\n## Examples\n\nIn this example, we have configured the `featured` key as a *Boolean Input*.\n\n```yaml\n_inputs:\n featured:\n type: switch\n label: Featured\n```"
|
|
5643
5628
|
},
|
|
5644
5629
|
"NumberInput": {
|
|
5645
|
-
"title": "Number Input",
|
|
5646
|
-
"description": "This key defines an editing interface for numeric values.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input*.\n\n```yaml\n_inputs:\n quantity:\n type: number\n label: Quantity\n```",
|
|
5647
5630
|
"type": "object",
|
|
5648
5631
|
"properties": {
|
|
5649
5632
|
"comment": {
|
|
@@ -5688,15 +5671,14 @@
|
|
|
5688
5671
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5689
5672
|
},
|
|
5690
5673
|
"type": {
|
|
5691
|
-
"title": "Type",
|
|
5692
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input* type.\n\n```yaml\n_inputs:\n quantity:\n type: number\n```",
|
|
5693
5674
|
"type": "string",
|
|
5694
5675
|
"const": "number",
|
|
5676
|
+
"title": "Type",
|
|
5677
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input* type.\n\n```yaml\n_inputs:\n quantity:\n type: number\n```",
|
|
5695
5678
|
"documented": true,
|
|
5696
5679
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input* type.\n\n```yaml\n_inputs:\n quantity:\n type: number\n```"
|
|
5697
5680
|
},
|
|
5698
5681
|
"options": {
|
|
5699
|
-
"description": "This key defines options that are specific to Number Inputs.\n\n## Examples\n\nIn this example, we have configured *Number Input* options including min and max values.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n min: 1\n max: 100\n```",
|
|
5700
5682
|
"type": "object",
|
|
5701
5683
|
"properties": {
|
|
5702
5684
|
"required": {
|
|
@@ -5743,6 +5725,7 @@
|
|
|
5743
5725
|
}
|
|
5744
5726
|
},
|
|
5745
5727
|
"additionalProperties": false,
|
|
5728
|
+
"description": "This key defines options that are specific to Number Inputs.\n\n## Examples\n\nIn this example, we have configured *Number Input* options including min and max values.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n min: 1\n max: 100\n```",
|
|
5746
5729
|
"documented": true,
|
|
5747
5730
|
"title": "options",
|
|
5748
5731
|
"markdownDescription": "This key defines options that are specific to Number Inputs.\n\n## Examples\n\nIn this example, we have configured *Number Input* options including min and max values.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n min: 1\n max: 100\n```"
|
|
@@ -5752,12 +5735,14 @@
|
|
|
5752
5735
|
"type"
|
|
5753
5736
|
],
|
|
5754
5737
|
"additionalProperties": false,
|
|
5738
|
+
"title": "Number Input",
|
|
5739
|
+
"description": "This key defines an editing interface for numeric values.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input*.\n\n```yaml\n_inputs:\n quantity:\n type: number\n label: Quantity\n```",
|
|
5755
5740
|
"documented": true,
|
|
5756
5741
|
"markdownDescription": "This key defines an editing interface for numeric values.\n\n## Examples\n\nIn this example, we have configured the `quantity` key as a *Number Input*.\n\n```yaml\n_inputs:\n quantity:\n type: number\n label: Quantity\n```"
|
|
5757
5742
|
},
|
|
5758
5743
|
"type._inputs.*.options.empty_type(number)": {
|
|
5759
|
-
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty number values will be saved.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n empty_type: number\n```",
|
|
5760
5744
|
"default": "null",
|
|
5745
|
+
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty number values will be saved.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n empty_type: number\n```",
|
|
5761
5746
|
"type": "string",
|
|
5762
5747
|
"enum": [
|
|
5763
5748
|
"null",
|
|
@@ -5768,15 +5753,15 @@
|
|
|
5768
5753
|
"markdownDescription": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty number values will be saved.\n\n```yaml\n_inputs:\n quantity:\n type: number\n options:\n empty_type: number\n```"
|
|
5769
5754
|
},
|
|
5770
5755
|
"type._inputs.*.options.min": {
|
|
5771
|
-
"description": "This key defines the minimum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a lesser numerical value.\n\nIf the Input already contains a lesser numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any number.\n\nIf `options.max` is also configured, this key cannot be a greater number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a minimum rating of one.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```",
|
|
5772
5756
|
"type": "number",
|
|
5757
|
+
"description": "This key defines the minimum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a lesser numerical value.\n\nIf the Input already contains a lesser numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any number.\n\nIf `options.max` is also configured, this key cannot be a greater number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a minimum rating of one.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```",
|
|
5773
5758
|
"documented": true,
|
|
5774
5759
|
"title": "min",
|
|
5775
5760
|
"markdownDescription": "This key defines the minimum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a lesser numerical value.\n\nIf the Input already contains a lesser numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any number.\n\nIf `options.max` is also configured, this key cannot be a greater number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a minimum rating of one.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```"
|
|
5776
5761
|
},
|
|
5777
5762
|
"type._inputs.*.options.max": {
|
|
5778
|
-
"description": "This key defines the maximum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a greater numerical value.\n\nIf the Input already contains a greater numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any integer.\n\nIf `options.min` is also configured, this key cannot be a lesser number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a maximum rating of five.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```",
|
|
5779
5763
|
"type": "number",
|
|
5764
|
+
"description": "This key defines the maximum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a greater numerical value.\n\nIf the Input already contains a greater numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any integer.\n\nIf `options.min` is also configured, this key cannot be a lesser number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a maximum rating of five.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```",
|
|
5780
5765
|
"documented": true,
|
|
5781
5766
|
"title": "max",
|
|
5782
5767
|
"markdownDescription": "This key defines the maximum numerical value CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from entering a greater numerical value.\n\nIf the Input already contains a greater numerical value, CloudCannon will require you to enter a valid value to save your changes, or discard your\nunsaved changes.\n\nThis key is required for `range` inputs.\n\nValue can be any integer.\n\nIf `options.min` is also configured, this key cannot be a lesser number.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we want to add a rating out of five for each article in our travel blog using the `rating` Input. This Input limits you to a maximum rating of five.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n min: 1\n```"
|
|
@@ -5803,8 +5788,6 @@
|
|
|
5803
5788
|
"markdownDescription": "This key defines a custom error message that explains why a value has failed the validation criteria from `options.max`.\nThis key requires you to define `options.max`.\n\nThis key has no default.\n\nThis key is available for Number Inputs.\n\n## Examples\n\nIn this example, we prompt our team to enter a valid number using a custom message.\n\n```yaml\n_inputs:\n rating:\n type: number\n comment: How highly did you rate this experience?\n options:\n max: 5\n max_message: Cannot be more than 5\n min: 1\n min_message: Cannot be less than 1\n```"
|
|
5804
5789
|
},
|
|
5805
5790
|
"RangeInput": {
|
|
5806
|
-
"title": "Range Input",
|
|
5807
|
-
"description": "This key defines a slider interface for selecting a numeric value.",
|
|
5808
5791
|
"type": "object",
|
|
5809
5792
|
"properties": {
|
|
5810
5793
|
"comment": {
|
|
@@ -5849,15 +5832,14 @@
|
|
|
5849
5832
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5850
5833
|
},
|
|
5851
5834
|
"type": {
|
|
5852
|
-
"title": "Type",
|
|
5853
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5854
5835
|
"type": "string",
|
|
5855
5836
|
"const": "range",
|
|
5837
|
+
"title": "Type",
|
|
5838
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5856
5839
|
"documented": true,
|
|
5857
5840
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5858
5841
|
},
|
|
5859
5842
|
"options": {
|
|
5860
|
-
"description": "This key defines options that are specific to Range Inputs.",
|
|
5861
5843
|
"type": "object",
|
|
5862
5844
|
"properties": {
|
|
5863
5845
|
"required": {
|
|
@@ -5896,6 +5878,7 @@
|
|
|
5896
5878
|
"max"
|
|
5897
5879
|
],
|
|
5898
5880
|
"additionalProperties": false,
|
|
5881
|
+
"description": "This key defines options that are specific to Range Inputs.",
|
|
5899
5882
|
"documented": true,
|
|
5900
5883
|
"title": "options",
|
|
5901
5884
|
"markdownDescription": "This key defines options that are specific to Range Inputs."
|
|
@@ -5905,12 +5888,12 @@
|
|
|
5905
5888
|
"type"
|
|
5906
5889
|
],
|
|
5907
5890
|
"additionalProperties": false,
|
|
5891
|
+
"title": "Range Input",
|
|
5892
|
+
"description": "This key defines a slider interface for selecting a numeric value.",
|
|
5908
5893
|
"documented": true,
|
|
5909
5894
|
"markdownDescription": "This key defines a slider interface for selecting a numeric value."
|
|
5910
5895
|
},
|
|
5911
5896
|
"RichTextInput": {
|
|
5912
|
-
"title": "Rich Text Input",
|
|
5913
|
-
"description": "This key defines an editing interface for HTML markup content.",
|
|
5914
5897
|
"type": "object",
|
|
5915
5898
|
"properties": {
|
|
5916
5899
|
"comment": {
|
|
@@ -5955,18 +5938,17 @@
|
|
|
5955
5938
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5956
5939
|
},
|
|
5957
5940
|
"type": {
|
|
5958
|
-
"title": "Type",
|
|
5959
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5960
5941
|
"type": "string",
|
|
5961
5942
|
"enum": [
|
|
5962
5943
|
"html",
|
|
5963
5944
|
"markdown"
|
|
5964
5945
|
],
|
|
5946
|
+
"title": "Type",
|
|
5947
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5965
5948
|
"documented": true,
|
|
5966
5949
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5967
5950
|
},
|
|
5968
5951
|
"options": {
|
|
5969
|
-
"description": "This key defines options that are specific to Rich Text Inputs.",
|
|
5970
5952
|
"type": "object",
|
|
5971
5953
|
"properties": {
|
|
5972
5954
|
"mime_type": {
|
|
@@ -6172,11 +6154,11 @@
|
|
|
6172
6154
|
},
|
|
6173
6155
|
"allow_resize": {
|
|
6174
6156
|
"deprecated": true,
|
|
6175
|
-
"description": "**⚠️ DEPRECATED:** This key is deprecated. Use `preview_resize` instead.\nThis key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown).",
|
|
6176
6157
|
"type": "boolean",
|
|
6177
6158
|
"documented": true,
|
|
6178
6159
|
"title": "allow_resize",
|
|
6179
|
-
"
|
|
6160
|
+
"description": "This key is deprecated. Use `preview_resize` instead.\n\nThis key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown).",
|
|
6161
|
+
"markdownDescription": "This key is deprecated. Use `preview_resize` instead.\n\nThis key toggles whether CloudCannon will show the resize handler to vertically resize the input.\n\nSetting this key to `false` will hide the resize handler.\n\nBy default, this key is `true` (i.e., the resize handler is shown)."
|
|
6180
6162
|
},
|
|
6181
6163
|
"prevent_resize": {
|
|
6182
6164
|
"description": "Shows or hides the resize handler to vertically resize the input.",
|
|
@@ -6195,6 +6177,7 @@
|
|
|
6195
6177
|
}
|
|
6196
6178
|
},
|
|
6197
6179
|
"additionalProperties": false,
|
|
6180
|
+
"description": "This key defines options that are specific to Rich Text Inputs.",
|
|
6198
6181
|
"documented": true,
|
|
6199
6182
|
"title": "options",
|
|
6200
6183
|
"markdownDescription": "This key defines options that are specific to Rich Text Inputs."
|
|
@@ -6204,6 +6187,8 @@
|
|
|
6204
6187
|
"type"
|
|
6205
6188
|
],
|
|
6206
6189
|
"additionalProperties": false,
|
|
6190
|
+
"title": "Rich Text Input",
|
|
6191
|
+
"description": "This key defines an editing interface for HTML markup content.",
|
|
6207
6192
|
"documented": true,
|
|
6208
6193
|
"markdownDescription": "This key defines an editing interface for HTML markup content."
|
|
6209
6194
|
},
|
|
@@ -6293,8 +6278,8 @@
|
|
|
6293
6278
|
"type": "object",
|
|
6294
6279
|
"properties": {
|
|
6295
6280
|
"size": {
|
|
6296
|
-
"description": "This key defines a number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input* to create a 2x relative size image.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n```",
|
|
6297
6281
|
"type": "string",
|
|
6282
|
+
"description": "This key defines a number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input* to create a 2x relative size image.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n```",
|
|
6298
6283
|
"documented": true,
|
|
6299
6284
|
"title": "size",
|
|
6300
6285
|
"markdownDescription": "This key defines a number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input* to create a 2x relative size image.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n```"
|
|
@@ -6320,7 +6305,6 @@
|
|
|
6320
6305
|
"markdownDescription": "This key defines definitions for creating additional images of different sizes when uploading or selecting existing files.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to create additional images of different sizes when uploading or selecting files.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n - size: 3x\n```"
|
|
6321
6306
|
},
|
|
6322
6307
|
"type.paths": {
|
|
6323
|
-
"title": "Paths",
|
|
6324
6308
|
"type": "object",
|
|
6325
6309
|
"properties": {
|
|
6326
6310
|
"static": {
|
|
@@ -6346,6 +6330,7 @@
|
|
|
6346
6330
|
}
|
|
6347
6331
|
},
|
|
6348
6332
|
"additionalProperties": false,
|
|
6333
|
+
"title": "Paths",
|
|
6349
6334
|
"documented": true,
|
|
6350
6335
|
"description": "This key defines paths for your Rich Text editors or File inputs.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `paths` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured paths for the `blog` Collection to set custom upload and static paths.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n static: /assets/\n```",
|
|
6351
6336
|
"markdownDescription": "This key defines paths for your Rich Text editors or File inputs.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `paths` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured paths for the `blog` Collection to set custom upload and static paths.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n static: /assets/\n```"
|
|
@@ -6667,8 +6652,6 @@
|
|
|
6667
6652
|
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to merge a list item with the item below it in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to merge a list item with the item below it."
|
|
6668
6653
|
},
|
|
6669
6654
|
"DateInput": {
|
|
6670
|
-
"title": "Date/Datetime Input",
|
|
6671
|
-
"description": "This key defines an editing interface for date and/or time values.",
|
|
6672
6655
|
"type": "object",
|
|
6673
6656
|
"properties": {
|
|
6674
6657
|
"comment": {
|
|
@@ -6713,18 +6696,17 @@
|
|
|
6713
6696
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
6714
6697
|
},
|
|
6715
6698
|
"type": {
|
|
6716
|
-
"title": "Type",
|
|
6717
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6718
6699
|
"type": "string",
|
|
6719
6700
|
"enum": [
|
|
6720
6701
|
"date",
|
|
6721
6702
|
"datetime"
|
|
6722
6703
|
],
|
|
6704
|
+
"title": "Type",
|
|
6705
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6723
6706
|
"documented": true,
|
|
6724
6707
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
6725
6708
|
},
|
|
6726
6709
|
"options": {
|
|
6727
|
-
"description": "This key defines options that are specific to Date Inputs.",
|
|
6728
6710
|
"type": "object",
|
|
6729
6711
|
"properties": {
|
|
6730
6712
|
"required": {
|
|
@@ -6757,10 +6739,10 @@
|
|
|
6757
6739
|
"description": "This key defines the earliest date and time, inclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting an earlier date and time.\n\nIf the Input already contains an earlier date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard\nyour unsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\nThe value can have quotation marks or no quotation marks.\n\nIf `options.end_before` is also configured, this key cannot be a later date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs.\n\n## Examples\n\nIn this example, we want our team to enter the date and time of an event in the `2022_event` Input. This Input will only allow dates on or after January 1st, 2022.\n\n```yaml\n_inputs:\n 2022_event:\n type: datetime\n options:\n start_from: 2022-01-01T00:00:00Z\n end_before: 2023-01-01T00:00:00Z\n```",
|
|
6758
6740
|
"anyOf": [
|
|
6759
6741
|
{
|
|
6760
|
-
"title": "String Start From",
|
|
6761
6742
|
"type": "string",
|
|
6762
6743
|
"format": "date-time",
|
|
6763
6744
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z||([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
|
|
6745
|
+
"title": "String Start From",
|
|
6764
6746
|
"documented": true,
|
|
6765
6747
|
"description": "This key defines the earliest date and time, inclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting an earlier date and time.\n\nIf the Input already contains an earlier date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard\nyour unsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and should be in quotes.\n\nIf `options.end_before` is also configured, this key cannot be a later date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs.",
|
|
6766
6748
|
"markdownDescription": "This key defines the earliest date and time, inclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting an earlier date and time.\n\nIf the Input already contains an earlier date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard\nyour unsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format and should be in quotes.\n\nIf `options.end_before` is also configured, this key cannot be a later date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs."
|
|
@@ -6787,10 +6769,10 @@
|
|
|
6787
6769
|
"description": "This key defines the date and time, exclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting a later date and time.\n\nIf the Input already contains a later date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard your\nunsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\nThe value can have quotation marks or no quotation marks.\n\nIf `options.start_from` is also configured, this key cannot be an earlier date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs.\n\n## Examples\n\nIn this example, we want our team to enter the date and time of an event in the `2022_event` Input. This Input will only allow dates before January 1st, 2023.\n\n```yaml\n_inputs:\n 2022_event:\n type: datetime\n options:\n start_from: 2022-01-01T00:00:00Z\n end_before: 2023-01-01T00:00:00Z\n```",
|
|
6788
6770
|
"anyOf": [
|
|
6789
6771
|
{
|
|
6790
|
-
"title": "String End Before",
|
|
6791
6772
|
"type": "string",
|
|
6792
6773
|
"format": "date-time",
|
|
6793
6774
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z||([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
|
|
6775
|
+
"title": "String End Before",
|
|
6794
6776
|
"documented": true,
|
|
6795
6777
|
"description": "This key defines the date and time, exclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting a later date and time.\n\nIf the Input already contains a later date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard your\nunsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\nIf `options.start_from` is also configured, this key cannot be an earlier date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs.",
|
|
6796
6778
|
"markdownDescription": "This key defines the date and time, exclusive, that CloudCannon will allow in an Input.\n\nWhen configured, CloudCannon will prevent you from selecting a later date and time.\n\nIf the Input already contains a later date and time, CloudCannon will require you to change it to a valid value to save your changes, or discard your\nunsaved changes.\n\nValue must be in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\nIf `options.start_from` is also configured, this key cannot be an earlier date and time.\n\nThis key has no default.\n\nThis key is available for Date and Time Inputs."
|
|
@@ -6815,6 +6797,7 @@
|
|
|
6815
6797
|
}
|
|
6816
6798
|
},
|
|
6817
6799
|
"additionalProperties": false,
|
|
6800
|
+
"description": "This key defines options that are specific to Date Inputs.",
|
|
6818
6801
|
"documented": true,
|
|
6819
6802
|
"title": "options",
|
|
6820
6803
|
"markdownDescription": "This key defines options that are specific to Date Inputs."
|
|
@@ -6824,11 +6807,12 @@
|
|
|
6824
6807
|
"type"
|
|
6825
6808
|
],
|
|
6826
6809
|
"additionalProperties": false,
|
|
6810
|
+
"title": "Date/Datetime Input",
|
|
6811
|
+
"description": "This key defines an editing interface for date and/or time values.",
|
|
6827
6812
|
"documented": true,
|
|
6828
6813
|
"markdownDescription": "This key defines an editing interface for date and/or time values."
|
|
6829
6814
|
},
|
|
6830
6815
|
"type.timezone": {
|
|
6831
|
-
"title": "Timezone",
|
|
6832
6816
|
"type": "string",
|
|
6833
6817
|
"enum": [
|
|
6834
6818
|
"Africa/Abidjan",
|
|
@@ -7427,13 +7411,12 @@
|
|
|
7427
7411
|
"WET",
|
|
7428
7412
|
"Zulu"
|
|
7429
7413
|
],
|
|
7414
|
+
"title": "Timezone",
|
|
7430
7415
|
"documented": true,
|
|
7431
7416
|
"description": "This key defines the timezone for your Site.\n\nValue must be in IANA timezone format.\n\nFor more information, please read our documentation on [Date and Time inputs](https://cloudcannon.com/documentation/articles/what-are-date-and-time-inputs/).",
|
|
7432
7417
|
"markdownDescription": "This key defines the timezone for your Site.\n\nValue must be in IANA timezone format.\n\nFor more information, please read our documentation on [Date and Time inputs](https://cloudcannon.com/documentation/articles/what-are-date-and-time-inputs/)."
|
|
7433
7418
|
},
|
|
7434
7419
|
"TimeInput": {
|
|
7435
|
-
"title": "Time Input",
|
|
7436
|
-
"description": "This key defines an editing interface for time values only.",
|
|
7437
7420
|
"type": "object",
|
|
7438
7421
|
"properties": {
|
|
7439
7422
|
"comment": {
|
|
@@ -7478,15 +7461,14 @@
|
|
|
7478
7461
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
7479
7462
|
},
|
|
7480
7463
|
"type": {
|
|
7481
|
-
"title": "Type",
|
|
7482
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7483
7464
|
"type": "string",
|
|
7484
7465
|
"const": "time",
|
|
7466
|
+
"title": "Type",
|
|
7467
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7485
7468
|
"documented": true,
|
|
7486
7469
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
7487
7470
|
},
|
|
7488
7471
|
"options": {
|
|
7489
|
-
"description": "This key defines options that are specific to Time Inputs.",
|
|
7490
7472
|
"type": "object",
|
|
7491
7473
|
"properties": {
|
|
7492
7474
|
"required": {
|
|
@@ -7506,6 +7488,7 @@
|
|
|
7506
7488
|
}
|
|
7507
7489
|
},
|
|
7508
7490
|
"additionalProperties": false,
|
|
7491
|
+
"description": "This key defines options that are specific to Time Inputs.",
|
|
7509
7492
|
"documented": true,
|
|
7510
7493
|
"title": "options",
|
|
7511
7494
|
"markdownDescription": "This key defines options that are specific to Time Inputs."
|
|
@@ -7515,12 +7498,12 @@
|
|
|
7515
7498
|
"type"
|
|
7516
7499
|
],
|
|
7517
7500
|
"additionalProperties": false,
|
|
7501
|
+
"title": "Time Input",
|
|
7502
|
+
"description": "This key defines an editing interface for time values only.",
|
|
7518
7503
|
"documented": true,
|
|
7519
7504
|
"markdownDescription": "This key defines an editing interface for time values only."
|
|
7520
7505
|
},
|
|
7521
7506
|
"FileInput": {
|
|
7522
|
-
"title": "File Input",
|
|
7523
|
-
"description": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets.",
|
|
7524
7507
|
"type": "object",
|
|
7525
7508
|
"properties": {
|
|
7526
7509
|
"comment": {
|
|
@@ -7565,19 +7548,18 @@
|
|
|
7565
7548
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
7566
7549
|
},
|
|
7567
7550
|
"type": {
|
|
7568
|
-
"title": "Type",
|
|
7569
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7570
7551
|
"type": "string",
|
|
7571
7552
|
"enum": [
|
|
7572
7553
|
"file",
|
|
7573
7554
|
"document",
|
|
7574
7555
|
"image"
|
|
7575
7556
|
],
|
|
7557
|
+
"title": "Type",
|
|
7558
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7576
7559
|
"documented": true,
|
|
7577
7560
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
7578
7561
|
},
|
|
7579
7562
|
"options": {
|
|
7580
|
-
"description": "This key defines options that are specific to File Inputs.",
|
|
7581
7563
|
"type": "object",
|
|
7582
7564
|
"properties": {
|
|
7583
7565
|
"mime_type": {
|
|
@@ -7699,6 +7681,7 @@
|
|
|
7699
7681
|
}
|
|
7700
7682
|
},
|
|
7701
7683
|
"additionalProperties": false,
|
|
7684
|
+
"description": "This key defines options that are specific to File Inputs.",
|
|
7702
7685
|
"documented": true,
|
|
7703
7686
|
"title": "options",
|
|
7704
7687
|
"markdownDescription": "This key defines options that are specific to File Inputs."
|
|
@@ -7708,6 +7691,8 @@
|
|
|
7708
7691
|
"type"
|
|
7709
7692
|
],
|
|
7710
7693
|
"additionalProperties": false,
|
|
7694
|
+
"title": "File Input",
|
|
7695
|
+
"description": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets.",
|
|
7711
7696
|
"documented": true,
|
|
7712
7697
|
"markdownDescription": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets."
|
|
7713
7698
|
},
|
|
@@ -7715,18 +7700,18 @@
|
|
|
7715
7700
|
"description": "This key defines which file types are available to select or upload to this input.\n\nAccepted format is an array or comma-separated string of MIME types.\n\nThe special value \"*\" means any type is accepted.\n\n## Examples\n\nIn this example, we have configured a *Image Input* to accept only JPEG or PNG files.\n\n```yaml\n_inputs:\n featured_image:\n type: image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n```",
|
|
7716
7701
|
"anyOf": [
|
|
7717
7702
|
{
|
|
7718
|
-
"title": "Comma Separated Accepts Mime Types",
|
|
7719
7703
|
"type": "string",
|
|
7704
|
+
"title": "Comma Separated Accepts Mime Types",
|
|
7720
7705
|
"documented": true,
|
|
7721
7706
|
"description": "This key represents a comma-separated string format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is a string containing MIME types separated by commas. Each MIME type specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the comma-separated format when you prefer a more compact configuration or when working with a small number of MIME types.\n\nThe special value `\"*\"` means any file type is accepted.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using a comma-separated string of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types: 'image/jpeg,image/png,image/webp'\n```\n\nIn this example, we have configured a *File Input* to accept only document files using a comma-separated string of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types: 'application/pdf,application/msword'\n```\n\nIn this example, we have configured a *File Input* to accept any file type using the special `\"*\"` value.\n\n```yaml\n_inputs:\n any_file:\n type: file\n label: Any File\n options:\n accepts_mime_types: '*'\n```",
|
|
7722
7707
|
"markdownDescription": "This key represents a comma-separated string format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is a string containing MIME types separated by commas. Each MIME type specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the comma-separated format when you prefer a more compact configuration or when working with a small number of MIME types.\n\nThe special value `\"*\"` means any file type is accepted.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using a comma-separated string of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types: 'image/jpeg,image/png,image/webp'\n```\n\nIn this example, we have configured a *File Input* to accept only document files using a comma-separated string of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types: 'application/pdf,application/msword'\n```\n\nIn this example, we have configured a *File Input* to accept any file type using the special `\"*\"` value.\n\n```yaml\n_inputs:\n any_file:\n type: file\n label: Any File\n options:\n accepts_mime_types: '*'\n```"
|
|
7723
7708
|
},
|
|
7724
7709
|
{
|
|
7725
|
-
"title": "Array Accepts Mime Types",
|
|
7726
7710
|
"type": "array",
|
|
7727
7711
|
"items": {
|
|
7728
7712
|
"$ref": "#/definitions/MimeType"
|
|
7729
7713
|
},
|
|
7714
|
+
"title": "Array Accepts Mime Types",
|
|
7730
7715
|
"documented": true,
|
|
7731
7716
|
"description": "This key represents an array format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is an array of MIME type strings. Each string specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the array format when you want to explicitly list multiple MIME types, making it easier to read and maintain in your configuration.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using an array of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n - image/webp\n```\n\nIn this example, we have configured a *File Input* to accept only document files using an array of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types:\n - application/pdf\n - application/msword\n - application/vnd.openxmlformats-officedocument.wordprocessingml.document\n```",
|
|
7732
7717
|
"markdownDescription": "This key represents an array format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is an array of MIME type strings. Each string specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the array format when you want to explicitly list multiple MIME types, making it easier to read and maintain in your configuration.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using an array of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n - image/webp\n```\n\nIn this example, we have configured a *File Input* to accept only document files using an array of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types:\n - application/pdf\n - application/msword\n - application/vnd.openxmlformats-officedocument.wordprocessingml.document\n```"
|
|
@@ -7737,8 +7722,6 @@
|
|
|
7737
7722
|
"markdownDescription": "This key defines which file types are available to select or upload to this input.\n\nAccepted format is an array or comma-separated string of MIME types.\n\nThe special value \"*\" means any type is accepted.\n\n## Examples\n\nIn this example, we have configured a *Image Input* to accept only JPEG or PNG files.\n\n```yaml\n_inputs:\n featured_image:\n type: image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n```"
|
|
7738
7723
|
},
|
|
7739
7724
|
"MimeType": {
|
|
7740
|
-
"title": "Mime Type",
|
|
7741
|
-
"description": "This key represents an array format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is an array of MIME type strings. Each string specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the array format when you want to explicitly list multiple MIME types, making it easier to read and maintain in your configuration.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using an array of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n - image/webp\n```\n\nIn this example, we have configured a *File Input* to accept only document files using an array of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types:\n - application/pdf\n - application/msword\n - application/vnd.openxmlformats-officedocument.wordprocessingml.document\n```",
|
|
7742
7725
|
"type": "string",
|
|
7743
7726
|
"enum": [
|
|
7744
7727
|
"x-world/x-3dmf",
|
|
@@ -8175,6 +8158,8 @@
|
|
|
8175
8158
|
"multipart/x-zip",
|
|
8176
8159
|
"text/x-script.zsh"
|
|
8177
8160
|
],
|
|
8161
|
+
"title": "Mime Type",
|
|
8162
|
+
"description": "This key represents an array format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is an array of MIME type strings. Each string specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the array format when you want to explicitly list multiple MIME types, making it easier to read and maintain in your configuration.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using an array of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n - image/webp\n```\n\nIn this example, we have configured a *File Input* to accept only document files using an array of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types:\n - application/pdf\n - application/msword\n - application/vnd.openxmlformats-officedocument.wordprocessingml.document\n```",
|
|
8178
8163
|
"documented": true,
|
|
8179
8164
|
"markdownDescription": "This key represents an array format for the `accepts_mime_types` key that restricts which file types are available to select or upload in *File Inputs*.\n\nThe value is an array of MIME type strings. Each string specifies a file type that CloudCannon will allow for this input.\n\nAvailable MIME types include image formats (`image/x-icon`, `image/gif`, `image/jpeg`, `image/png`, `image/webp`, `image/bmp`, `image/svg+xml`) and document formats (`application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`).\n\nUse the array format when you want to explicitly list multiple MIME types, making it easier to read and maintain in your configuration.\n\n## Examples\n\nIn this example, we have configured a *File Input* to accept only image files using an array of image MIME types.\n\n```yaml\n_inputs:\n hero_image:\n type: file\n label: Hero Image\n options:\n accepts_mime_types:\n - image/jpeg\n - image/png\n - image/webp\n```\n\nIn this example, we have configured a *File Input* to accept only document files using an array of document MIME types.\n\n```yaml\n_inputs:\n document:\n type: file\n label: Document\n options:\n accepts_mime_types:\n - application/pdf\n - application/msword\n - application/vnd.openxmlformats-officedocument.wordprocessingml.document\n```"
|
|
8180
8165
|
},
|
|
@@ -8217,8 +8202,6 @@
|
|
|
8217
8202
|
"markdownDescription": "This key toggles whether CloudCannon will prevent file uploads inside the \"Select existing file/image\" file browser modal window.\n\nSetting this key to `true` will prevent file uploads inside the file browser modal window.\n\n## Examples\n\nIn this example, CloudCannon will disable the option to upload files inside the file browser modal window.\n\n```yaml\n_inputs:\n image:\n type: file\n options:\n disable_upload_file_in_file_browser: true\n```"
|
|
8218
8203
|
},
|
|
8219
8204
|
"UrlInput": {
|
|
8220
|
-
"title": "URL Input",
|
|
8221
|
-
"description": "This key defines an editing interface for relative, absolute, and fully qualified URLs.",
|
|
8222
8205
|
"type": "object",
|
|
8223
8206
|
"properties": {
|
|
8224
8207
|
"comment": {
|
|
@@ -8263,15 +8246,14 @@
|
|
|
8263
8246
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8264
8247
|
},
|
|
8265
8248
|
"type": {
|
|
8266
|
-
"title": "Type",
|
|
8267
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
8268
8249
|
"type": "string",
|
|
8269
8250
|
"const": "url",
|
|
8251
|
+
"title": "Type",
|
|
8252
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
8270
8253
|
"documented": true,
|
|
8271
8254
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
8272
8255
|
},
|
|
8273
8256
|
"options": {
|
|
8274
|
-
"description": "This key defines options that are specific to URL Inputs.",
|
|
8275
8257
|
"type": "object",
|
|
8276
8258
|
"properties": {
|
|
8277
8259
|
"mime_type": {
|
|
@@ -8425,6 +8407,7 @@
|
|
|
8425
8407
|
}
|
|
8426
8408
|
},
|
|
8427
8409
|
"additionalProperties": false,
|
|
8410
|
+
"description": "This key defines options that are specific to URL Inputs.",
|
|
8428
8411
|
"documented": true,
|
|
8429
8412
|
"title": "options",
|
|
8430
8413
|
"markdownDescription": "This key defines options that are specific to URL Inputs."
|
|
@@ -8434,12 +8417,12 @@
|
|
|
8434
8417
|
"type"
|
|
8435
8418
|
],
|
|
8436
8419
|
"additionalProperties": false,
|
|
8420
|
+
"title": "URL Input",
|
|
8421
|
+
"description": "This key defines an editing interface for relative, absolute, and fully qualified URLs.",
|
|
8437
8422
|
"documented": true,
|
|
8438
8423
|
"markdownDescription": "This key defines an editing interface for relative, absolute, and fully qualified URLs."
|
|
8439
8424
|
},
|
|
8440
8425
|
"SelectInput": {
|
|
8441
|
-
"title": "Select Input",
|
|
8442
|
-
"description": "This key defines an editing interface for data with multiple predefined options.\n\nSelect inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n label: Category\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8443
8426
|
"type": "object",
|
|
8444
8427
|
"properties": {
|
|
8445
8428
|
"comment": {
|
|
@@ -8484,15 +8467,14 @@
|
|
|
8484
8467
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8485
8468
|
},
|
|
8486
8469
|
"type": {
|
|
8487
|
-
"title": "Type",
|
|
8488
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input* type.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8489
8470
|
"type": "string",
|
|
8490
8471
|
"const": "select",
|
|
8472
|
+
"title": "Type",
|
|
8473
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input* type.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8491
8474
|
"documented": true,
|
|
8492
8475
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input* type.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```"
|
|
8493
8476
|
},
|
|
8494
8477
|
"options": {
|
|
8495
|
-
"description": "This key defines options that are specific to Select Inputs.\n\n## Examples\n\nIn this example, we have configured *Select Input* options including values.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8496
8478
|
"type": "object",
|
|
8497
8479
|
"properties": {
|
|
8498
8480
|
"required": {
|
|
@@ -8596,6 +8578,7 @@
|
|
|
8596
8578
|
}
|
|
8597
8579
|
},
|
|
8598
8580
|
"additionalProperties": false,
|
|
8581
|
+
"description": "This key defines options that are specific to Select Inputs.\n\n## Examples\n\nIn this example, we have configured *Select Input* options including values.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8599
8582
|
"documented": true,
|
|
8600
8583
|
"title": "options",
|
|
8601
8584
|
"markdownDescription": "This key defines options that are specific to Select Inputs.\n\n## Examples\n\nIn this example, we have configured *Select Input* options including values.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```"
|
|
@@ -8605,6 +8588,8 @@
|
|
|
8605
8588
|
"type"
|
|
8606
8589
|
],
|
|
8607
8590
|
"additionalProperties": false,
|
|
8591
|
+
"title": "Select Input",
|
|
8592
|
+
"description": "This key defines an editing interface for data with multiple predefined options.\n\nSelect inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n label: Category\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8608
8593
|
"documented": true,
|
|
8609
8594
|
"markdownDescription": "This key defines an editing interface for data with multiple predefined options.\n\nSelect inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `category` key as a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n label: Category\n options:\n values:\n - Blog\n - News\n - Events\n```"
|
|
8610
8595
|
},
|
|
@@ -8618,37 +8603,35 @@
|
|
|
8618
8603
|
},
|
|
8619
8604
|
"type._inputs.*.options.allow_empty": {
|
|
8620
8605
|
"deprecated": true,
|
|
8621
|
-
"description": "
|
|
8606
|
+
"description": "This key is deprecated. If you want to prevent empty values, we recommend setting `_inputs.*.options.required` to `true` instead.\n\nThis key toggles whether CloudCannon will accept empty values, and pre-select the first option if opened with an empty value.\n\nSetting this key to `true` will allow CloudCannon to accept empty values.\n\n## Examples\n\nIn this example, CloudCannon will accept empty values for a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n allow_empty: true\n```",
|
|
8622
8607
|
"type": "boolean",
|
|
8623
8608
|
"documented": true,
|
|
8624
8609
|
"title": "allow_empty",
|
|
8625
|
-
"markdownDescription": "
|
|
8610
|
+
"markdownDescription": "This key is deprecated. If you want to prevent empty values, we recommend setting `_inputs.*.options.required` to `true` instead.\n\nThis key toggles whether CloudCannon will accept empty values, and pre-select the first option if opened with an empty value.\n\nSetting this key to `true` will allow CloudCannon to accept empty values.\n\n## Examples\n\nIn this example, CloudCannon will accept empty values for a *Select Input*.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n allow_empty: true\n```"
|
|
8626
8611
|
},
|
|
8627
8612
|
"type._inputs.*.options.values": {
|
|
8628
8613
|
"description": "This key defines the values available to choose from.\n\nOptional, defaults to fetching values from the naming convention (e.g. `colors` or `my_colors` for data set `colors`).\n\n## Examples\n\nIn this example, we have configured a *Select Input* with custom values to choose from.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n```",
|
|
8629
8614
|
"anyOf": [
|
|
8630
8615
|
{
|
|
8616
|
+
"type": "string",
|
|
8631
8617
|
"title": "Dataset Reference Values",
|
|
8632
8618
|
"description": "This key defines a reference to a dataset.",
|
|
8633
|
-
"type": "string",
|
|
8634
8619
|
"documented": true,
|
|
8635
8620
|
"markdownDescription": "This key defines a reference to a dataset."
|
|
8636
8621
|
},
|
|
8637
8622
|
{
|
|
8638
|
-
"description": "Data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
8639
8623
|
"anyOf": [
|
|
8640
8624
|
{
|
|
8641
|
-
"title": "Text Array",
|
|
8642
8625
|
"type": "array",
|
|
8643
8626
|
"items": {
|
|
8644
8627
|
"type": "string",
|
|
8645
8628
|
"documented": false,
|
|
8646
8629
|
"title": "values(any-of-1)(text-array)[*]"
|
|
8647
8630
|
},
|
|
8631
|
+
"title": "Text Array",
|
|
8648
8632
|
"documented": false
|
|
8649
8633
|
},
|
|
8650
8634
|
{
|
|
8651
|
-
"title": "Text Object",
|
|
8652
8635
|
"type": "object",
|
|
8653
8636
|
"propertyNames": {
|
|
8654
8637
|
"type": "string"
|
|
@@ -8658,10 +8641,10 @@
|
|
|
8658
8641
|
"documented": false,
|
|
8659
8642
|
"title": "values(any-of-1)(text-object).*"
|
|
8660
8643
|
},
|
|
8644
|
+
"title": "Text Object",
|
|
8661
8645
|
"documented": false
|
|
8662
8646
|
},
|
|
8663
8647
|
{
|
|
8664
|
-
"title": "Object Array",
|
|
8665
8648
|
"type": "array",
|
|
8666
8649
|
"items": {
|
|
8667
8650
|
"type": "object",
|
|
@@ -8672,18 +8655,20 @@
|
|
|
8672
8655
|
"documented": false,
|
|
8673
8656
|
"title": "values(any-of-1)(object-array)[*]"
|
|
8674
8657
|
},
|
|
8658
|
+
"title": "Object Array",
|
|
8675
8659
|
"documented": false
|
|
8676
8660
|
},
|
|
8677
8661
|
{
|
|
8678
|
-
"title": "Object",
|
|
8679
8662
|
"type": "object",
|
|
8680
8663
|
"propertyNames": {
|
|
8681
8664
|
"type": "string"
|
|
8682
8665
|
},
|
|
8683
8666
|
"additionalProperties": {},
|
|
8667
|
+
"title": "Object",
|
|
8684
8668
|
"documented": false
|
|
8685
8669
|
}
|
|
8686
8670
|
],
|
|
8671
|
+
"description": "Data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
8687
8672
|
"documented": false,
|
|
8688
8673
|
"title": "values(any-of-1)",
|
|
8689
8674
|
"markdownDescription": "Data formats for populating select and multiselect input options, supporting arrays and objects."
|
|
@@ -8727,8 +8712,6 @@
|
|
|
8727
8712
|
"markdownDescription": "This key defines how CloudCannon should render selectable options in the dropdown of a *Select Input*.\n\n## Examples\n\nIn this example, we have configured a *Select Input* to display options using the card view.\n\n```yaml\n_inputs:\n category:\n type: select\n options:\n values:\n - Blog\n - News\n - Events\n picker_view: card\n```"
|
|
8728
8713
|
},
|
|
8729
8714
|
"MultiselectInput": {
|
|
8730
|
-
"title": "Multiselect Input",
|
|
8731
|
-
"description": "This key defines an editing interface for data with multiple predefined options.\n\nMultiselect inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input*.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n label: Tags\n options:\n values:\n - featured\n - news\n - events\n```",
|
|
8732
8715
|
"type": "object",
|
|
8733
8716
|
"properties": {
|
|
8734
8717
|
"comment": {
|
|
@@ -8773,15 +8756,14 @@
|
|
|
8773
8756
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8774
8757
|
},
|
|
8775
8758
|
"type": {
|
|
8776
|
-
"title": "Type",
|
|
8777
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input* type.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n```",
|
|
8778
8759
|
"type": "string",
|
|
8779
8760
|
"const": "multiselect",
|
|
8761
|
+
"title": "Type",
|
|
8762
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input* type.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n```",
|
|
8780
8763
|
"documented": true,
|
|
8781
8764
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input* type.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n```"
|
|
8782
8765
|
},
|
|
8783
8766
|
"options": {
|
|
8784
|
-
"description": "This key defines options that are specific to Multiselect Inputs.\n\n## Examples\n\nIn this example, we have configured *Multiselect Input* options including values.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n options:\n values:\n - featured\n - news\n - events\n```",
|
|
8785
8767
|
"type": "object",
|
|
8786
8768
|
"properties": {
|
|
8787
8769
|
"required": {
|
|
@@ -8855,6 +8837,7 @@
|
|
|
8855
8837
|
}
|
|
8856
8838
|
},
|
|
8857
8839
|
"additionalProperties": false,
|
|
8840
|
+
"description": "This key defines options that are specific to Multiselect Inputs.\n\n## Examples\n\nIn this example, we have configured *Multiselect Input* options including values.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n options:\n values:\n - featured\n - news\n - events\n```",
|
|
8858
8841
|
"documented": true,
|
|
8859
8842
|
"title": "options",
|
|
8860
8843
|
"markdownDescription": "This key defines options that are specific to Multiselect Inputs.\n\n## Examples\n\nIn this example, we have configured *Multiselect Input* options including values.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n options:\n values:\n - featured\n - news\n - events\n```"
|
|
@@ -8864,6 +8847,8 @@
|
|
|
8864
8847
|
"type"
|
|
8865
8848
|
],
|
|
8866
8849
|
"additionalProperties": false,
|
|
8850
|
+
"title": "Multiselect Input",
|
|
8851
|
+
"description": "This key defines an editing interface for data with multiple predefined options.\n\nMultiselect inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input*.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n label: Tags\n options:\n values:\n - featured\n - news\n - events\n```",
|
|
8867
8852
|
"documented": true,
|
|
8868
8853
|
"markdownDescription": "This key defines an editing interface for data with multiple predefined options.\n\nMultiselect inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `tags` key as a *Multiselect Input*.\n\n```yaml\n_inputs:\n tags:\n type: multiselect\n label: Tags\n options:\n values:\n - featured\n - news\n - events\n```"
|
|
8869
8854
|
},
|
|
@@ -8910,8 +8895,8 @@
|
|
|
8910
8895
|
"markdownDescription": "This key defines a custom error message that explains why a value has failed the validation criteria from `options.unique_on`.\nThis key requires you to define `options.unique_on`.\n\nThis key has no default.\n\nThis key is available for Array inputs.\n\n## Examples\n\nIn this example, we want our team to add article filepaths to the `related_articles` Input. This Input requires all the filepaths to be unique.\n\n```yaml\n_inputs:\n related_articles:\n type: array\n options:\n unique_on: '$.path'\n unique_on_message: The value for path must be different for all items.\n```\n\n```yaml\nrelated_articles:\n - path: /articles/first-article.md\n featured: true\n - path: /articles/first-article.md\n featured: false\n```"
|
|
8911
8896
|
},
|
|
8912
8897
|
"type._inputs.*.options.empty_type(array)": {
|
|
8913
|
-
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty array values will be saved.\n\n```yaml\n_inputs:\n tags:\n type: array\n options:\n empty_type: array\n```",
|
|
8914
8898
|
"default": "null",
|
|
8899
|
+
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty array values will be saved.\n\n```yaml\n_inputs:\n tags:\n type: array\n options:\n empty_type: array\n```",
|
|
8915
8900
|
"type": "string",
|
|
8916
8901
|
"enum": [
|
|
8917
8902
|
"null",
|
|
@@ -8922,8 +8907,6 @@
|
|
|
8922
8907
|
"markdownDescription": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty array values will be saved.\n\n```yaml\n_inputs:\n tags:\n type: array\n options:\n empty_type: array\n```"
|
|
8923
8908
|
},
|
|
8924
8909
|
"ChoiceInput": {
|
|
8925
|
-
"title": "Choice Input",
|
|
8926
|
-
"description": "This key defines an editing interface for data with multiple predefined options.\n\nChoice inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input*.\n\n```yaml\n_inputs:\n status:\n type: choice\n label: Status\n options:\n values:\n - draft\n - published\n - archived\n```",
|
|
8927
8910
|
"type": "object",
|
|
8928
8911
|
"properties": {
|
|
8929
8912
|
"comment": {
|
|
@@ -8968,15 +8951,14 @@
|
|
|
8968
8951
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8969
8952
|
},
|
|
8970
8953
|
"type": {
|
|
8971
|
-
"title": "Type",
|
|
8972
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input* type.\n\n```yaml\n_inputs:\n status:\n type: choice\n```",
|
|
8973
8954
|
"type": "string",
|
|
8974
8955
|
"const": "choice",
|
|
8956
|
+
"title": "Type",
|
|
8957
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input* type.\n\n```yaml\n_inputs:\n status:\n type: choice\n```",
|
|
8975
8958
|
"documented": true,
|
|
8976
8959
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input* type.\n\n```yaml\n_inputs:\n status:\n type: choice\n```"
|
|
8977
8960
|
},
|
|
8978
8961
|
"options": {
|
|
8979
|
-
"description": "This key defines options that are specific to Choice Inputs.\n\n## Examples\n\nIn this example, we have configured *Choice Input* options including values.\n\n```yaml\n_inputs:\n status:\n type: choice\n options:\n values:\n - draft\n - published\n - archived\n```",
|
|
8980
8962
|
"type": "object",
|
|
8981
8963
|
"properties": {
|
|
8982
8964
|
"required": {
|
|
@@ -9077,6 +9059,7 @@
|
|
|
9077
9059
|
}
|
|
9078
9060
|
},
|
|
9079
9061
|
"additionalProperties": false,
|
|
9062
|
+
"description": "This key defines options that are specific to Choice Inputs.\n\n## Examples\n\nIn this example, we have configured *Choice Input* options including values.\n\n```yaml\n_inputs:\n status:\n type: choice\n options:\n values:\n - draft\n - published\n - archived\n```",
|
|
9080
9063
|
"documented": true,
|
|
9081
9064
|
"title": "options",
|
|
9082
9065
|
"markdownDescription": "This key defines options that are specific to Choice Inputs.\n\n## Examples\n\nIn this example, we have configured *Choice Input* options including values.\n\n```yaml\n_inputs:\n status:\n type: choice\n options:\n values:\n - draft\n - published\n - archived\n```"
|
|
@@ -9086,12 +9069,12 @@
|
|
|
9086
9069
|
"type"
|
|
9087
9070
|
],
|
|
9088
9071
|
"additionalProperties": false,
|
|
9072
|
+
"title": "Choice Input",
|
|
9073
|
+
"description": "This key defines an editing interface for data with multiple predefined options.\n\nChoice inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input*.\n\n```yaml\n_inputs:\n status:\n type: choice\n label: Status\n options:\n values:\n - draft\n - published\n - archived\n```",
|
|
9089
9074
|
"documented": true,
|
|
9090
9075
|
"markdownDescription": "This key defines an editing interface for data with multiple predefined options.\n\nChoice inputs only allow one value.\n\n## Examples\n\nIn this example, we have configured the `status` key as a *Choice Input*.\n\n```yaml\n_inputs:\n status:\n type: choice\n label: Status\n options:\n values:\n - draft\n - published\n - archived\n```"
|
|
9091
9076
|
},
|
|
9092
9077
|
"MultichoiceInput": {
|
|
9093
|
-
"title": "Multichoice Input",
|
|
9094
|
-
"description": "This key defines an editing interface for data with multiple predefined options.\n\nMultichoice inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input*.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n label: Categories\n options:\n values:\n - technology\n - design\n - business\n```",
|
|
9095
9078
|
"type": "object",
|
|
9096
9079
|
"properties": {
|
|
9097
9080
|
"comment": {
|
|
@@ -9136,15 +9119,14 @@
|
|
|
9136
9119
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9137
9120
|
},
|
|
9138
9121
|
"type": {
|
|
9139
|
-
"title": "Type",
|
|
9140
|
-
"description": "This key defines the type of editing interface used for an Input.\n\nEach Input type has a different appearance and functionality, processes and accepts different types of values, and has different configuration\noptions.\n\nValue can be one of the following: `auto`, `checkbox`, `switch`, `code`, `color`, `datetime`, `date`, `time`, `file`, `document`, `image`, `number`,\n`range`, `object`, `array`, `select`, `multiselect`, `choice`, `multichoice`, `text`, `textarea`, `email`, `html`, `markdown`, or `url`.\n\nIf the type or value of an Input is misconfigured, CloudCannon will display an orange warning instead of an Input.\n\nIf type is not configured for an Input, CloudCannon will attempt to determine Input type based on value or key name conventions.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input* type.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n```",
|
|
9141
9122
|
"type": "string",
|
|
9142
9123
|
"const": "multichoice",
|
|
9124
|
+
"title": "Type",
|
|
9125
|
+
"description": "This key defines the type of editing interface used for an Input.\n\nEach Input type has a different appearance and functionality, processes and accepts different types of values, and has different configuration\noptions.\n\nValue can be one of the following: `auto`, `checkbox`, `switch`, `code`, `color`, `datetime`, `date`, `time`, `file`, `document`, `image`, `number`,\n`range`, `object`, `array`, `select`, `multiselect`, `choice`, `multichoice`, `text`, `textarea`, `email`, `html`, `markdown`, or `url`.\n\nIf the type or value of an Input is misconfigured, CloudCannon will display an orange warning instead of an Input.\n\nIf type is not configured for an Input, CloudCannon will attempt to determine Input type based on value or key name conventions.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input* type.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n```",
|
|
9143
9126
|
"documented": true,
|
|
9144
9127
|
"markdownDescription": "This key defines the type of editing interface used for an Input.\n\nEach Input type has a different appearance and functionality, processes and accepts different types of values, and has different configuration\noptions.\n\nValue can be one of the following: `auto`, `checkbox`, `switch`, `code`, `color`, `datetime`, `date`, `time`, `file`, `document`, `image`, `number`,\n`range`, `object`, `array`, `select`, `multiselect`, `choice`, `multichoice`, `text`, `textarea`, `email`, `html`, `markdown`, or `url`.\n\nIf the type or value of an Input is misconfigured, CloudCannon will display an orange warning instead of an Input.\n\nIf type is not configured for an Input, CloudCannon will attempt to determine Input type based on value or key name conventions.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input* type.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n```"
|
|
9145
9128
|
},
|
|
9146
9129
|
"options": {
|
|
9147
|
-
"description": "This key defines options that are specific to Multichoice Inputs.\n\n## Examples\n\nIn this example, we have configured *Multichoice Input* options including values.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n options:\n values:\n - technology\n - design\n - business\n```",
|
|
9148
9130
|
"type": "object",
|
|
9149
9131
|
"properties": {
|
|
9150
9132
|
"required": {
|
|
@@ -9215,6 +9197,7 @@
|
|
|
9215
9197
|
}
|
|
9216
9198
|
},
|
|
9217
9199
|
"additionalProperties": false,
|
|
9200
|
+
"description": "This key defines options that are specific to Multichoice Inputs.\n\n## Examples\n\nIn this example, we have configured *Multichoice Input* options including values.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n options:\n values:\n - technology\n - design\n - business\n```",
|
|
9218
9201
|
"documented": true,
|
|
9219
9202
|
"title": "options",
|
|
9220
9203
|
"markdownDescription": "This key defines options that are specific to Multichoice Inputs.\n\n## Examples\n\nIn this example, we have configured *Multichoice Input* options including values.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n options:\n values:\n - technology\n - design\n - business\n```"
|
|
@@ -9224,12 +9207,12 @@
|
|
|
9224
9207
|
"type"
|
|
9225
9208
|
],
|
|
9226
9209
|
"additionalProperties": false,
|
|
9210
|
+
"title": "Multichoice Input",
|
|
9211
|
+
"description": "This key defines an editing interface for data with multiple predefined options.\n\nMultichoice inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input*.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n label: Categories\n options:\n values:\n - technology\n - design\n - business\n```",
|
|
9227
9212
|
"documented": true,
|
|
9228
9213
|
"markdownDescription": "This key defines an editing interface for data with multiple predefined options.\n\nMultichoice inputs allow several values.\n\n## Examples\n\nIn this example, we have configured the `categories` key as a *Multichoice Input*.\n\n```yaml\n_inputs:\n categories:\n type: multichoice\n label: Categories\n options:\n values:\n - technology\n - design\n - business\n```"
|
|
9229
9214
|
},
|
|
9230
9215
|
"ObjectInput": {
|
|
9231
|
-
"title": "Object Input",
|
|
9232
|
-
"description": "This key defines a user interface for a group of inputs.",
|
|
9233
9216
|
"type": "object",
|
|
9234
9217
|
"properties": {
|
|
9235
9218
|
"comment": {
|
|
@@ -9274,15 +9257,14 @@
|
|
|
9274
9257
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9275
9258
|
},
|
|
9276
9259
|
"type": {
|
|
9277
|
-
"title": "Type",
|
|
9278
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9279
9260
|
"type": "string",
|
|
9280
9261
|
"const": "object",
|
|
9262
|
+
"title": "Type",
|
|
9263
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9281
9264
|
"documented": true,
|
|
9282
9265
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
9283
9266
|
},
|
|
9284
9267
|
"options": {
|
|
9285
|
-
"description": "This key defines options that are specific to Object Inputs.",
|
|
9286
9268
|
"type": "object",
|
|
9287
9269
|
"properties": {
|
|
9288
9270
|
"required": {
|
|
@@ -9505,6 +9487,7 @@
|
|
|
9505
9487
|
}
|
|
9506
9488
|
},
|
|
9507
9489
|
"additionalProperties": false,
|
|
9490
|
+
"description": "This key defines options that are specific to Object Inputs.",
|
|
9508
9491
|
"documented": true,
|
|
9509
9492
|
"title": "options",
|
|
9510
9493
|
"markdownDescription": "This key defines options that are specific to Object Inputs."
|
|
@@ -9514,12 +9497,14 @@
|
|
|
9514
9497
|
"type"
|
|
9515
9498
|
],
|
|
9516
9499
|
"additionalProperties": false,
|
|
9500
|
+
"title": "Object Input",
|
|
9501
|
+
"description": "This key defines a user interface for a group of inputs.",
|
|
9517
9502
|
"documented": true,
|
|
9518
9503
|
"markdownDescription": "This key defines a user interface for a group of inputs."
|
|
9519
9504
|
},
|
|
9520
9505
|
"type._inputs.*.options.empty_type(object)": {
|
|
9521
|
-
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty object values will be saved.\n\n```yaml\n_inputs:\n metadata:\n type: object\n options:\n empty_type: object\n```",
|
|
9522
9506
|
"default": "null",
|
|
9507
|
+
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty object values will be saved.\n\n```yaml\n_inputs:\n metadata:\n type: object\n options:\n empty_type: object\n```",
|
|
9523
9508
|
"type": "string",
|
|
9524
9509
|
"enum": [
|
|
9525
9510
|
"null",
|
|
@@ -9530,9 +9515,9 @@
|
|
|
9530
9515
|
"markdownDescription": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.\n\n## Examples\n\nIn this example, we have configured how empty object values will be saved.\n\n```yaml\n_inputs:\n metadata:\n type: object\n options:\n empty_type: object\n```"
|
|
9531
9516
|
},
|
|
9532
9517
|
"type.structure-reference": {
|
|
9518
|
+
"type": "string",
|
|
9533
9519
|
"title": "Structure Reference",
|
|
9534
9520
|
"description": "A reference to an existing structure.",
|
|
9535
|
-
"type": "string",
|
|
9536
9521
|
"documented": true,
|
|
9537
9522
|
"markdownDescription": "A reference to an existing structure."
|
|
9538
9523
|
},
|
|
@@ -9544,8 +9529,6 @@
|
|
|
9544
9529
|
"markdownDescription": "This key defines the subtitle text above the key input when adding or renaming entries within a mutable *Object Input*.\n\nThe value is a string that supports a limited selection of Markdown formatting: links, bold, italic, subscript, superscript, and inline code elements are allowed.\n\nAvailable for Mutable Objects only.\n\n## Examples\n\nIn this example, we have configured a comment with Markdown formatting to provide help text above the key input.\n\n```yaml\n_inputs:\n metadata:\n type: object\n options:\n allow_create: true\n entries:\n comment: Key names should be **lowercase** and use underscores (e.g., `article_title`)\n```"
|
|
9545
9530
|
},
|
|
9546
9531
|
"ArrayInput": {
|
|
9547
|
-
"title": "Array Input",
|
|
9548
|
-
"description": "This key defines a user interface for lists of inputs or input groups.",
|
|
9549
9532
|
"type": "object",
|
|
9550
9533
|
"properties": {
|
|
9551
9534
|
"comment": {
|
|
@@ -9590,15 +9573,14 @@
|
|
|
9590
9573
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9591
9574
|
},
|
|
9592
9575
|
"type": {
|
|
9593
|
-
"title": "Type",
|
|
9594
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9595
9576
|
"type": "string",
|
|
9596
9577
|
"const": "array",
|
|
9578
|
+
"title": "Type",
|
|
9579
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9597
9580
|
"documented": true,
|
|
9598
9581
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
9599
9582
|
},
|
|
9600
9583
|
"options": {
|
|
9601
|
-
"description": "This key defines options that are specific to Array Inputs.",
|
|
9602
9584
|
"type": "object",
|
|
9603
9585
|
"properties": {
|
|
9604
9586
|
"required": {
|
|
@@ -9659,6 +9641,7 @@
|
|
|
9659
9641
|
}
|
|
9660
9642
|
},
|
|
9661
9643
|
"additionalProperties": false,
|
|
9644
|
+
"description": "This key defines options that are specific to Array Inputs.",
|
|
9662
9645
|
"documented": true,
|
|
9663
9646
|
"title": "options",
|
|
9664
9647
|
"markdownDescription": "This key defines options that are specific to Array Inputs."
|
|
@@ -9668,6 +9651,8 @@
|
|
|
9668
9651
|
"type"
|
|
9669
9652
|
],
|
|
9670
9653
|
"additionalProperties": false,
|
|
9654
|
+
"title": "Array Input",
|
|
9655
|
+
"description": "This key defines a user interface for lists of inputs or input groups.",
|
|
9671
9656
|
"documented": true,
|
|
9672
9657
|
"markdownDescription": "This key defines a user interface for lists of inputs or input groups."
|
|
9673
9658
|
},
|
|
@@ -9696,9 +9681,6 @@
|
|
|
9696
9681
|
"markdownDescription": "This key toggles whether CloudCannon will hide the controls on each item for moving them.\n\nSetting this key to `true` will hide the controls for moving items.\n\nBy default, this key is `false` (i.e., the controls for moving items are displayed)."
|
|
9697
9682
|
},
|
|
9698
9683
|
"AutoInput": {
|
|
9699
|
-
"title": "Automatic Input",
|
|
9700
|
-
"description": "Provides a default user interface based on the data contained.",
|
|
9701
|
-
"excludeFromDocumentation": true,
|
|
9702
9684
|
"type": "object",
|
|
9703
9685
|
"properties": {
|
|
9704
9686
|
"comment": {
|
|
@@ -9743,10 +9725,10 @@
|
|
|
9743
9725
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9744
9726
|
},
|
|
9745
9727
|
"type": {
|
|
9746
|
-
"title": "Type",
|
|
9747
|
-
"description": "Sets an input type, which controls how this input appears and behaves.",
|
|
9748
9728
|
"type": "string",
|
|
9749
9729
|
"const": "auto",
|
|
9730
|
+
"title": "Type",
|
|
9731
|
+
"description": "Sets an input type, which controls how this input appears and behaves.",
|
|
9750
9732
|
"documented": false,
|
|
9751
9733
|
"markdownDescription": "Sets an input type, which controls how this input appears and behaves."
|
|
9752
9734
|
},
|
|
@@ -9761,13 +9743,13 @@
|
|
|
9761
9743
|
"type"
|
|
9762
9744
|
],
|
|
9763
9745
|
"additionalProperties": false,
|
|
9746
|
+
"title": "Automatic Input",
|
|
9747
|
+
"description": "Provides a default user interface based on the data contained.",
|
|
9748
|
+
"excludeFromDocumentation": true,
|
|
9764
9749
|
"documented": false,
|
|
9765
9750
|
"markdownDescription": "Provides a default user interface based on the data contained."
|
|
9766
9751
|
},
|
|
9767
9752
|
"UnknownInput": {
|
|
9768
|
-
"title": "Unknown Input",
|
|
9769
|
-
"description": "Provides a default user interface based on the data contained.",
|
|
9770
|
-
"excludeFromDocumentation": true,
|
|
9771
9753
|
"type": "object",
|
|
9772
9754
|
"properties": {
|
|
9773
9755
|
"comment": {
|
|
@@ -9819,6 +9801,9 @@
|
|
|
9819
9801
|
}
|
|
9820
9802
|
},
|
|
9821
9803
|
"additionalProperties": false,
|
|
9804
|
+
"title": "Unknown Input",
|
|
9805
|
+
"description": "Provides a default user interface based on the data contained.",
|
|
9806
|
+
"excludeFromDocumentation": true,
|
|
9822
9807
|
"documented": false,
|
|
9823
9808
|
"markdownDescription": "Provides a default user interface based on the data contained."
|
|
9824
9809
|
},
|
|
@@ -9837,27 +9822,23 @@
|
|
|
9837
9822
|
"markdownDescription": "This key defines globs that filter which files CloudCannon should use for *Input* configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.inputs.yml`.\n\nYou can use this key anywhere you would use the `_inputs` key in the configuration cascade.\n\nThis key has no default.\n\n## Examples\n\nIn this example, we have several *Input Configuration Files* in the `.cloudcannon/inputs/` folder, with each file containing multiple *Input* definitions. The value of the `_inputs_from_glob` key tells CloudCannon to only use the `seo.cloudcannon.inputs.yml` and `blog-details.cloudcannon.inputs.yml` files in that folder.\n\n```yaml\ncollections_config:\n posts:\n path: content/posts\n icon: event\n inputs_from_glob:\n - '/.cloudcannon/inputs/seo.cloudcannon.inputs.yml'\n - '/.cloudcannon/inputs/blogDetails.cloudcannon.inputs.yml'\n```\n\n```yaml\nseo_title:\n type: text\n options:\n required: true\n max_length: 50\nseo_description:\n type: textarea\n options:\n show_count: true\n required: true\n max_length: 125\nseo_image:\n type: image\n options:\n path:\n uploads: images\n accepts_mime_types:\n - image/png\n - image/jpeg\n required: true\n pattern: (?i)\\.(jpe?g|png)$\n pattern_message: Please select a JPG or PNG image file\n```"
|
|
9838
9823
|
},
|
|
9839
9824
|
"type._select_data": {
|
|
9840
|
-
"title": "Select Data",
|
|
9841
|
-
"description": "This key defines defines fixed data sets to populate Select and Multiselect inputs at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_select_data` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [Select and Multiselect inputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/#fixed-data-sets).\n\n## Examples\n\nIn this example, we have configured the `blog_tags` Multiselect input for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _select_data:\n blog_topics:\n - Opinion\n - Feature\n - Resource\n```",
|
|
9842
9825
|
"type": "object",
|
|
9843
9826
|
"propertyNames": {
|
|
9844
9827
|
"type": "string"
|
|
9845
9828
|
},
|
|
9846
9829
|
"additionalProperties": {
|
|
9847
|
-
"description": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
9848
9830
|
"anyOf": [
|
|
9849
9831
|
{
|
|
9850
|
-
"title": "Text Array Select Data",
|
|
9851
9832
|
"type": "array",
|
|
9852
9833
|
"items": {
|
|
9853
9834
|
"type": "string",
|
|
9854
9835
|
"documented": true,
|
|
9855
9836
|
"title": "*(text-array)[*]"
|
|
9856
9837
|
},
|
|
9838
|
+
"title": "Text Array Select Data",
|
|
9857
9839
|
"documented": true
|
|
9858
9840
|
},
|
|
9859
9841
|
{
|
|
9860
|
-
"title": "Text Object Select Data",
|
|
9861
9842
|
"type": "object",
|
|
9862
9843
|
"propertyNames": {
|
|
9863
9844
|
"type": "string"
|
|
@@ -9867,10 +9848,10 @@
|
|
|
9867
9848
|
"documented": true,
|
|
9868
9849
|
"title": "*(text-object).*"
|
|
9869
9850
|
},
|
|
9851
|
+
"title": "Text Object Select Data",
|
|
9870
9852
|
"documented": true
|
|
9871
9853
|
},
|
|
9872
9854
|
{
|
|
9873
|
-
"title": "Object Array Select Data",
|
|
9874
9855
|
"type": "array",
|
|
9875
9856
|
"items": {
|
|
9876
9857
|
"type": "object",
|
|
@@ -9881,25 +9862,42 @@
|
|
|
9881
9862
|
"documented": true,
|
|
9882
9863
|
"title": "*(object-array)[*]"
|
|
9883
9864
|
},
|
|
9865
|
+
"title": "Object Array Select Data",
|
|
9884
9866
|
"documented": true
|
|
9885
9867
|
},
|
|
9886
9868
|
{
|
|
9887
|
-
"title": "Object Select Data",
|
|
9888
9869
|
"type": "object",
|
|
9889
9870
|
"propertyNames": {
|
|
9890
9871
|
"type": "string"
|
|
9891
9872
|
},
|
|
9892
9873
|
"additionalProperties": {},
|
|
9874
|
+
"title": "Object Select Data",
|
|
9893
9875
|
"documented": true
|
|
9894
9876
|
}
|
|
9895
9877
|
],
|
|
9878
|
+
"description": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
9896
9879
|
"documented": true,
|
|
9897
9880
|
"title": "_select_data.*",
|
|
9898
9881
|
"markdownDescription": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects."
|
|
9899
9882
|
},
|
|
9883
|
+
"title": "Select Data",
|
|
9884
|
+
"description": "This key defines defines fixed data sets to populate Select and Multiselect inputs at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_select_data` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [Select and Multiselect inputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/#fixed-data-sets).\n\n## Examples\n\nIn this example, we have configured the `blog_tags` Multiselect input for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _select_data:\n blog_topics:\n - Opinion\n - Feature\n - Resource\n```",
|
|
9900
9885
|
"documented": true,
|
|
9901
9886
|
"markdownDescription": "This key defines defines fixed data sets to populate Select and Multiselect inputs at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_select_data` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [Select and Multiselect inputs](https://cloudcannon.com/documentation/articles/what-is-a-select-input/#fixed-data-sets).\n\n## Examples\n\nIn this example, we have configured the `blog_tags` Multiselect input for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _select_data:\n blog_topics:\n - Opinion\n - Feature\n - Resource\n```"
|
|
9902
9887
|
},
|
|
9888
|
+
"type._structures": {
|
|
9889
|
+
"type": "object",
|
|
9890
|
+
"propertyNames": {
|
|
9891
|
+
"type": "string"
|
|
9892
|
+
},
|
|
9893
|
+
"additionalProperties": {
|
|
9894
|
+
"$ref": "#/definitions/type.structure"
|
|
9895
|
+
},
|
|
9896
|
+
"title": "Structures",
|
|
9897
|
+
"description": "This key defines which structures are available for [Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/) and [Array\ninputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/) at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_structures` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/).\n\n## Examples\n\nIn this example, we want to populate an Array input in the `blog` Collection with Related Articles, including the `name`, `description`, and `url` fields.\n\n```yaml\ncollections_config:\n blog:\n _structures:\n related_articles:\n style: select\n values:\n - preview:\n text:\n - key: name\n subtext:\n - key: url\n value:\n name:\n description:\n url:\n```\n\nIn this example, we want to populate an Array input with Staff members, including the `name`, `job_description`, and `profile_picture` fields for all staff types, and the `url` field for Managers only.\n\n```yaml\n_structures:\n staff:\n style: modal\n hide_extra_inputs: false\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```",
|
|
9898
|
+
"documented": true,
|
|
9899
|
+
"markdownDescription": "This key defines which structures are available for [Object inputs](https://cloudcannon.com/documentation/articles/what-is-an-object-input/) and [Array\ninputs](https://cloudcannon.com/documentation/articles/what-is-an-array-input/) at a given level of the configuration cascade.\n\nThis key has no default.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `_structures` will default to\nany values configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\nFor more information, please read our documentation on [structures](https://cloudcannon.com/documentation/articles/what-is-a-structure/).\n\n## Examples\n\nIn this example, we want to populate an Array input in the `blog` Collection with Related Articles, including the `name`, `description`, and `url` fields.\n\n```yaml\ncollections_config:\n blog:\n _structures:\n related_articles:\n style: select\n values:\n - preview:\n text:\n - key: name\n subtext:\n - key: url\n value:\n name:\n description:\n url:\n```\n\nIn this example, we want to populate an Array input with Staff members, including the `name`, `job_description`, and `profile_picture` fields for all staff types, and the `url` field for Managers only.\n\n```yaml\n_structures:\n staff:\n style: modal\n hide_extra_inputs: false\n values:\n - value:\n _type: Employee\n name:\n job_description:\n profile_picture:\n preview:\n text:\n - key: name\n - Employee\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: support_agent\n - value:\n _type: Manager\n name:\n job_description:\n profile_picture:\n url:\n preview:\n text:\n - key: name\n - Manager\n subtext:\n - key: job_description\n - Description of position\n image:\n - key: profile_picture\n icon: face\n```"
|
|
9900
|
+
},
|
|
9903
9901
|
"type._structures_from_glob": {
|
|
9904
9902
|
"type": "array",
|
|
9905
9903
|
"items": {
|
|
@@ -9916,5 +9914,5 @@
|
|
|
9916
9914
|
}
|
|
9917
9915
|
},
|
|
9918
9916
|
"documented": false,
|
|
9919
|
-
"
|
|
9917
|
+
"title": ""
|
|
9920
9918
|
}
|