@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,6 +1,5 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"$id": "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-snippets.schema.json",
|
|
4
3
|
"type": "object",
|
|
5
4
|
"propertyNames": {
|
|
6
5
|
"type": "string"
|
|
@@ -8,10 +7,9 @@
|
|
|
8
7
|
"additionalProperties": {
|
|
9
8
|
"$ref": "#/definitions/type.snippet"
|
|
10
9
|
},
|
|
10
|
+
"$id": "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-snippets.schema.json",
|
|
11
11
|
"definitions": {
|
|
12
12
|
"type.snippet": {
|
|
13
|
-
"title": "Snippet",
|
|
14
|
-
"description": "This key defines a snippet configuration.",
|
|
15
13
|
"type": "object",
|
|
16
14
|
"properties": {
|
|
17
15
|
"_inputs": {
|
|
@@ -142,7 +140,6 @@
|
|
|
142
140
|
"additionalProperties": {
|
|
143
141
|
"anyOf": [
|
|
144
142
|
{
|
|
145
|
-
"title": "Argument List Parser Configuration",
|
|
146
143
|
"type": "object",
|
|
147
144
|
"properties": {
|
|
148
145
|
"parser": {
|
|
@@ -182,12 +179,12 @@
|
|
|
182
179
|
"options"
|
|
183
180
|
],
|
|
184
181
|
"additionalProperties": false,
|
|
182
|
+
"title": "Argument List Parser Configuration",
|
|
185
183
|
"documented": true,
|
|
186
184
|
"description": "This key defines a parser configuration that parses a list of distinct positional arguments based on their position.\n\n## Examples\n\nIn this example, we have configured an argument list parser to parse distinct positional arguments based on their position.\n\n```markdown\n{{<figure \"image.png\" \"My image title\">}}\n └──────────────────────────┘\n```",
|
|
187
185
|
"markdownDescription": "This key defines a parser configuration that parses a list of distinct positional arguments based on their position.\n\n## Examples\n\nIn this example, we have configured an argument list parser to parse distinct positional arguments based on their position.\n\n```markdown\n{{<figure \"image.png\" \"My image title\">}}\n └──────────────────────────┘\n```"
|
|
188
186
|
},
|
|
189
187
|
{
|
|
190
|
-
"title": "Argument Parser Configuration",
|
|
191
188
|
"type": "object",
|
|
192
189
|
"properties": {
|
|
193
190
|
"parser": {
|
|
@@ -220,12 +217,12 @@
|
|
|
220
217
|
"options"
|
|
221
218
|
],
|
|
222
219
|
"additionalProperties": false,
|
|
220
|
+
"title": "Argument Parser Configuration",
|
|
223
221
|
"documented": true,
|
|
224
222
|
"description": "This key defines a parser configuration that parses a single argument, optionally delimited by characters.\n\nUseful for matching a single positional argument.\n\nThe argument parser is also used to parse a list of repeating arguments.\n\n## Examples\n\nIn this example, we have configured an argument parser to parse a single positional argument.\n\n```markdown\n{{<figure image.png>}}\n └───────┘\n```\n\nIn this example, we have configured an argument parser to parse a list of repeating arguments.\n\n```markdown\n{{<images image1.png image2.png image3.png>}}\n └──────────────────────────────┘\n```",
|
|
225
223
|
"markdownDescription": "This key defines a parser configuration that parses a single argument, optionally delimited by characters.\n\nUseful for matching a single positional argument.\n\nThe argument parser is also used to parse a list of repeating arguments.\n\n## Examples\n\nIn this example, we have configured an argument parser to parse a single positional argument.\n\n```markdown\n{{<figure image.png>}}\n └───────┘\n```\n\nIn this example, we have configured an argument parser to parse a list of repeating arguments.\n\n```markdown\n{{<images image1.png image2.png image3.png>}}\n └──────────────────────────────┘\n```"
|
|
226
224
|
},
|
|
227
225
|
{
|
|
228
|
-
"title": "Content Parser Configuration",
|
|
229
226
|
"type": "object",
|
|
230
227
|
"properties": {
|
|
231
228
|
"parser": {
|
|
@@ -357,12 +354,12 @@
|
|
|
357
354
|
"options"
|
|
358
355
|
],
|
|
359
356
|
"additionalProperties": false,
|
|
357
|
+
"title": "Content Parser Configuration",
|
|
360
358
|
"documented": true,
|
|
361
359
|
"description": "This key defines a parser configuration that parses rich multiline content, such as the content between paired tags. Can be configured to parse nested snippets within.\n\n## Examples\n\nIn this example, we have configured a content parser to parse rich multiline content between paired tags.\n\n```liquid\n{% highlight \"js\" %} let a = b; {% endhighlight %}\n └──────────┘\n```",
|
|
362
360
|
"markdownDescription": "This key defines a parser configuration that parses rich multiline content, such as the content between paired tags. Can be configured to parse nested snippets within.\n\n## Examples\n\nIn this example, we have configured a content parser to parse rich multiline content between paired tags.\n\n```liquid\n{% highlight \"js\" %} let a = b; {% endhighlight %}\n └──────────┘\n```"
|
|
363
361
|
},
|
|
364
362
|
{
|
|
365
|
-
"title": "Key Value List Parser Configuration",
|
|
366
363
|
"type": "object",
|
|
367
364
|
"properties": {
|
|
368
365
|
"parser": {
|
|
@@ -407,12 +404,12 @@
|
|
|
407
404
|
"parser"
|
|
408
405
|
],
|
|
409
406
|
"additionalProperties": false,
|
|
407
|
+
"title": "Key Value List Parser Configuration",
|
|
410
408
|
"documented": true,
|
|
411
409
|
"description": "This key defines a parser configuration that parses repeating pairs of keys and values.\n\nUseful for most SSG snippets that take properties.\n\nCan be configured to handle most syntax forms of key value pairs.\n\n## Examples\n\nIn this example, we have configured a key-value list parser to parse repeating pairs of keys and values in Liquid syntax.\n\n```liquid\n{% include \"image.html\" image: \"tree.png\" alt: \"Image of a tree\" %}\n └──────────────────────────────────────┘\n```\n\nIn this example, we have configured a key-value list parser to parse repeating pairs of keys and values in Markdown syntax.\n\n```markdown\n<Link href=\"/about/\" new_tab={true}/>\n └───────────────────────────┘\n```",
|
|
412
410
|
"markdownDescription": "This key defines a parser configuration that parses repeating pairs of keys and values.\n\nUseful for most SSG snippets that take properties.\n\nCan be configured to handle most syntax forms of key value pairs.\n\n## Examples\n\nIn this example, we have configured a key-value list parser to parse repeating pairs of keys and values in Liquid syntax.\n\n```liquid\n{% include \"image.html\" image: \"tree.png\" alt: \"Image of a tree\" %}\n └──────────────────────────────────────┘\n```\n\nIn this example, we have configured a key-value list parser to parse repeating pairs of keys and values in Markdown syntax.\n\n```markdown\n<Link href=\"/about/\" new_tab={true}/>\n └───────────────────────────┘\n```"
|
|
413
411
|
},
|
|
414
412
|
{
|
|
415
|
-
"title": "Literal Parser Configuration",
|
|
416
413
|
"type": "object",
|
|
417
414
|
"properties": {
|
|
418
415
|
"parser": {
|
|
@@ -473,12 +470,12 @@
|
|
|
473
470
|
"options"
|
|
474
471
|
],
|
|
475
472
|
"additionalProperties": false,
|
|
473
|
+
"title": "Literal Parser Configuration",
|
|
476
474
|
"documented": true,
|
|
477
475
|
"description": "This key defines a parser configuration that parses an exact literal value. Mainly useful when configuring a snippet template.",
|
|
478
476
|
"markdownDescription": "This key defines a parser configuration that parses an exact literal value. Mainly useful when configuring a snippet template."
|
|
479
477
|
},
|
|
480
478
|
{
|
|
481
|
-
"title": "Optional Parser Configuration",
|
|
482
479
|
"type": "object",
|
|
483
480
|
"properties": {
|
|
484
481
|
"parser": {
|
|
@@ -522,12 +519,12 @@
|
|
|
522
519
|
"options"
|
|
523
520
|
],
|
|
524
521
|
"additionalProperties": false,
|
|
522
|
+
"title": "Optional Parser Configuration",
|
|
525
523
|
"documented": true,
|
|
526
524
|
"description": "This key toggles whether matching zero times is a valid state for this parser.\n\nSetting this key to `true` will allow matching zero times as a valid state. If `false`, this parser requires at least one matching value. Setting this to `true` is preferred to wrapping the `repeating` parser inside an `optional` parser.\n\nBy default, this key is `false` (i.e., at least one matching value is required).",
|
|
527
525
|
"markdownDescription": "This key toggles whether matching zero times is a valid state for this parser.\n\nSetting this key to `true` will allow matching zero times as a valid state. If `false`, this parser requires at least one matching value. Setting this to `true` is preferred to wrapping the `repeating` parser inside an `optional` parser.\n\nBy default, this key is `false` (i.e., at least one matching value is required)."
|
|
528
526
|
},
|
|
529
527
|
{
|
|
530
|
-
"title": "Repeating Literal Parser Config",
|
|
531
528
|
"type": "object",
|
|
532
529
|
"properties": {
|
|
533
530
|
"parser": {
|
|
@@ -585,12 +582,12 @@
|
|
|
585
582
|
"options"
|
|
586
583
|
],
|
|
587
584
|
"additionalProperties": false,
|
|
585
|
+
"title": "Repeating Literal Parser Config",
|
|
588
586
|
"documented": true,
|
|
589
587
|
"description": "This key defines a parser configuration that parses a repeating set of exact literal values.",
|
|
590
588
|
"markdownDescription": "This key defines a parser configuration that parses a repeating set of exact literal values."
|
|
591
589
|
},
|
|
592
590
|
{
|
|
593
|
-
"title": "Repeating Parser Configuration",
|
|
594
591
|
"type": "object",
|
|
595
592
|
"properties": {
|
|
596
593
|
"parser": {
|
|
@@ -658,12 +655,12 @@
|
|
|
658
655
|
"options"
|
|
659
656
|
],
|
|
660
657
|
"additionalProperties": false,
|
|
658
|
+
"title": "Repeating Parser Configuration",
|
|
661
659
|
"documented": true,
|
|
662
660
|
"description": "This key defines a higher-order parser configuration that wraps a snippet string and allows it to repeat.",
|
|
663
661
|
"markdownDescription": "This key defines a higher-order parser configuration that wraps a snippet string and allows it to repeat."
|
|
664
662
|
},
|
|
665
663
|
{
|
|
666
|
-
"title": "Wrapper Parser Configuration",
|
|
667
664
|
"type": "object",
|
|
668
665
|
"properties": {
|
|
669
666
|
"parser": {
|
|
@@ -710,6 +707,7 @@
|
|
|
710
707
|
"options"
|
|
711
708
|
],
|
|
712
709
|
"additionalProperties": false,
|
|
710
|
+
"title": "Wrapper Parser Configuration",
|
|
713
711
|
"documented": true,
|
|
714
712
|
"description": "This key defines a wrapper parser configuration for wrapping another snippet configuration.\n\nThe value is an object that contains a `parser` property set to `wrapper` and an `options` object with `snippet` and optional `remove_empty` properties. The wrapper parser wraps another snippet configuration, allowing it to be used within a different snippet context.\n\n## Examples\n\nIn this example, we have configured a wrapper parser to wrap a content snippet.\n\n```yaml\n_snippets:\n example:\n snippet: \"<<example [[wrapped_content]]>>\"\n params:\n wrapped_content:\n parser: wrapper\n options:\n snippet: 'content'\n content:\n snippet: \"<<content [[text]]>>\"\n params:\n text:\n parser: content\n options:\n editor_key: content_text\n```",
|
|
715
713
|
"markdownDescription": "This key defines a wrapper parser configuration for wrapping another snippet configuration.\n\nThe value is an object that contains a `parser` property set to `wrapper` and an `options` object with `snippet` and optional `remove_empty` properties. The wrapper parser wraps another snippet configuration, allowing it to be used within a different snippet context.\n\n## Examples\n\nIn this example, we have configured a wrapper parser to wrap a content snippet.\n\n```yaml\n_snippets:\n example:\n snippet: \"<<example [[wrapped_content]]>>\"\n params:\n wrapped_content:\n parser: wrapper\n options:\n snippet: 'content'\n content:\n snippet: \"<<content [[text]]>>\"\n params:\n text:\n parser: content\n options:\n editor_key: content_text\n```"
|
|
@@ -725,12 +723,12 @@
|
|
|
725
723
|
}
|
|
726
724
|
},
|
|
727
725
|
"additionalProperties": false,
|
|
726
|
+
"title": "Snippet",
|
|
727
|
+
"description": "This key defines a snippet configuration.",
|
|
728
728
|
"documented": true,
|
|
729
729
|
"markdownDescription": "This key defines a snippet configuration."
|
|
730
730
|
},
|
|
731
731
|
"type._inputs": {
|
|
732
|
-
"title": "Inputs",
|
|
733
|
-
"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```",
|
|
734
732
|
"type": "object",
|
|
735
733
|
"propertyNames": {
|
|
736
734
|
"type": "string"
|
|
@@ -738,15 +736,14 @@
|
|
|
738
736
|
"additionalProperties": {
|
|
739
737
|
"$ref": "#/definitions/Input"
|
|
740
738
|
},
|
|
739
|
+
"title": "Inputs",
|
|
740
|
+
"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```",
|
|
741
741
|
"documented": true,
|
|
742
742
|
"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```"
|
|
743
743
|
},
|
|
744
744
|
"Input": {
|
|
745
|
-
"title": "Input",
|
|
746
745
|
"anyOf": [
|
|
747
746
|
{
|
|
748
|
-
"title": "Known Input",
|
|
749
|
-
"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```",
|
|
750
747
|
"oneOf": [
|
|
751
748
|
{
|
|
752
749
|
"$ref": "#/definitions/TextInput"
|
|
@@ -806,6 +803,8 @@
|
|
|
806
803
|
"$ref": "#/definitions/AutoInput"
|
|
807
804
|
}
|
|
808
805
|
],
|
|
806
|
+
"title": "Known Input",
|
|
807
|
+
"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
808
|
"documented": true,
|
|
810
809
|
"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```"
|
|
811
810
|
},
|
|
@@ -813,13 +812,12 @@
|
|
|
813
812
|
"$ref": "#/definitions/UnknownInput"
|
|
814
813
|
}
|
|
815
814
|
],
|
|
815
|
+
"title": "Input",
|
|
816
816
|
"documented": true,
|
|
817
817
|
"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```",
|
|
818
818
|
"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```"
|
|
819
819
|
},
|
|
820
820
|
"TextInput": {
|
|
821
|
-
"title": "Text Input",
|
|
822
|
-
"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```",
|
|
823
821
|
"type": "object",
|
|
824
822
|
"properties": {
|
|
825
823
|
"comment": {
|
|
@@ -864,8 +862,6 @@
|
|
|
864
862
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
865
863
|
},
|
|
866
864
|
"type": {
|
|
867
|
-
"title": "Type",
|
|
868
|
-
"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```",
|
|
869
865
|
"type": "string",
|
|
870
866
|
"enum": [
|
|
871
867
|
"text",
|
|
@@ -877,11 +873,12 @@
|
|
|
877
873
|
"github",
|
|
878
874
|
"instagram"
|
|
879
875
|
],
|
|
876
|
+
"title": "Type",
|
|
877
|
+
"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```",
|
|
880
878
|
"documented": true,
|
|
881
879
|
"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```"
|
|
882
880
|
},
|
|
883
881
|
"options": {
|
|
884
|
-
"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```",
|
|
885
882
|
"type": "object",
|
|
886
883
|
"properties": {
|
|
887
884
|
"max_length": {
|
|
@@ -989,6 +986,7 @@
|
|
|
989
986
|
}
|
|
990
987
|
},
|
|
991
988
|
"additionalProperties": false,
|
|
989
|
+
"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```",
|
|
992
990
|
"documented": true,
|
|
993
991
|
"title": "options",
|
|
994
992
|
"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```"
|
|
@@ -998,6 +996,8 @@
|
|
|
998
996
|
"type"
|
|
999
997
|
],
|
|
1000
998
|
"additionalProperties": false,
|
|
999
|
+
"title": "Text Input",
|
|
1000
|
+
"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```",
|
|
1001
1001
|
"documented": true,
|
|
1002
1002
|
"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```"
|
|
1003
1003
|
},
|
|
@@ -1009,7 +1009,6 @@
|
|
|
1009
1009
|
"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```"
|
|
1010
1010
|
},
|
|
1011
1011
|
"type._inputs.*.context": {
|
|
1012
|
-
"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```",
|
|
1013
1012
|
"type": "object",
|
|
1014
1013
|
"properties": {
|
|
1015
1014
|
"content": {
|
|
@@ -1047,13 +1046,12 @@
|
|
|
1047
1046
|
}
|
|
1048
1047
|
},
|
|
1049
1048
|
"additionalProperties": false,
|
|
1049
|
+
"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```",
|
|
1050
1050
|
"documented": true,
|
|
1051
1051
|
"title": "context",
|
|
1052
1052
|
"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```"
|
|
1053
1053
|
},
|
|
1054
1054
|
"icon": {
|
|
1055
|
-
"title": "Icon",
|
|
1056
|
-
"description": "Material Symbol icon names available in CloudCannon for UI elements and content previews.",
|
|
1057
1055
|
"type": "string",
|
|
1058
1056
|
"enum": [
|
|
1059
1057
|
"123",
|
|
@@ -4641,17 +4639,17 @@
|
|
|
4641
4639
|
"zoom_out",
|
|
4642
4640
|
"zoom_out_map"
|
|
4643
4641
|
],
|
|
4642
|
+
"title": "Icon",
|
|
4643
|
+
"description": "Material Symbol icon names available in CloudCannon for UI elements and content previews.",
|
|
4644
4644
|
"documented": false,
|
|
4645
4645
|
"markdownDescription": "Material Symbol icon names available in CloudCannon for UI elements and content previews."
|
|
4646
4646
|
},
|
|
4647
4647
|
"type.documentation": {
|
|
4648
|
-
"title": "Documentation",
|
|
4649
|
-
"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```",
|
|
4650
4648
|
"type": "object",
|
|
4651
4649
|
"properties": {
|
|
4652
4650
|
"url": {
|
|
4653
|
-
"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```",
|
|
4654
4651
|
"type": "string",
|
|
4652
|
+
"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```",
|
|
4655
4653
|
"documented": true,
|
|
4656
4654
|
"title": "url",
|
|
4657
4655
|
"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```"
|
|
@@ -4680,6 +4678,8 @@
|
|
|
4680
4678
|
"url"
|
|
4681
4679
|
],
|
|
4682
4680
|
"additionalProperties": false,
|
|
4681
|
+
"title": "Documentation",
|
|
4682
|
+
"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```",
|
|
4683
4683
|
"documented": true,
|
|
4684
4684
|
"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```"
|
|
4685
4685
|
},
|
|
@@ -4695,15 +4695,15 @@
|
|
|
4695
4695
|
"default": false,
|
|
4696
4696
|
"anyOf": [
|
|
4697
4697
|
{
|
|
4698
|
-
"title": "Boolean Hidden",
|
|
4699
4698
|
"type": "boolean",
|
|
4699
|
+
"title": "Boolean Hidden",
|
|
4700
4700
|
"documented": true,
|
|
4701
4701
|
"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```",
|
|
4702
4702
|
"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```"
|
|
4703
4703
|
},
|
|
4704
4704
|
{
|
|
4705
|
-
"title": "Query String Hidden",
|
|
4706
4705
|
"type": "string",
|
|
4706
|
+
"title": "Query String Hidden",
|
|
4707
4707
|
"documented": true,
|
|
4708
4708
|
"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```",
|
|
4709
4709
|
"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```"
|
|
@@ -4718,15 +4718,15 @@
|
|
|
4718
4718
|
"default": false,
|
|
4719
4719
|
"anyOf": [
|
|
4720
4720
|
{
|
|
4721
|
-
"title": "Boolean",
|
|
4722
4721
|
"type": "boolean",
|
|
4722
|
+
"title": "Boolean",
|
|
4723
4723
|
"documented": true,
|
|
4724
4724
|
"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```",
|
|
4725
4725
|
"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```"
|
|
4726
4726
|
},
|
|
4727
4727
|
{
|
|
4728
|
-
"title": "Query String",
|
|
4729
4728
|
"type": "string",
|
|
4729
|
+
"title": "Query String",
|
|
4730
4730
|
"documented": true,
|
|
4731
4731
|
"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```",
|
|
4732
4732
|
"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```"
|
|
@@ -4942,8 +4942,8 @@
|
|
|
4942
4942
|
"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```"
|
|
4943
4943
|
},
|
|
4944
4944
|
"type._inputs.*.options.empty_type(text)": {
|
|
4945
|
-
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.",
|
|
4946
4945
|
"default": "null",
|
|
4946
|
+
"description": "This key defines how an 'empty' value will be saved. Does not apply to existing empty values.",
|
|
4947
4947
|
"type": "string",
|
|
4948
4948
|
"enum": [
|
|
4949
4949
|
"null",
|
|
@@ -4969,17 +4969,16 @@
|
|
|
4969
4969
|
"title": "icon_color(previewentries)"
|
|
4970
4970
|
},
|
|
4971
4971
|
"type.preview-entry.(array)": {
|
|
4972
|
-
"title": "Array Preview Entry",
|
|
4973
4972
|
"type": "array",
|
|
4974
4973
|
"items": {
|
|
4975
4974
|
"$ref": "#/definitions/type.preview-entry"
|
|
4976
4975
|
},
|
|
4976
|
+
"title": "Array Preview Entry",
|
|
4977
4977
|
"documented": true,
|
|
4978
4978
|
"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```",
|
|
4979
4979
|
"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```"
|
|
4980
4980
|
},
|
|
4981
4981
|
"type.preview-entry": {
|
|
4982
|
-
"title": "Preview Entry",
|
|
4983
4982
|
"anyOf": [
|
|
4984
4983
|
{
|
|
4985
4984
|
"$ref": "#/definitions/type.preview-entry.(key)"
|
|
@@ -4997,17 +4996,17 @@
|
|
|
4997
4996
|
"$ref": "#/definitions/type.preview-entry.(false)"
|
|
4998
4997
|
}
|
|
4999
4998
|
],
|
|
4999
|
+
"title": "Preview Entry",
|
|
5000
5000
|
"documented": true,
|
|
5001
5001
|
"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```",
|
|
5002
5002
|
"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```"
|
|
5003
5003
|
},
|
|
5004
5004
|
"type.preview-entry.(key)": {
|
|
5005
|
-
"title": "Key Preview Entry",
|
|
5006
5005
|
"type": "object",
|
|
5007
5006
|
"properties": {
|
|
5008
5007
|
"key": {
|
|
5009
|
-
"title": "Key Value",
|
|
5010
5008
|
"type": "string",
|
|
5009
|
+
"title": "Key Value",
|
|
5011
5010
|
"documented": true,
|
|
5012
5011
|
"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```",
|
|
5013
5012
|
"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```"
|
|
@@ -5017,17 +5016,17 @@
|
|
|
5017
5016
|
"key"
|
|
5018
5017
|
],
|
|
5019
5018
|
"additionalProperties": false,
|
|
5019
|
+
"title": "Key Preview Entry",
|
|
5020
5020
|
"documented": true,
|
|
5021
5021
|
"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```",
|
|
5022
5022
|
"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```"
|
|
5023
5023
|
},
|
|
5024
5024
|
"type.preview-entry.(template)": {
|
|
5025
|
-
"title": "Template Preview Entry",
|
|
5026
5025
|
"type": "object",
|
|
5027
5026
|
"properties": {
|
|
5028
5027
|
"template": {
|
|
5029
|
-
"title": "Template Value",
|
|
5030
5028
|
"type": "string",
|
|
5029
|
+
"title": "Template Value",
|
|
5031
5030
|
"documented": true,
|
|
5032
5031
|
"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```",
|
|
5033
5032
|
"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```"
|
|
@@ -5037,17 +5036,17 @@
|
|
|
5037
5036
|
"template"
|
|
5038
5037
|
],
|
|
5039
5038
|
"additionalProperties": false,
|
|
5039
|
+
"title": "Template Preview Entry",
|
|
5040
5040
|
"documented": true,
|
|
5041
5041
|
"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```",
|
|
5042
5042
|
"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```"
|
|
5043
5043
|
},
|
|
5044
5044
|
"type.preview-entry.(text)": {
|
|
5045
|
-
"title": "Text Preview Entry",
|
|
5046
5045
|
"type": "object",
|
|
5047
5046
|
"properties": {
|
|
5048
5047
|
"text": {
|
|
5049
|
-
"title": "Text Value",
|
|
5050
5048
|
"type": "string",
|
|
5049
|
+
"title": "Text Value",
|
|
5051
5050
|
"documented": true,
|
|
5052
5051
|
"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```",
|
|
5053
5052
|
"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```"
|
|
@@ -5057,28 +5056,27 @@
|
|
|
5057
5056
|
"text"
|
|
5058
5057
|
],
|
|
5059
5058
|
"additionalProperties": false,
|
|
5059
|
+
"title": "Text Preview Entry",
|
|
5060
5060
|
"documented": true,
|
|
5061
5061
|
"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```",
|
|
5062
5062
|
"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```"
|
|
5063
5063
|
},
|
|
5064
5064
|
"type.preview-entry.(raw-text)": {
|
|
5065
|
-
"title": "Raw Text Preview Entry",
|
|
5066
5065
|
"type": "string",
|
|
5066
|
+
"title": "Raw Text Preview Entry",
|
|
5067
5067
|
"documented": true,
|
|
5068
5068
|
"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```",
|
|
5069
5069
|
"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```"
|
|
5070
5070
|
},
|
|
5071
5071
|
"type.preview-entry.(false)": {
|
|
5072
|
-
"title": "False Preview Entry",
|
|
5073
5072
|
"type": "boolean",
|
|
5074
5073
|
"const": false,
|
|
5074
|
+
"title": "False Preview Entry",
|
|
5075
5075
|
"documented": true,
|
|
5076
5076
|
"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```",
|
|
5077
5077
|
"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```"
|
|
5078
5078
|
},
|
|
5079
5079
|
"TextareaInput": {
|
|
5080
|
-
"title": "Textarea Input",
|
|
5081
|
-
"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```",
|
|
5082
5080
|
"type": "object",
|
|
5083
5081
|
"properties": {
|
|
5084
5082
|
"comment": {
|
|
@@ -5123,15 +5121,14 @@
|
|
|
5123
5121
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5124
5122
|
},
|
|
5125
5123
|
"type": {
|
|
5126
|
-
"title": "Type",
|
|
5127
|
-
"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```",
|
|
5128
5124
|
"type": "string",
|
|
5129
5125
|
"const": "textarea",
|
|
5126
|
+
"title": "Type",
|
|
5127
|
+
"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```",
|
|
5130
5128
|
"documented": true,
|
|
5131
5129
|
"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```"
|
|
5132
5130
|
},
|
|
5133
5131
|
"options": {
|
|
5134
|
-
"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```",
|
|
5135
5132
|
"type": "object",
|
|
5136
5133
|
"properties": {
|
|
5137
5134
|
"max_length": {
|
|
@@ -5214,6 +5211,7 @@
|
|
|
5214
5211
|
}
|
|
5215
5212
|
},
|
|
5216
5213
|
"additionalProperties": false,
|
|
5214
|
+
"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```",
|
|
5217
5215
|
"documented": true,
|
|
5218
5216
|
"title": "options",
|
|
5219
5217
|
"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```"
|
|
@@ -5223,12 +5221,12 @@
|
|
|
5223
5221
|
"type"
|
|
5224
5222
|
],
|
|
5225
5223
|
"additionalProperties": false,
|
|
5224
|
+
"title": "Textarea Input",
|
|
5225
|
+
"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```",
|
|
5226
5226
|
"documented": true,
|
|
5227
5227
|
"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```"
|
|
5228
5228
|
},
|
|
5229
5229
|
"CodeInput": {
|
|
5230
|
-
"title": "Code Input",
|
|
5231
|
-
"description": "This key defines an editing interface for code or mono-spaced plain text content.",
|
|
5232
5230
|
"type": "object",
|
|
5233
5231
|
"properties": {
|
|
5234
5232
|
"comment": {
|
|
@@ -5273,15 +5271,14 @@
|
|
|
5273
5271
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5274
5272
|
},
|
|
5275
5273
|
"type": {
|
|
5276
|
-
"title": "Type",
|
|
5277
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5278
5274
|
"type": "string",
|
|
5279
5275
|
"const": "code",
|
|
5276
|
+
"title": "Type",
|
|
5277
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5280
5278
|
"documented": true,
|
|
5281
5279
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5282
5280
|
},
|
|
5283
5281
|
"options": {
|
|
5284
|
-
"description": "This key defines options that are specific to Code Inputs.",
|
|
5285
5282
|
"type": "object",
|
|
5286
5283
|
"properties": {
|
|
5287
5284
|
"tab_size": {
|
|
@@ -5410,6 +5407,7 @@
|
|
|
5410
5407
|
}
|
|
5411
5408
|
},
|
|
5412
5409
|
"additionalProperties": false,
|
|
5410
|
+
"description": "This key defines options that are specific to Code Inputs.",
|
|
5413
5411
|
"documented": true,
|
|
5414
5412
|
"title": "options",
|
|
5415
5413
|
"markdownDescription": "This key defines options that are specific to Code Inputs."
|
|
@@ -5419,6 +5417,8 @@
|
|
|
5419
5417
|
"type"
|
|
5420
5418
|
],
|
|
5421
5419
|
"additionalProperties": false,
|
|
5420
|
+
"title": "Code Input",
|
|
5421
|
+
"description": "This key defines an editing interface for code or mono-spaced plain text content.",
|
|
5422
5422
|
"documented": true,
|
|
5423
5423
|
"markdownDescription": "This key defines an editing interface for code or mono-spaced plain text content."
|
|
5424
5424
|
},
|
|
@@ -5455,8 +5455,6 @@
|
|
|
5455
5455
|
"title": "theme(theme)"
|
|
5456
5456
|
},
|
|
5457
5457
|
"Syntax": {
|
|
5458
|
-
"title": "Syntax",
|
|
5459
|
-
"description": "Available syntax highlighting languages for code editors in CloudCannon.",
|
|
5460
5458
|
"type": "string",
|
|
5461
5459
|
"enum": [
|
|
5462
5460
|
"c_cpp",
|
|
@@ -5528,12 +5526,12 @@
|
|
|
5528
5526
|
"xquery",
|
|
5529
5527
|
"yaml"
|
|
5530
5528
|
],
|
|
5529
|
+
"title": "Syntax",
|
|
5530
|
+
"description": "Available syntax highlighting languages for code editors in CloudCannon.",
|
|
5531
5531
|
"documented": false,
|
|
5532
5532
|
"markdownDescription": "Available syntax highlighting languages for code editors in CloudCannon."
|
|
5533
5533
|
},
|
|
5534
5534
|
"ColorInput": {
|
|
5535
|
-
"title": "Color Input",
|
|
5536
|
-
"description": "This key defines an editing interface for color values.",
|
|
5537
5535
|
"type": "object",
|
|
5538
5536
|
"properties": {
|
|
5539
5537
|
"comment": {
|
|
@@ -5578,15 +5576,14 @@
|
|
|
5578
5576
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5579
5577
|
},
|
|
5580
5578
|
"type": {
|
|
5581
|
-
"title": "Type",
|
|
5582
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5583
5579
|
"type": "string",
|
|
5584
5580
|
"const": "color",
|
|
5581
|
+
"title": "Type",
|
|
5582
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5585
5583
|
"documented": true,
|
|
5586
5584
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5587
5585
|
},
|
|
5588
5586
|
"options": {
|
|
5589
|
-
"description": "This key defines options that are specific to Color Inputs.",
|
|
5590
5587
|
"type": "object",
|
|
5591
5588
|
"properties": {
|
|
5592
5589
|
"max_length": {
|
|
@@ -5696,6 +5693,7 @@
|
|
|
5696
5693
|
}
|
|
5697
5694
|
},
|
|
5698
5695
|
"additionalProperties": false,
|
|
5696
|
+
"description": "This key defines options that are specific to Color Inputs.",
|
|
5699
5697
|
"documented": true,
|
|
5700
5698
|
"title": "options",
|
|
5701
5699
|
"markdownDescription": "This key defines options that are specific to Color Inputs."
|
|
@@ -5705,12 +5703,12 @@
|
|
|
5705
5703
|
"type"
|
|
5706
5704
|
],
|
|
5707
5705
|
"additionalProperties": false,
|
|
5706
|
+
"title": "Color Input",
|
|
5707
|
+
"description": "This key defines an editing interface for color values.",
|
|
5708
5708
|
"documented": true,
|
|
5709
5709
|
"markdownDescription": "This key defines an editing interface for color values."
|
|
5710
5710
|
},
|
|
5711
5711
|
"BooleanInput": {
|
|
5712
|
-
"title": "Boolean Input",
|
|
5713
|
-
"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```",
|
|
5714
5712
|
"type": "object",
|
|
5715
5713
|
"properties": {
|
|
5716
5714
|
"comment": {
|
|
@@ -5755,13 +5753,13 @@
|
|
|
5755
5753
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5756
5754
|
},
|
|
5757
5755
|
"type": {
|
|
5758
|
-
"title": "Type",
|
|
5759
|
-
"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```",
|
|
5760
5756
|
"type": "string",
|
|
5761
5757
|
"enum": [
|
|
5762
5758
|
"checkbox",
|
|
5763
5759
|
"switch"
|
|
5764
5760
|
],
|
|
5761
|
+
"title": "Type",
|
|
5762
|
+
"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```",
|
|
5765
5763
|
"documented": true,
|
|
5766
5764
|
"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```"
|
|
5767
5765
|
}
|
|
@@ -5770,12 +5768,12 @@
|
|
|
5770
5768
|
"type"
|
|
5771
5769
|
],
|
|
5772
5770
|
"additionalProperties": false,
|
|
5771
|
+
"title": "Boolean Input",
|
|
5772
|
+
"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```",
|
|
5773
5773
|
"documented": true,
|
|
5774
5774
|
"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```"
|
|
5775
5775
|
},
|
|
5776
5776
|
"NumberInput": {
|
|
5777
|
-
"title": "Number Input",
|
|
5778
|
-
"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```",
|
|
5779
5777
|
"type": "object",
|
|
5780
5778
|
"properties": {
|
|
5781
5779
|
"comment": {
|
|
@@ -5820,15 +5818,14 @@
|
|
|
5820
5818
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5821
5819
|
},
|
|
5822
5820
|
"type": {
|
|
5823
|
-
"title": "Type",
|
|
5824
|
-
"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```",
|
|
5825
5821
|
"type": "string",
|
|
5826
5822
|
"const": "number",
|
|
5823
|
+
"title": "Type",
|
|
5824
|
+
"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```",
|
|
5827
5825
|
"documented": true,
|
|
5828
5826
|
"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```"
|
|
5829
5827
|
},
|
|
5830
5828
|
"options": {
|
|
5831
|
-
"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```",
|
|
5832
5829
|
"type": "object",
|
|
5833
5830
|
"properties": {
|
|
5834
5831
|
"required": {
|
|
@@ -5875,6 +5872,7 @@
|
|
|
5875
5872
|
}
|
|
5876
5873
|
},
|
|
5877
5874
|
"additionalProperties": false,
|
|
5875
|
+
"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```",
|
|
5878
5876
|
"documented": true,
|
|
5879
5877
|
"title": "options",
|
|
5880
5878
|
"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```"
|
|
@@ -5884,12 +5882,14 @@
|
|
|
5884
5882
|
"type"
|
|
5885
5883
|
],
|
|
5886
5884
|
"additionalProperties": false,
|
|
5885
|
+
"title": "Number Input",
|
|
5886
|
+
"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```",
|
|
5887
5887
|
"documented": true,
|
|
5888
5888
|
"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```"
|
|
5889
5889
|
},
|
|
5890
5890
|
"type._inputs.*.options.empty_type(number)": {
|
|
5891
|
-
"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```",
|
|
5892
5891
|
"default": "null",
|
|
5892
|
+
"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```",
|
|
5893
5893
|
"type": "string",
|
|
5894
5894
|
"enum": [
|
|
5895
5895
|
"null",
|
|
@@ -5900,15 +5900,15 @@
|
|
|
5900
5900
|
"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```"
|
|
5901
5901
|
},
|
|
5902
5902
|
"type._inputs.*.options.min": {
|
|
5903
|
-
"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```",
|
|
5904
5903
|
"type": "number",
|
|
5904
|
+
"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```",
|
|
5905
5905
|
"documented": true,
|
|
5906
5906
|
"title": "min",
|
|
5907
5907
|
"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```"
|
|
5908
5908
|
},
|
|
5909
5909
|
"type._inputs.*.options.max": {
|
|
5910
|
-
"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```",
|
|
5911
5910
|
"type": "number",
|
|
5911
|
+
"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```",
|
|
5912
5912
|
"documented": true,
|
|
5913
5913
|
"title": "max",
|
|
5914
5914
|
"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```"
|
|
@@ -5935,8 +5935,6 @@
|
|
|
5935
5935
|
"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```"
|
|
5936
5936
|
},
|
|
5937
5937
|
"RangeInput": {
|
|
5938
|
-
"title": "Range Input",
|
|
5939
|
-
"description": "This key defines a slider interface for selecting a numeric value.",
|
|
5940
5938
|
"type": "object",
|
|
5941
5939
|
"properties": {
|
|
5942
5940
|
"comment": {
|
|
@@ -5981,15 +5979,14 @@
|
|
|
5981
5979
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
5982
5980
|
},
|
|
5983
5981
|
"type": {
|
|
5984
|
-
"title": "Type",
|
|
5985
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5986
5982
|
"type": "string",
|
|
5987
5983
|
"const": "range",
|
|
5984
|
+
"title": "Type",
|
|
5985
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
5988
5986
|
"documented": true,
|
|
5989
5987
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
5990
5988
|
},
|
|
5991
5989
|
"options": {
|
|
5992
|
-
"description": "This key defines options that are specific to Range Inputs.",
|
|
5993
5990
|
"type": "object",
|
|
5994
5991
|
"properties": {
|
|
5995
5992
|
"required": {
|
|
@@ -6028,6 +6025,7 @@
|
|
|
6028
6025
|
"max"
|
|
6029
6026
|
],
|
|
6030
6027
|
"additionalProperties": false,
|
|
6028
|
+
"description": "This key defines options that are specific to Range Inputs.",
|
|
6031
6029
|
"documented": true,
|
|
6032
6030
|
"title": "options",
|
|
6033
6031
|
"markdownDescription": "This key defines options that are specific to Range Inputs."
|
|
@@ -6037,12 +6035,12 @@
|
|
|
6037
6035
|
"type"
|
|
6038
6036
|
],
|
|
6039
6037
|
"additionalProperties": false,
|
|
6038
|
+
"title": "Range Input",
|
|
6039
|
+
"description": "This key defines a slider interface for selecting a numeric value.",
|
|
6040
6040
|
"documented": true,
|
|
6041
6041
|
"markdownDescription": "This key defines a slider interface for selecting a numeric value."
|
|
6042
6042
|
},
|
|
6043
6043
|
"RichTextInput": {
|
|
6044
|
-
"title": "Rich Text Input",
|
|
6045
|
-
"description": "This key defines an editing interface for HTML markup content.",
|
|
6046
6044
|
"type": "object",
|
|
6047
6045
|
"properties": {
|
|
6048
6046
|
"comment": {
|
|
@@ -6087,18 +6085,17 @@
|
|
|
6087
6085
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
6088
6086
|
},
|
|
6089
6087
|
"type": {
|
|
6090
|
-
"title": "Type",
|
|
6091
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6092
6088
|
"type": "string",
|
|
6093
6089
|
"enum": [
|
|
6094
6090
|
"html",
|
|
6095
6091
|
"markdown"
|
|
6096
6092
|
],
|
|
6093
|
+
"title": "Type",
|
|
6094
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6097
6095
|
"documented": true,
|
|
6098
6096
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
6099
6097
|
},
|
|
6100
6098
|
"options": {
|
|
6101
|
-
"description": "This key defines options that are specific to Rich Text Inputs.",
|
|
6102
6099
|
"type": "object",
|
|
6103
6100
|
"properties": {
|
|
6104
6101
|
"mime_type": {
|
|
@@ -6304,11 +6301,11 @@
|
|
|
6304
6301
|
},
|
|
6305
6302
|
"allow_resize": {
|
|
6306
6303
|
"deprecated": true,
|
|
6307
|
-
"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).",
|
|
6308
6304
|
"type": "boolean",
|
|
6309
6305
|
"documented": true,
|
|
6310
6306
|
"title": "allow_resize",
|
|
6311
|
-
"
|
|
6307
|
+
"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).",
|
|
6308
|
+
"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)."
|
|
6312
6309
|
},
|
|
6313
6310
|
"prevent_resize": {
|
|
6314
6311
|
"description": "Shows or hides the resize handler to vertically resize the input.",
|
|
@@ -6327,6 +6324,7 @@
|
|
|
6327
6324
|
}
|
|
6328
6325
|
},
|
|
6329
6326
|
"additionalProperties": false,
|
|
6327
|
+
"description": "This key defines options that are specific to Rich Text Inputs.",
|
|
6330
6328
|
"documented": true,
|
|
6331
6329
|
"title": "options",
|
|
6332
6330
|
"markdownDescription": "This key defines options that are specific to Rich Text Inputs."
|
|
@@ -6336,6 +6334,8 @@
|
|
|
6336
6334
|
"type"
|
|
6337
6335
|
],
|
|
6338
6336
|
"additionalProperties": false,
|
|
6337
|
+
"title": "Rich Text Input",
|
|
6338
|
+
"description": "This key defines an editing interface for HTML markup content.",
|
|
6339
6339
|
"documented": true,
|
|
6340
6340
|
"markdownDescription": "This key defines an editing interface for HTML markup content."
|
|
6341
6341
|
},
|
|
@@ -6425,8 +6425,8 @@
|
|
|
6425
6425
|
"type": "object",
|
|
6426
6426
|
"properties": {
|
|
6427
6427
|
"size": {
|
|
6428
|
-
"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```",
|
|
6429
6428
|
"type": "string",
|
|
6429
|
+
"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```",
|
|
6430
6430
|
"documented": true,
|
|
6431
6431
|
"title": "size",
|
|
6432
6432
|
"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```"
|
|
@@ -6452,7 +6452,6 @@
|
|
|
6452
6452
|
"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```"
|
|
6453
6453
|
},
|
|
6454
6454
|
"type.paths": {
|
|
6455
|
-
"title": "Paths",
|
|
6456
6455
|
"type": "object",
|
|
6457
6456
|
"properties": {
|
|
6458
6457
|
"static": {
|
|
@@ -6478,6 +6477,7 @@
|
|
|
6478
6477
|
}
|
|
6479
6478
|
},
|
|
6480
6479
|
"additionalProperties": false,
|
|
6480
|
+
"title": "Paths",
|
|
6481
6481
|
"documented": true,
|
|
6482
6482
|
"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```",
|
|
6483
6483
|
"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```"
|
|
@@ -6799,8 +6799,6 @@
|
|
|
6799
6799
|
"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."
|
|
6800
6800
|
},
|
|
6801
6801
|
"DateInput": {
|
|
6802
|
-
"title": "Date/Datetime Input",
|
|
6803
|
-
"description": "This key defines an editing interface for date and/or time values.",
|
|
6804
6802
|
"type": "object",
|
|
6805
6803
|
"properties": {
|
|
6806
6804
|
"comment": {
|
|
@@ -6845,18 +6843,17 @@
|
|
|
6845
6843
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
6846
6844
|
},
|
|
6847
6845
|
"type": {
|
|
6848
|
-
"title": "Type",
|
|
6849
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6850
6846
|
"type": "string",
|
|
6851
6847
|
"enum": [
|
|
6852
6848
|
"date",
|
|
6853
6849
|
"datetime"
|
|
6854
6850
|
],
|
|
6851
|
+
"title": "Type",
|
|
6852
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
6855
6853
|
"documented": true,
|
|
6856
6854
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
6857
6855
|
},
|
|
6858
6856
|
"options": {
|
|
6859
|
-
"description": "This key defines options that are specific to Date Inputs.",
|
|
6860
6857
|
"type": "object",
|
|
6861
6858
|
"properties": {
|
|
6862
6859
|
"required": {
|
|
@@ -6889,10 +6886,10 @@
|
|
|
6889
6886
|
"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```",
|
|
6890
6887
|
"anyOf": [
|
|
6891
6888
|
{
|
|
6892
|
-
"title": "String Start From",
|
|
6893
6889
|
"type": "string",
|
|
6894
6890
|
"format": "date-time",
|
|
6895
6891
|
"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)))$",
|
|
6892
|
+
"title": "String Start From",
|
|
6896
6893
|
"documented": true,
|
|
6897
6894
|
"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.",
|
|
6898
6895
|
"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."
|
|
@@ -6919,10 +6916,10 @@
|
|
|
6919
6916
|
"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```",
|
|
6920
6917
|
"anyOf": [
|
|
6921
6918
|
{
|
|
6922
|
-
"title": "String End Before",
|
|
6923
6919
|
"type": "string",
|
|
6924
6920
|
"format": "date-time",
|
|
6925
6921
|
"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)))$",
|
|
6922
|
+
"title": "String End Before",
|
|
6926
6923
|
"documented": true,
|
|
6927
6924
|
"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.",
|
|
6928
6925
|
"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."
|
|
@@ -6947,6 +6944,7 @@
|
|
|
6947
6944
|
}
|
|
6948
6945
|
},
|
|
6949
6946
|
"additionalProperties": false,
|
|
6947
|
+
"description": "This key defines options that are specific to Date Inputs.",
|
|
6950
6948
|
"documented": true,
|
|
6951
6949
|
"title": "options",
|
|
6952
6950
|
"markdownDescription": "This key defines options that are specific to Date Inputs."
|
|
@@ -6956,11 +6954,12 @@
|
|
|
6956
6954
|
"type"
|
|
6957
6955
|
],
|
|
6958
6956
|
"additionalProperties": false,
|
|
6957
|
+
"title": "Date/Datetime Input",
|
|
6958
|
+
"description": "This key defines an editing interface for date and/or time values.",
|
|
6959
6959
|
"documented": true,
|
|
6960
6960
|
"markdownDescription": "This key defines an editing interface for date and/or time values."
|
|
6961
6961
|
},
|
|
6962
6962
|
"type.timezone": {
|
|
6963
|
-
"title": "Timezone",
|
|
6964
6963
|
"type": "string",
|
|
6965
6964
|
"enum": [
|
|
6966
6965
|
"Africa/Abidjan",
|
|
@@ -7559,13 +7558,12 @@
|
|
|
7559
7558
|
"WET",
|
|
7560
7559
|
"Zulu"
|
|
7561
7560
|
],
|
|
7561
|
+
"title": "Timezone",
|
|
7562
7562
|
"documented": true,
|
|
7563
7563
|
"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/).",
|
|
7564
7564
|
"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/)."
|
|
7565
7565
|
},
|
|
7566
7566
|
"TimeInput": {
|
|
7567
|
-
"title": "Time Input",
|
|
7568
|
-
"description": "This key defines an editing interface for time values only.",
|
|
7569
7567
|
"type": "object",
|
|
7570
7568
|
"properties": {
|
|
7571
7569
|
"comment": {
|
|
@@ -7610,15 +7608,14 @@
|
|
|
7610
7608
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
7611
7609
|
},
|
|
7612
7610
|
"type": {
|
|
7613
|
-
"title": "Type",
|
|
7614
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7615
7611
|
"type": "string",
|
|
7616
7612
|
"const": "time",
|
|
7613
|
+
"title": "Type",
|
|
7614
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7617
7615
|
"documented": true,
|
|
7618
7616
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
7619
7617
|
},
|
|
7620
7618
|
"options": {
|
|
7621
|
-
"description": "This key defines options that are specific to Time Inputs.",
|
|
7622
7619
|
"type": "object",
|
|
7623
7620
|
"properties": {
|
|
7624
7621
|
"required": {
|
|
@@ -7638,6 +7635,7 @@
|
|
|
7638
7635
|
}
|
|
7639
7636
|
},
|
|
7640
7637
|
"additionalProperties": false,
|
|
7638
|
+
"description": "This key defines options that are specific to Time Inputs.",
|
|
7641
7639
|
"documented": true,
|
|
7642
7640
|
"title": "options",
|
|
7643
7641
|
"markdownDescription": "This key defines options that are specific to Time Inputs."
|
|
@@ -7647,12 +7645,12 @@
|
|
|
7647
7645
|
"type"
|
|
7648
7646
|
],
|
|
7649
7647
|
"additionalProperties": false,
|
|
7648
|
+
"title": "Time Input",
|
|
7649
|
+
"description": "This key defines an editing interface for time values only.",
|
|
7650
7650
|
"documented": true,
|
|
7651
7651
|
"markdownDescription": "This key defines an editing interface for time values only."
|
|
7652
7652
|
},
|
|
7653
7653
|
"FileInput": {
|
|
7654
|
-
"title": "File Input",
|
|
7655
|
-
"description": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets.",
|
|
7656
7654
|
"type": "object",
|
|
7657
7655
|
"properties": {
|
|
7658
7656
|
"comment": {
|
|
@@ -7697,19 +7695,18 @@
|
|
|
7697
7695
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
7698
7696
|
},
|
|
7699
7697
|
"type": {
|
|
7700
|
-
"title": "Type",
|
|
7701
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7702
7698
|
"type": "string",
|
|
7703
7699
|
"enum": [
|
|
7704
7700
|
"file",
|
|
7705
7701
|
"document",
|
|
7706
7702
|
"image"
|
|
7707
7703
|
],
|
|
7704
|
+
"title": "Type",
|
|
7705
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
7708
7706
|
"documented": true,
|
|
7709
7707
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
7710
7708
|
},
|
|
7711
7709
|
"options": {
|
|
7712
|
-
"description": "This key defines options that are specific to File Inputs.",
|
|
7713
7710
|
"type": "object",
|
|
7714
7711
|
"properties": {
|
|
7715
7712
|
"mime_type": {
|
|
@@ -7831,6 +7828,7 @@
|
|
|
7831
7828
|
}
|
|
7832
7829
|
},
|
|
7833
7830
|
"additionalProperties": false,
|
|
7831
|
+
"description": "This key defines options that are specific to File Inputs.",
|
|
7834
7832
|
"documented": true,
|
|
7835
7833
|
"title": "options",
|
|
7836
7834
|
"markdownDescription": "This key defines options that are specific to File Inputs."
|
|
@@ -7840,6 +7838,8 @@
|
|
|
7840
7838
|
"type"
|
|
7841
7839
|
],
|
|
7842
7840
|
"additionalProperties": false,
|
|
7841
|
+
"title": "File Input",
|
|
7842
|
+
"description": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets.",
|
|
7843
7843
|
"documented": true,
|
|
7844
7844
|
"markdownDescription": "This key defines an editing interface for uploading files to your repository or DAM and browsing existing assets."
|
|
7845
7845
|
},
|
|
@@ -7847,18 +7847,18 @@
|
|
|
7847
7847
|
"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```",
|
|
7848
7848
|
"anyOf": [
|
|
7849
7849
|
{
|
|
7850
|
-
"title": "Comma Separated Accepts Mime Types",
|
|
7851
7850
|
"type": "string",
|
|
7851
|
+
"title": "Comma Separated Accepts Mime Types",
|
|
7852
7852
|
"documented": true,
|
|
7853
7853
|
"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```",
|
|
7854
7854
|
"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```"
|
|
7855
7855
|
},
|
|
7856
7856
|
{
|
|
7857
|
-
"title": "Array Accepts Mime Types",
|
|
7858
7857
|
"type": "array",
|
|
7859
7858
|
"items": {
|
|
7860
7859
|
"$ref": "#/definitions/MimeType"
|
|
7861
7860
|
},
|
|
7861
|
+
"title": "Array Accepts Mime Types",
|
|
7862
7862
|
"documented": true,
|
|
7863
7863
|
"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```",
|
|
7864
7864
|
"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```"
|
|
@@ -7869,8 +7869,6 @@
|
|
|
7869
7869
|
"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```"
|
|
7870
7870
|
},
|
|
7871
7871
|
"MimeType": {
|
|
7872
|
-
"title": "Mime Type",
|
|
7873
|
-
"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```",
|
|
7874
7872
|
"type": "string",
|
|
7875
7873
|
"enum": [
|
|
7876
7874
|
"x-world/x-3dmf",
|
|
@@ -8307,6 +8305,8 @@
|
|
|
8307
8305
|
"multipart/x-zip",
|
|
8308
8306
|
"text/x-script.zsh"
|
|
8309
8307
|
],
|
|
8308
|
+
"title": "Mime Type",
|
|
8309
|
+
"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```",
|
|
8310
8310
|
"documented": true,
|
|
8311
8311
|
"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```"
|
|
8312
8312
|
},
|
|
@@ -8349,8 +8349,6 @@
|
|
|
8349
8349
|
"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```"
|
|
8350
8350
|
},
|
|
8351
8351
|
"UrlInput": {
|
|
8352
|
-
"title": "URL Input",
|
|
8353
|
-
"description": "This key defines an editing interface for relative, absolute, and fully qualified URLs.",
|
|
8354
8352
|
"type": "object",
|
|
8355
8353
|
"properties": {
|
|
8356
8354
|
"comment": {
|
|
@@ -8395,15 +8393,14 @@
|
|
|
8395
8393
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8396
8394
|
},
|
|
8397
8395
|
"type": {
|
|
8398
|
-
"title": "Type",
|
|
8399
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
8400
8396
|
"type": "string",
|
|
8401
8397
|
"const": "url",
|
|
8398
|
+
"title": "Type",
|
|
8399
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
8402
8400
|
"documented": true,
|
|
8403
8401
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
8404
8402
|
},
|
|
8405
8403
|
"options": {
|
|
8406
|
-
"description": "This key defines options that are specific to URL Inputs.",
|
|
8407
8404
|
"type": "object",
|
|
8408
8405
|
"properties": {
|
|
8409
8406
|
"mime_type": {
|
|
@@ -8557,6 +8554,7 @@
|
|
|
8557
8554
|
}
|
|
8558
8555
|
},
|
|
8559
8556
|
"additionalProperties": false,
|
|
8557
|
+
"description": "This key defines options that are specific to URL Inputs.",
|
|
8560
8558
|
"documented": true,
|
|
8561
8559
|
"title": "options",
|
|
8562
8560
|
"markdownDescription": "This key defines options that are specific to URL Inputs."
|
|
@@ -8566,12 +8564,12 @@
|
|
|
8566
8564
|
"type"
|
|
8567
8565
|
],
|
|
8568
8566
|
"additionalProperties": false,
|
|
8567
|
+
"title": "URL Input",
|
|
8568
|
+
"description": "This key defines an editing interface for relative, absolute, and fully qualified URLs.",
|
|
8569
8569
|
"documented": true,
|
|
8570
8570
|
"markdownDescription": "This key defines an editing interface for relative, absolute, and fully qualified URLs."
|
|
8571
8571
|
},
|
|
8572
8572
|
"SelectInput": {
|
|
8573
|
-
"title": "Select Input",
|
|
8574
|
-
"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```",
|
|
8575
8573
|
"type": "object",
|
|
8576
8574
|
"properties": {
|
|
8577
8575
|
"comment": {
|
|
@@ -8616,15 +8614,14 @@
|
|
|
8616
8614
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
8617
8615
|
},
|
|
8618
8616
|
"type": {
|
|
8619
|
-
"title": "Type",
|
|
8620
|
-
"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```",
|
|
8621
8617
|
"type": "string",
|
|
8622
8618
|
"const": "select",
|
|
8619
|
+
"title": "Type",
|
|
8620
|
+
"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```",
|
|
8623
8621
|
"documented": true,
|
|
8624
8622
|
"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```"
|
|
8625
8623
|
},
|
|
8626
8624
|
"options": {
|
|
8627
|
-
"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```",
|
|
8628
8625
|
"type": "object",
|
|
8629
8626
|
"properties": {
|
|
8630
8627
|
"required": {
|
|
@@ -8728,6 +8725,7 @@
|
|
|
8728
8725
|
}
|
|
8729
8726
|
},
|
|
8730
8727
|
"additionalProperties": false,
|
|
8728
|
+
"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```",
|
|
8731
8729
|
"documented": true,
|
|
8732
8730
|
"title": "options",
|
|
8733
8731
|
"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```"
|
|
@@ -8737,11 +8735,12 @@
|
|
|
8737
8735
|
"type"
|
|
8738
8736
|
],
|
|
8739
8737
|
"additionalProperties": false,
|
|
8738
|
+
"title": "Select Input",
|
|
8739
|
+
"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```",
|
|
8740
8740
|
"documented": true,
|
|
8741
8741
|
"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```"
|
|
8742
8742
|
},
|
|
8743
8743
|
"type.preview": {
|
|
8744
|
-
"title": "Preview",
|
|
8745
8744
|
"type": "object",
|
|
8746
8745
|
"properties": {
|
|
8747
8746
|
"text": {
|
|
@@ -8773,6 +8772,7 @@
|
|
|
8773
8772
|
}
|
|
8774
8773
|
},
|
|
8775
8774
|
"additionalProperties": false,
|
|
8775
|
+
"title": "Preview",
|
|
8776
8776
|
"documented": true,
|
|
8777
8777
|
"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```",
|
|
8778
8778
|
"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```"
|
|
@@ -8969,37 +8969,35 @@
|
|
|
8969
8969
|
},
|
|
8970
8970
|
"type._inputs.*.options.allow_empty": {
|
|
8971
8971
|
"deprecated": true,
|
|
8972
|
-
"description": "
|
|
8972
|
+
"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```",
|
|
8973
8973
|
"type": "boolean",
|
|
8974
8974
|
"documented": true,
|
|
8975
8975
|
"title": "allow_empty",
|
|
8976
|
-
"markdownDescription": "
|
|
8976
|
+
"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```"
|
|
8977
8977
|
},
|
|
8978
8978
|
"type._inputs.*.options.values": {
|
|
8979
8979
|
"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```",
|
|
8980
8980
|
"anyOf": [
|
|
8981
8981
|
{
|
|
8982
|
+
"type": "string",
|
|
8982
8983
|
"title": "Dataset Reference Values",
|
|
8983
8984
|
"description": "This key defines a reference to a dataset.",
|
|
8984
|
-
"type": "string",
|
|
8985
8985
|
"documented": true,
|
|
8986
8986
|
"markdownDescription": "This key defines a reference to a dataset."
|
|
8987
8987
|
},
|
|
8988
8988
|
{
|
|
8989
|
-
"description": "Data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
8990
8989
|
"anyOf": [
|
|
8991
8990
|
{
|
|
8992
|
-
"title": "Text Array",
|
|
8993
8991
|
"type": "array",
|
|
8994
8992
|
"items": {
|
|
8995
8993
|
"type": "string",
|
|
8996
8994
|
"documented": false,
|
|
8997
8995
|
"title": "values(any-of-1)(text-array)[*]"
|
|
8998
8996
|
},
|
|
8997
|
+
"title": "Text Array",
|
|
8999
8998
|
"documented": false
|
|
9000
8999
|
},
|
|
9001
9000
|
{
|
|
9002
|
-
"title": "Text Object",
|
|
9003
9001
|
"type": "object",
|
|
9004
9002
|
"propertyNames": {
|
|
9005
9003
|
"type": "string"
|
|
@@ -9009,10 +9007,10 @@
|
|
|
9009
9007
|
"documented": false,
|
|
9010
9008
|
"title": "values(any-of-1)(text-object).*"
|
|
9011
9009
|
},
|
|
9010
|
+
"title": "Text Object",
|
|
9012
9011
|
"documented": false
|
|
9013
9012
|
},
|
|
9014
9013
|
{
|
|
9015
|
-
"title": "Object Array",
|
|
9016
9014
|
"type": "array",
|
|
9017
9015
|
"items": {
|
|
9018
9016
|
"type": "object",
|
|
@@ -9023,18 +9021,20 @@
|
|
|
9023
9021
|
"documented": false,
|
|
9024
9022
|
"title": "values(any-of-1)(object-array)[*]"
|
|
9025
9023
|
},
|
|
9024
|
+
"title": "Object Array",
|
|
9026
9025
|
"documented": false
|
|
9027
9026
|
},
|
|
9028
9027
|
{
|
|
9029
|
-
"title": "Object",
|
|
9030
9028
|
"type": "object",
|
|
9031
9029
|
"propertyNames": {
|
|
9032
9030
|
"type": "string"
|
|
9033
9031
|
},
|
|
9034
9032
|
"additionalProperties": {},
|
|
9033
|
+
"title": "Object",
|
|
9035
9034
|
"documented": false
|
|
9036
9035
|
}
|
|
9037
9036
|
],
|
|
9037
|
+
"description": "Data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
9038
9038
|
"documented": false,
|
|
9039
9039
|
"title": "values(any-of-1)",
|
|
9040
9040
|
"markdownDescription": "Data formats for populating select and multiselect input options, supporting arrays and objects."
|
|
@@ -9078,8 +9078,6 @@
|
|
|
9078
9078
|
"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```"
|
|
9079
9079
|
},
|
|
9080
9080
|
"MultiselectInput": {
|
|
9081
|
-
"title": "Multiselect Input",
|
|
9082
|
-
"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```",
|
|
9083
9081
|
"type": "object",
|
|
9084
9082
|
"properties": {
|
|
9085
9083
|
"comment": {
|
|
@@ -9124,15 +9122,14 @@
|
|
|
9124
9122
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9125
9123
|
},
|
|
9126
9124
|
"type": {
|
|
9127
|
-
"title": "Type",
|
|
9128
|
-
"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```",
|
|
9129
9125
|
"type": "string",
|
|
9130
9126
|
"const": "multiselect",
|
|
9127
|
+
"title": "Type",
|
|
9128
|
+
"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```",
|
|
9131
9129
|
"documented": true,
|
|
9132
9130
|
"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```"
|
|
9133
9131
|
},
|
|
9134
9132
|
"options": {
|
|
9135
|
-
"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```",
|
|
9136
9133
|
"type": "object",
|
|
9137
9134
|
"properties": {
|
|
9138
9135
|
"required": {
|
|
@@ -9206,6 +9203,7 @@
|
|
|
9206
9203
|
}
|
|
9207
9204
|
},
|
|
9208
9205
|
"additionalProperties": false,
|
|
9206
|
+
"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```",
|
|
9209
9207
|
"documented": true,
|
|
9210
9208
|
"title": "options",
|
|
9211
9209
|
"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```"
|
|
@@ -9215,6 +9213,8 @@
|
|
|
9215
9213
|
"type"
|
|
9216
9214
|
],
|
|
9217
9215
|
"additionalProperties": false,
|
|
9216
|
+
"title": "Multiselect Input",
|
|
9217
|
+
"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```",
|
|
9218
9218
|
"documented": true,
|
|
9219
9219
|
"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```"
|
|
9220
9220
|
},
|
|
@@ -9261,8 +9261,8 @@
|
|
|
9261
9261
|
"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```"
|
|
9262
9262
|
},
|
|
9263
9263
|
"type._inputs.*.options.empty_type(array)": {
|
|
9264
|
-
"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```",
|
|
9265
9264
|
"default": "null",
|
|
9265
|
+
"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```",
|
|
9266
9266
|
"type": "string",
|
|
9267
9267
|
"enum": [
|
|
9268
9268
|
"null",
|
|
@@ -9273,8 +9273,6 @@
|
|
|
9273
9273
|
"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```"
|
|
9274
9274
|
},
|
|
9275
9275
|
"ChoiceInput": {
|
|
9276
|
-
"title": "Choice Input",
|
|
9277
|
-
"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```",
|
|
9278
9276
|
"type": "object",
|
|
9279
9277
|
"properties": {
|
|
9280
9278
|
"comment": {
|
|
@@ -9319,15 +9317,14 @@
|
|
|
9319
9317
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9320
9318
|
},
|
|
9321
9319
|
"type": {
|
|
9322
|
-
"title": "Type",
|
|
9323
|
-
"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```",
|
|
9324
9320
|
"type": "string",
|
|
9325
9321
|
"const": "choice",
|
|
9322
|
+
"title": "Type",
|
|
9323
|
+
"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```",
|
|
9326
9324
|
"documented": true,
|
|
9327
9325
|
"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```"
|
|
9328
9326
|
},
|
|
9329
9327
|
"options": {
|
|
9330
|
-
"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```",
|
|
9331
9328
|
"type": "object",
|
|
9332
9329
|
"properties": {
|
|
9333
9330
|
"required": {
|
|
@@ -9428,6 +9425,7 @@
|
|
|
9428
9425
|
}
|
|
9429
9426
|
},
|
|
9430
9427
|
"additionalProperties": false,
|
|
9428
|
+
"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```",
|
|
9431
9429
|
"documented": true,
|
|
9432
9430
|
"title": "options",
|
|
9433
9431
|
"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```"
|
|
@@ -9437,12 +9435,12 @@
|
|
|
9437
9435
|
"type"
|
|
9438
9436
|
],
|
|
9439
9437
|
"additionalProperties": false,
|
|
9438
|
+
"title": "Choice Input",
|
|
9439
|
+
"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```",
|
|
9440
9440
|
"documented": true,
|
|
9441
9441
|
"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```"
|
|
9442
9442
|
},
|
|
9443
9443
|
"MultichoiceInput": {
|
|
9444
|
-
"title": "Multichoice Input",
|
|
9445
|
-
"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```",
|
|
9446
9444
|
"type": "object",
|
|
9447
9445
|
"properties": {
|
|
9448
9446
|
"comment": {
|
|
@@ -9487,15 +9485,14 @@
|
|
|
9487
9485
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9488
9486
|
},
|
|
9489
9487
|
"type": {
|
|
9490
|
-
"title": "Type",
|
|
9491
|
-
"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```",
|
|
9492
9488
|
"type": "string",
|
|
9493
9489
|
"const": "multichoice",
|
|
9490
|
+
"title": "Type",
|
|
9491
|
+
"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```",
|
|
9494
9492
|
"documented": true,
|
|
9495
9493
|
"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```"
|
|
9496
9494
|
},
|
|
9497
9495
|
"options": {
|
|
9498
|
-
"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```",
|
|
9499
9496
|
"type": "object",
|
|
9500
9497
|
"properties": {
|
|
9501
9498
|
"required": {
|
|
@@ -9566,6 +9563,7 @@
|
|
|
9566
9563
|
}
|
|
9567
9564
|
},
|
|
9568
9565
|
"additionalProperties": false,
|
|
9566
|
+
"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```",
|
|
9569
9567
|
"documented": true,
|
|
9570
9568
|
"title": "options",
|
|
9571
9569
|
"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```"
|
|
@@ -9575,12 +9573,12 @@
|
|
|
9575
9573
|
"type"
|
|
9576
9574
|
],
|
|
9577
9575
|
"additionalProperties": false,
|
|
9576
|
+
"title": "Multichoice Input",
|
|
9577
|
+
"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```",
|
|
9578
9578
|
"documented": true,
|
|
9579
9579
|
"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```"
|
|
9580
9580
|
},
|
|
9581
9581
|
"ObjectInput": {
|
|
9582
|
-
"title": "Object Input",
|
|
9583
|
-
"description": "This key defines a user interface for a group of inputs.",
|
|
9584
9582
|
"type": "object",
|
|
9585
9583
|
"properties": {
|
|
9586
9584
|
"comment": {
|
|
@@ -9625,15 +9623,14 @@
|
|
|
9625
9623
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
9626
9624
|
},
|
|
9627
9625
|
"type": {
|
|
9628
|
-
"title": "Type",
|
|
9629
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9630
9626
|
"type": "string",
|
|
9631
9627
|
"const": "object",
|
|
9628
|
+
"title": "Type",
|
|
9629
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
9632
9630
|
"documented": true,
|
|
9633
9631
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
9634
9632
|
},
|
|
9635
9633
|
"options": {
|
|
9636
|
-
"description": "This key defines options that are specific to Object Inputs.",
|
|
9637
9634
|
"type": "object",
|
|
9638
9635
|
"properties": {
|
|
9639
9636
|
"required": {
|
|
@@ -9856,6 +9853,7 @@
|
|
|
9856
9853
|
}
|
|
9857
9854
|
},
|
|
9858
9855
|
"additionalProperties": false,
|
|
9856
|
+
"description": "This key defines options that are specific to Object Inputs.",
|
|
9859
9857
|
"documented": true,
|
|
9860
9858
|
"title": "options",
|
|
9861
9859
|
"markdownDescription": "This key defines options that are specific to Object Inputs."
|
|
@@ -9865,12 +9863,14 @@
|
|
|
9865
9863
|
"type"
|
|
9866
9864
|
],
|
|
9867
9865
|
"additionalProperties": false,
|
|
9866
|
+
"title": "Object Input",
|
|
9867
|
+
"description": "This key defines a user interface for a group of inputs.",
|
|
9868
9868
|
"documented": true,
|
|
9869
9869
|
"markdownDescription": "This key defines a user interface for a group of inputs."
|
|
9870
9870
|
},
|
|
9871
9871
|
"type._inputs.*.options.empty_type(object)": {
|
|
9872
|
-
"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```",
|
|
9873
9872
|
"default": "null",
|
|
9873
|
+
"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```",
|
|
9874
9874
|
"type": "string",
|
|
9875
9875
|
"enum": [
|
|
9876
9876
|
"null",
|
|
@@ -9881,15 +9881,13 @@
|
|
|
9881
9881
|
"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```"
|
|
9882
9882
|
},
|
|
9883
9883
|
"type.structure-reference": {
|
|
9884
|
+
"type": "string",
|
|
9884
9885
|
"title": "Structure Reference",
|
|
9885
9886
|
"description": "A reference to an existing structure.",
|
|
9886
|
-
"type": "string",
|
|
9887
9887
|
"documented": true,
|
|
9888
9888
|
"markdownDescription": "A reference to an existing structure."
|
|
9889
9889
|
},
|
|
9890
9890
|
"type.structure": {
|
|
9891
|
-
"title": "Structure",
|
|
9892
|
-
"description": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values.",
|
|
9893
9891
|
"type": "object",
|
|
9894
9892
|
"properties": {
|
|
9895
9893
|
"reorder_inputs": {
|
|
@@ -9925,11 +9923,11 @@
|
|
|
9925
9923
|
"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```"
|
|
9926
9924
|
},
|
|
9927
9925
|
"values": {
|
|
9928
|
-
"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```",
|
|
9929
9926
|
"type": "array",
|
|
9930
9927
|
"items": {
|
|
9931
9928
|
"$ref": "#/definitions/type.structure.values.[*]"
|
|
9932
9929
|
},
|
|
9930
|
+
"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```",
|
|
9933
9931
|
"documented": true,
|
|
9934
9932
|
"title": "values",
|
|
9935
9933
|
"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```"
|
|
@@ -9973,12 +9971,12 @@
|
|
|
9973
9971
|
"values"
|
|
9974
9972
|
],
|
|
9975
9973
|
"additionalProperties": false,
|
|
9974
|
+
"title": "Structure",
|
|
9975
|
+
"description": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values.",
|
|
9976
9976
|
"documented": true,
|
|
9977
9977
|
"markdownDescription": "This key defines data formats when adding new items to arrays and objects, with options for how editors choose from available values."
|
|
9978
9978
|
},
|
|
9979
9979
|
"type.structure.values.[*]": {
|
|
9980
|
-
"title": "Structure Value",
|
|
9981
|
-
"description": "This key represents a single value option within a structure, defining the data format and appearance for content editors.",
|
|
9982
9980
|
"type": "object",
|
|
9983
9981
|
"properties": {
|
|
9984
9982
|
"reorder_inputs": {
|
|
@@ -10239,6 +10237,8 @@
|
|
|
10239
10237
|
"value"
|
|
10240
10238
|
],
|
|
10241
10239
|
"additionalProperties": false,
|
|
10240
|
+
"title": "Structure Value",
|
|
10241
|
+
"description": "This key represents a single value option within a structure, defining the data format and appearance for content editors.",
|
|
10242
10242
|
"documented": true,
|
|
10243
10243
|
"markdownDescription": "This key represents a single value option within a structure, defining the data format and appearance for content editors."
|
|
10244
10244
|
},
|
|
@@ -10257,27 +10257,23 @@
|
|
|
10257
10257
|
"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```"
|
|
10258
10258
|
},
|
|
10259
10259
|
"type._select_data": {
|
|
10260
|
-
"title": "Select Data",
|
|
10261
|
-
"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```",
|
|
10262
10260
|
"type": "object",
|
|
10263
10261
|
"propertyNames": {
|
|
10264
10262
|
"type": "string"
|
|
10265
10263
|
},
|
|
10266
10264
|
"additionalProperties": {
|
|
10267
|
-
"description": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
10268
10265
|
"anyOf": [
|
|
10269
10266
|
{
|
|
10270
|
-
"title": "Text Array Select Data",
|
|
10271
10267
|
"type": "array",
|
|
10272
10268
|
"items": {
|
|
10273
10269
|
"type": "string",
|
|
10274
10270
|
"documented": true,
|
|
10275
10271
|
"title": "*(text-array)[*]"
|
|
10276
10272
|
},
|
|
10273
|
+
"title": "Text Array Select Data",
|
|
10277
10274
|
"documented": true
|
|
10278
10275
|
},
|
|
10279
10276
|
{
|
|
10280
|
-
"title": "Text Object Select Data",
|
|
10281
10277
|
"type": "object",
|
|
10282
10278
|
"propertyNames": {
|
|
10283
10279
|
"type": "string"
|
|
@@ -10287,10 +10283,10 @@
|
|
|
10287
10283
|
"documented": true,
|
|
10288
10284
|
"title": "*(text-object).*"
|
|
10289
10285
|
},
|
|
10286
|
+
"title": "Text Object Select Data",
|
|
10290
10287
|
"documented": true
|
|
10291
10288
|
},
|
|
10292
10289
|
{
|
|
10293
|
-
"title": "Object Array Select Data",
|
|
10294
10290
|
"type": "array",
|
|
10295
10291
|
"items": {
|
|
10296
10292
|
"type": "object",
|
|
@@ -10301,28 +10297,30 @@
|
|
|
10301
10297
|
"documented": true,
|
|
10302
10298
|
"title": "*(object-array)[*]"
|
|
10303
10299
|
},
|
|
10300
|
+
"title": "Object Array Select Data",
|
|
10304
10301
|
"documented": true
|
|
10305
10302
|
},
|
|
10306
10303
|
{
|
|
10307
|
-
"title": "Object Select Data",
|
|
10308
10304
|
"type": "object",
|
|
10309
10305
|
"propertyNames": {
|
|
10310
10306
|
"type": "string"
|
|
10311
10307
|
},
|
|
10312
10308
|
"additionalProperties": {},
|
|
10309
|
+
"title": "Object Select Data",
|
|
10313
10310
|
"documented": true
|
|
10314
10311
|
}
|
|
10315
10312
|
],
|
|
10313
|
+
"description": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects.",
|
|
10316
10314
|
"documented": true,
|
|
10317
10315
|
"title": "_select_data.*",
|
|
10318
10316
|
"markdownDescription": "This key defines data formats for populating select and multiselect input options, supporting arrays and objects."
|
|
10319
10317
|
},
|
|
10318
|
+
"title": "Select Data",
|
|
10319
|
+
"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```",
|
|
10320
10320
|
"documented": true,
|
|
10321
10321
|
"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```"
|
|
10322
10322
|
},
|
|
10323
10323
|
"type._structures": {
|
|
10324
|
-
"title": "Structures",
|
|
10325
|
-
"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```",
|
|
10326
10324
|
"type": "object",
|
|
10327
10325
|
"propertyNames": {
|
|
10328
10326
|
"type": "string"
|
|
@@ -10330,6 +10328,8 @@
|
|
|
10330
10328
|
"additionalProperties": {
|
|
10331
10329
|
"$ref": "#/definitions/type.structure"
|
|
10332
10330
|
},
|
|
10331
|
+
"title": "Structures",
|
|
10332
|
+
"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```",
|
|
10333
10333
|
"documented": true,
|
|
10334
10334
|
"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```"
|
|
10335
10335
|
},
|
|
@@ -10355,8 +10355,6 @@
|
|
|
10355
10355
|
"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```"
|
|
10356
10356
|
},
|
|
10357
10357
|
"ArrayInput": {
|
|
10358
|
-
"title": "Array Input",
|
|
10359
|
-
"description": "This key defines a user interface for lists of inputs or input groups.",
|
|
10360
10358
|
"type": "object",
|
|
10361
10359
|
"properties": {
|
|
10362
10360
|
"comment": {
|
|
@@ -10401,15 +10399,14 @@
|
|
|
10401
10399
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
10402
10400
|
},
|
|
10403
10401
|
"type": {
|
|
10404
|
-
"title": "Type",
|
|
10405
|
-
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
10406
10402
|
"type": "string",
|
|
10407
10403
|
"const": "array",
|
|
10404
|
+
"title": "Type",
|
|
10405
|
+
"description": "This key defines the input type, which controls how this input appears and behaves.",
|
|
10408
10406
|
"documented": true,
|
|
10409
10407
|
"markdownDescription": "This key defines the input type, which controls how this input appears and behaves."
|
|
10410
10408
|
},
|
|
10411
10409
|
"options": {
|
|
10412
|
-
"description": "This key defines options that are specific to Array Inputs.",
|
|
10413
10410
|
"type": "object",
|
|
10414
10411
|
"properties": {
|
|
10415
10412
|
"required": {
|
|
@@ -10470,6 +10467,7 @@
|
|
|
10470
10467
|
}
|
|
10471
10468
|
},
|
|
10472
10469
|
"additionalProperties": false,
|
|
10470
|
+
"description": "This key defines options that are specific to Array Inputs.",
|
|
10473
10471
|
"documented": true,
|
|
10474
10472
|
"title": "options",
|
|
10475
10473
|
"markdownDescription": "This key defines options that are specific to Array Inputs."
|
|
@@ -10479,6 +10477,8 @@
|
|
|
10479
10477
|
"type"
|
|
10480
10478
|
],
|
|
10481
10479
|
"additionalProperties": false,
|
|
10480
|
+
"title": "Array Input",
|
|
10481
|
+
"description": "This key defines a user interface for lists of inputs or input groups.",
|
|
10482
10482
|
"documented": true,
|
|
10483
10483
|
"markdownDescription": "This key defines a user interface for lists of inputs or input groups."
|
|
10484
10484
|
},
|
|
@@ -10507,9 +10507,6 @@
|
|
|
10507
10507
|
"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)."
|
|
10508
10508
|
},
|
|
10509
10509
|
"AutoInput": {
|
|
10510
|
-
"title": "Automatic Input",
|
|
10511
|
-
"description": "Provides a default user interface based on the data contained.",
|
|
10512
|
-
"excludeFromDocumentation": true,
|
|
10513
10510
|
"type": "object",
|
|
10514
10511
|
"properties": {
|
|
10515
10512
|
"comment": {
|
|
@@ -10554,10 +10551,10 @@
|
|
|
10554
10551
|
"$ref": "#/definitions/type._inputs.*.cascade"
|
|
10555
10552
|
},
|
|
10556
10553
|
"type": {
|
|
10557
|
-
"title": "Type",
|
|
10558
|
-
"description": "Sets an input type, which controls how this input appears and behaves.",
|
|
10559
10554
|
"type": "string",
|
|
10560
10555
|
"const": "auto",
|
|
10556
|
+
"title": "Type",
|
|
10557
|
+
"description": "Sets an input type, which controls how this input appears and behaves.",
|
|
10561
10558
|
"documented": false,
|
|
10562
10559
|
"markdownDescription": "Sets an input type, which controls how this input appears and behaves."
|
|
10563
10560
|
},
|
|
@@ -10572,13 +10569,13 @@
|
|
|
10572
10569
|
"type"
|
|
10573
10570
|
],
|
|
10574
10571
|
"additionalProperties": false,
|
|
10572
|
+
"title": "Automatic Input",
|
|
10573
|
+
"description": "Provides a default user interface based on the data contained.",
|
|
10574
|
+
"excludeFromDocumentation": true,
|
|
10575
10575
|
"documented": false,
|
|
10576
10576
|
"markdownDescription": "Provides a default user interface based on the data contained."
|
|
10577
10577
|
},
|
|
10578
10578
|
"UnknownInput": {
|
|
10579
|
-
"title": "Unknown Input",
|
|
10580
|
-
"description": "Provides a default user interface based on the data contained.",
|
|
10581
|
-
"excludeFromDocumentation": true,
|
|
10582
10579
|
"type": "object",
|
|
10583
10580
|
"properties": {
|
|
10584
10581
|
"comment": {
|
|
@@ -10630,6 +10627,9 @@
|
|
|
10630
10627
|
}
|
|
10631
10628
|
},
|
|
10632
10629
|
"additionalProperties": false,
|
|
10630
|
+
"title": "Unknown Input",
|
|
10631
|
+
"description": "Provides a default user interface based on the data contained.",
|
|
10632
|
+
"excludeFromDocumentation": true,
|
|
10633
10633
|
"documented": false,
|
|
10634
10634
|
"markdownDescription": "Provides a default user interface based on the data contained."
|
|
10635
10635
|
},
|