@sveltia/cms 0.87.2 → 0.87.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +87 -42
  2. package/dist/sveltia-cms.js +202 -200
  3. package/dist/sveltia-cms.js.map +1 -1
  4. package/dist/sveltia-cms.mjs +206 -204
  5. package/dist/sveltia-cms.mjs.map +1 -1
  6. package/package.json +1 -1
  7. package/schema/sveltia-cms.json +1387 -842
  8. package/types/public.d.ts +217 -149
package/schema/sveltia-cms.json CHANGED
@@ -7,11 +7,13 @@
7
7
  "properties": {
8
8
  "load_config_file": {
9
9
  "type": "boolean",
10
- "description": "Whether to load YAML/JSON site configuration file(s) when manually initializing the CMS. This works only in the `CMS.init()` method’s `config` option. Default: `true`."
10
+ "description": "Whether to load YAML/JSON site configuration file(s) when [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works only in the `CMS.init()` method’s `config` option. Default: `true`.",
11
+ "markdownDescription": "Whether to load YAML/JSON site configuration file(s) when [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works only in the `CMS.init()` method’s `config` option. Default: `true`."
11
12
  },
12
13
  "backend": {
13
14
  "$ref": "#/definitions/BackendOptions",
14
- "description": "Backend options."
15
+ "description": "Backend options.",
16
+ "markdownDescription": "Backend options."
15
17
  },
16
18
  "publish_mode": {
17
19
  "type": "string",
@@ -20,15 +22,18 @@
20
22
  "editorial_workflow",
21
23
  ""
22
24
  ],
23
- "description": "Publish mode. An empty string is the same as `simple`. Default: `simple`."
25
+ "description": "Publish mode. An empty string is the same as `simple`. Default: `simple`.",
26
+ "markdownDescription": "Publish mode. An empty string is the same as `simple`. Default: `simple`."
24
27
  },
25
28
  "media_folder": {
26
29
  "type": "string",
27
- "description": "Global internal media folder path, relative to the project’s root directory."
30
+ "description": "Global internal media folder path, relative to the project’s root directory.",
31
+ "markdownDescription": "Global internal media folder path, relative to the project’s root directory."
28
32
  },
29
33
  "public_folder": {
30
34
  "type": "string",
31
- "description": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value."
35
+ "description": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value.",
36
+ "markdownDescription": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value."
32
37
  },
33
38
  "media_library": {
34
39
  "anyOf": [
@@ -38,11 +43,13 @@
38
43
  "properties": {
39
44
  "name": {
40
45
  "$ref": "#/definitions/MediaLibraryName",
41
- "description": "Library name."
46
+ "description": "Library name.",
47
+ "markdownDescription": "Library name."
42
48
  },
43
49
  "config": {
44
50
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
45
- "description": "Configuration for the default media library."
51
+ "description": "Configuration for the default media library.",
52
+ "markdownDescription": "Configuration for the default media library."
46
53
  }
47
54
  },
48
55
  "required": [
@@ -55,23 +62,28 @@
55
62
  "properties": {
56
63
  "name": {
57
64
  "$ref": "#/definitions/MediaLibraryName",
58
- "description": "Library name."
65
+ "description": "Library name.",
66
+ "markdownDescription": "Library name."
59
67
  },
60
68
  "output_filename_only": {
61
69
  "type": "boolean",
62
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
70
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
71
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
63
72
  },
64
73
  "use_transformations": {
65
74
  "type": "boolean",
66
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
75
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
76
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
67
77
  },
68
78
  "use_secure_url": {
69
79
  "type": "boolean",
70
- "description": "Whether to use an HTTP URL. Default: `true`."
80
+ "description": "Whether to use an HTTP URL. Default: `true`.",
81
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
71
82
  },
72
83
  "config": {
73
84
  "type": "object",
74
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
85
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
86
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
75
87
  }
76
88
  },
77
89
  "required": [
@@ -84,15 +96,18 @@
84
96
  "properties": {
85
97
  "name": {
86
98
  "$ref": "#/definitions/MediaLibraryName",
87
- "description": "Library name."
99
+ "description": "Library name.",
100
+ "markdownDescription": "Library name."
88
101
  },
89
102
  "config": {
90
103
  "type": "object",
91
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
104
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
105
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
92
106
  },
93
107
  "settings": {
94
108
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
95
- "description": "Integration settings."
109
+ "description": "Integration settings.",
110
+ "markdownDescription": "Integration settings."
96
111
  }
97
112
  },
98
113
  "required": [
@@ -105,14 +120,16 @@
105
120
  "properties": {
106
121
  "name": {
107
122
  "$ref": "#/definitions/MediaLibraryName",
108
- "description": "Library name."
123
+ "description": "Library name.",
124
+ "markdownDescription": "Library name."
109
125
  },
110
126
  "providers": {
111
127
  "type": "array",
112
128
  "items": {
113
129
  "$ref": "#/definitions/StockAssetProviderName"
114
130
  },
115
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
131
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
132
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
116
133
  }
117
134
  },
118
135
  "required": [
@@ -120,57 +137,83 @@
120
137
  ]
121
138
  }
122
139
  ],
123
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
140
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
141
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
124
142
  },
125
143
  "media_libraries": {
126
144
  "$ref": "#/definitions/MediaLibraries",
127
- "description": "Unified media library option that supports multiple libraries."
145
+ "description": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details.",
146
+ "markdownDescription": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details."
128
147
  },
129
148
  "site_url": {
130
149
  "type": "string",
131
- "description": "Site URL. Default: current site’s origin (`location.origin`)."
150
+ "description": "Site URL. Default: current site’s origin ([`location.origin`](https://developer.mozilla.org/en-US/docs/Web/API/Location/origin)).",
151
+ "markdownDescription": "Site URL. Default: current site’s origin ([`location.origin`](https://developer.mozilla.org/en-US/docs/Web/API/Location/origin))."
132
152
  },
133
153
  "display_url": {
134
154
  "type": "string",
135
- "description": "Site URL linked from the UI. Default: `site_url` option value."
155
+ "description": "Site URL linked from the UI. Default: `site_url` option value.",
156
+ "markdownDescription": "Site URL linked from the UI. Default: `site_url` option value."
136
157
  },
137
158
  "logo_url": {
138
159
  "type": "string",
139
- "description": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo."
160
+ "description": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo.",
161
+ "markdownDescription": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo."
140
162
  },
141
163
  "show_preview_links": {
142
164
  "type": "boolean",
143
- "description": "Whether to show site preview links. Default: `true`."
165
+ "description": "Whether to show site preview links. Default: `true`.",
166
+ "markdownDescription": "Whether to show site preview links. Default: `true`."
144
167
  },
145
168
  "slug": {
146
169
  "$ref": "#/definitions/SlugOptions",
147
- "description": "Entry slug options."
170
+ "description": "Entry slug options.",
171
+ "markdownDescription": "Entry slug options."
148
172
  },
149
173
  "collections": {
150
174
  "type": "array",
151
175
  "items": {
152
- "$ref": "#/definitions/Collection"
176
+ "anyOf": [
177
+ {
178
+ "$ref": "#/definitions/Collection"
179
+ },
180
+ {
181
+ "$ref": "#/definitions/CollectionDivider"
182
+ }
183
+ ]
153
184
  },
154
- "description": "Set of collections."
185
+ "description": "Set of collections. The list can also contain dividers, which are used to group collections in the collection list.",
186
+ "markdownDescription": "Set of collections. The list can also contain dividers, which are used to group collections in the collection list."
155
187
  },
156
188
  "singletons": {
157
189
  "type": "array",
158
190
  "items": {
159
- "$ref": "#/definitions/CollectionFile"
191
+ "anyOf": [
192
+ {
193
+ "$ref": "#/definitions/CollectionFile"
194
+ },
195
+ {
196
+ "$ref": "#/definitions/CollectionDivider"
197
+ }
198
+ ]
160
199
  },
161
- "description": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list."
200
+ "description": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list. The list can also contain dividers. See our [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details.",
201
+ "markdownDescription": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list. The list can also contain dividers. See our [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details."
162
202
  },
163
203
  "i18n": {
164
204
  "$ref": "#/definitions/I18nOptions",
165
- "description": "Global i18n options."
205
+ "description": "Global i18n options.",
206
+ "markdownDescription": "Global i18n options."
166
207
  },
167
208
  "editor": {
168
209
  "$ref": "#/definitions/EditorOptions",
169
- "description": "Editor view options."
210
+ "description": "Editor view options.",
211
+ "markdownDescription": "Editor view options."
170
212
  },
171
213
  "output": {
172
214
  "$ref": "#/definitions/OutputOptions",
173
- "description": "Data output options."
215
+ "description": "Data output options. See our [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details.",
216
+ "markdownDescription": "Data output options. See our [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details."
174
217
  }
175
218
  },
176
219
  "required": [
@@ -179,42 +222,51 @@
179
222
  "collections"
180
223
  ],
181
224
  "additionalProperties": false,
182
- "description": "Site configuration."
225
+ "description": "Site configuration.",
226
+ "markdownDescription": "Site configuration."
183
227
  },
184
228
  "BackendOptions": {
185
229
  "type": "object",
186
230
  "properties": {
187
231
  "name": {
188
232
  "$ref": "#/definitions/BackendName",
189
- "description": "Backend name."
233
+ "description": "Backend name.",
234
+ "markdownDescription": "Backend name."
190
235
  },
191
236
  "repo": {
192
237
  "type": "string",
193
- "description": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`."
238
+ "description": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`.",
239
+ "markdownDescription": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`."
194
240
  },
195
241
  "branch": {
196
242
  "type": "string",
197
- "description": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only."
243
+ "description": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only.",
244
+ "markdownDescription": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only."
198
245
  },
199
246
  "api_root": {
200
247
  "type": "string",
201
- "description": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea)."
248
+ "description": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea).",
249
+ "markdownDescription": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea)."
202
250
  },
203
251
  "graphql_api_root": {
204
252
  "type": "string",
205
- "description": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value."
253
+ "description": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value.",
254
+ "markdownDescription": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value."
206
255
  },
207
256
  "site_domain": {
208
257
  "type": "string",
209
- "description": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: `location.hostname`."
258
+ "description": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname).",
259
+ "markdownDescription": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname)."
210
260
  },
211
261
  "base_url": {
212
262
  "type": "string",
213
- "description": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including Sveltia CMS Authenticator. Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea)."
263
+ "description": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea).",
264
+ "markdownDescription": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea)."
214
265
  },
215
266
  "auth_endpoint": {
216
267
  "type": "string",
217
- "description": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab)."
268
+ "description": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab).",
269
+ "markdownDescription": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab)."
218
270
  },
219
271
  "auth_type": {
220
272
  "type": "string",
@@ -222,31 +274,38 @@
222
274
  "pkce",
223
275
  "implicit"
224
276
  ],
225
- "description": "OAuth authentication method. GitLab only. Default: `pkce`."
277
+ "description": "OAuth authentication method. GitLab only. Default: `pkce`.",
278
+ "markdownDescription": "OAuth authentication method. GitLab only. Default: `pkce`."
226
279
  },
227
280
  "app_id": {
228
281
  "type": "string",
229
- "description": "OAuth application ID. GitLab and Gitea only. Required for Gitea."
282
+ "description": "OAuth application ID. GitLab and Gitea only. Required for Gitea.",
283
+ "markdownDescription": "OAuth application ID. GitLab and Gitea only. Required for Gitea."
230
284
  },
231
285
  "commit_messages": {
232
286
  "$ref": "#/definitions/CommitMessages",
233
- "description": "Custom commit messages. Git backends only."
287
+ "description": "Custom commit messages. Git backends only.",
288
+ "markdownDescription": "Custom commit messages. Git backends only."
234
289
  },
235
290
  "preview_context": {
236
291
  "type": "string",
237
- "description": "Deploy preview link context. GitHub only."
292
+ "description": "Deploy preview link context. GitHub only.",
293
+ "markdownDescription": "Deploy preview link context. GitHub only."
238
294
  },
239
295
  "cms_label_prefix": {
240
296
  "type": "string",
241
- "description": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`."
297
+ "description": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`.",
298
+ "markdownDescription": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`."
242
299
  },
243
300
  "squash_merges": {
244
301
  "type": "boolean",
245
- "description": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`."
302
+ "description": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`.",
303
+ "markdownDescription": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`."
246
304
  },
247
305
  "open_authoring": {
248
306
  "type": "boolean",
249
- "description": "Whether to use Open Authoring. Git backends only. Default: `false`."
307
+ "description": "Whether to use Open Authoring. Git backends only. Default: `false`.",
308
+ "markdownDescription": "Whether to use Open Authoring. Git backends only. Default: `false`."
250
309
  },
251
310
  "auth_scope": {
252
311
  "type": "string",
@@ -254,18 +313,21 @@
254
313
  "repo",
255
314
  "public_repo"
256
315
  ],
257
- "description": "Authentication scope for Open Authoring. Git backends only."
316
+ "description": "Authentication scope for Open Authoring. Git backends only.",
317
+ "markdownDescription": "Authentication scope for Open Authoring. Git backends only."
258
318
  },
259
319
  "automatic_deployments": {
260
320
  "type": "boolean",
261
- "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: undefined. See https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details."
321
+ "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.",
322
+ "markdownDescription": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details."
262
323
  }
263
324
  },
264
325
  "required": [
265
326
  "name"
266
327
  ],
267
328
  "additionalProperties": false,
268
- "description": "Backend options."
329
+ "description": "Backend options.",
330
+ "markdownDescription": "Backend options."
269
331
  },
270
332
  "BackendName": {
271
333
  "anyOf": [
@@ -277,7 +339,8 @@
277
339
  "const": "test-repo"
278
340
  }
279
341
  ],
280
- "description": "Supported backend name."
342
+ "description": "Supported backend name.",
343
+ "markdownDescription": "Supported backend name."
281
344
  },
282
345
  "GitBackendName": {
283
346
  "type": "string",
@@ -286,38 +349,46 @@
286
349
  "gitlab",
287
350
  "gitea"
288
351
  ],
289
- "description": "Supported Git backend name."
352
+ "description": "Supported Git backend name.",
353
+ "markdownDescription": "Supported Git backend name."
290
354
  },
291
355
  "CommitMessages": {
292
356
  "type": "object",
293
357
  "properties": {
294
358
  "create": {
295
359
  "type": "string",
296
- "description": "Message to be used when a new entry is created."
360
+ "description": "Message to be used when a new entry is created.",
361
+ "markdownDescription": "Message to be used when a new entry is created."
297
362
  },
298
363
  "update": {
299
364
  "type": "string",
300
- "description": "Message to be used when existing entries are updated."
365
+ "description": "Message to be used when existing entries are updated.",
366
+ "markdownDescription": "Message to be used when existing entries are updated."
301
367
  },
302
368
  "delete": {
303
369
  "type": "string",
304
- "description": "Message to be used when existing entries are deleted."
370
+ "description": "Message to be used when existing entries are deleted.",
371
+ "markdownDescription": "Message to be used when existing entries are deleted."
305
372
  },
306
373
  "uploadMedia": {
307
374
  "type": "string",
308
- "description": "Message to be used when new files are uploaded/updated."
375
+ "description": "Message to be used when new files are uploaded/updated.",
376
+ "markdownDescription": "Message to be used when new files are uploaded/updated."
309
377
  },
310
378
  "deleteMedia": {
311
379
  "type": "string",
312
- "description": "Message to be used when existing files are deleted."
380
+ "description": "Message to be used when existing files are deleted.",
381
+ "markdownDescription": "Message to be used when existing files are deleted."
313
382
  },
314
383
  "openAuthoring": {
315
384
  "type": "string",
316
- "description": "Message to be used when committed via a forked repository."
385
+ "description": "Message to be used when committed via a forked repository.",
386
+ "markdownDescription": "Message to be used when committed via a forked repository."
317
387
  }
318
388
  },
319
389
  "additionalProperties": false,
320
- "description": "Custom commit messages."
390
+ "description": "Custom commit messages.",
391
+ "markdownDescription": "Custom commit messages."
321
392
  },
322
393
  "MediaLibraryName": {
323
394
  "type": "string",
@@ -327,30 +398,36 @@
327
398
  "uploadcare",
328
399
  "stock_assets"
329
400
  ],
330
- "description": "Supported media library name."
401
+ "description": "Supported media library name.",
402
+ "markdownDescription": "Supported media library name."
331
403
  },
332
404
  "DefaultMediaLibraryConfig": {
333
405
  "type": "object",
334
406
  "properties": {
335
407
  "max_file_size": {
336
408
  "type": "number",
337
- "description": "Maximum file size in bytes that can be accepted for uploading."
409
+ "description": "Maximum file size in bytes that can be accepted for uploading.",
410
+ "markdownDescription": "Maximum file size in bytes that can be accepted for uploading."
338
411
  },
339
412
  "slugify_filename": {
340
413
  "type": "boolean",
341
- "description": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`."
414
+ "description": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`.",
415
+ "markdownDescription": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`."
342
416
  },
343
417
  "transformations": {
344
418
  "$ref": "#/definitions/FileTransformations",
345
- "description": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format."
419
+ "description": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.",
420
+ "markdownDescription": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details."
346
421
  }
347
422
  },
348
423
  "additionalProperties": false,
349
- "description": "Configuration for the default media library."
424
+ "description": "Configuration for the default media library.",
425
+ "markdownDescription": "Configuration for the default media library."
350
426
  },
351
427
  "FileTransformations": {
352
428
  "$ref": "#/definitions/ImageTransformations",
353
- "description": "File transformation option map."
429
+ "description": "File transformation option map.",
430
+ "markdownDescription": "File transformation option map."
354
431
  },
355
432
  "ImageTransformations": {
356
433
  "type": "object",
@@ -358,88 +435,107 @@
358
435
  "properties": {
359
436
  "svg": {
360
437
  "$ref": "#/definitions/VectorImageTransformationOptions",
361
- "description": "SVG image transformation options."
438
+ "description": "SVG image transformation options.",
439
+ "markdownDescription": "SVG image transformation options."
362
440
  },
363
441
  "raster_image": {
364
442
  "$ref": "#/definitions/RasterImageTransformationOptions",
365
- "description": "Raster image transformation options that apply to any supported raster image format."
443
+ "description": "Raster image transformation options that apply to any supported raster image format.",
444
+ "markdownDescription": "Raster image transformation options that apply to any supported raster image format."
366
445
  },
367
446
  "avif": {
368
447
  "$ref": "#/definitions/RasterImageTransformationOptions",
369
- "description": "AVIF image transformation options."
448
+ "description": "AVIF image transformation options.",
449
+ "markdownDescription": "AVIF image transformation options."
370
450
  },
371
451
  "gif": {
372
452
  "$ref": "#/definitions/RasterImageTransformationOptions",
373
- "description": "GIF image transformation options."
453
+ "description": "GIF image transformation options.",
454
+ "markdownDescription": "GIF image transformation options."
374
455
  },
375
456
  "jpeg": {
376
457
  "$ref": "#/definitions/RasterImageTransformationOptions",
377
- "description": "JPEG image transformation options."
458
+ "description": "JPEG image transformation options.",
459
+ "markdownDescription": "JPEG image transformation options."
378
460
  },
379
461
  "png": {
380
462
  "$ref": "#/definitions/RasterImageTransformationOptions",
381
- "description": "PNG image transformation options."
463
+ "description": "PNG image transformation options.",
464
+ "markdownDescription": "PNG image transformation options."
382
465
  },
383
466
  "webp": {
384
467
  "$ref": "#/definitions/RasterImageTransformationOptions",
385
- "description": "WebP image transformation options."
468
+ "description": "WebP image transformation options.",
469
+ "markdownDescription": "WebP image transformation options."
386
470
  }
387
471
  },
388
- "description": "Image transformation option map."
472
+ "description": "Image transformation option map.",
473
+ "markdownDescription": "Image transformation option map."
389
474
  },
390
475
  "VectorImageTransformationOptions": {
391
476
  "type": "object",
392
477
  "properties": {
393
478
  "optimize": {
394
479
  "type": "boolean",
395
- "description": "Whether to optimize the image."
480
+ "description": "Whether to optimize the image.",
481
+ "markdownDescription": "Whether to optimize the image."
396
482
  }
397
483
  },
398
484
  "additionalProperties": false,
399
- "description": "Vector image transformation option map."
485
+ "description": "Vector image transformation option map.",
486
+ "markdownDescription": "Vector image transformation option map."
400
487
  },
401
488
  "RasterImageTransformationOptions": {
402
489
  "type": "object",
403
490
  "properties": {
404
491
  "format": {
405
492
  "$ref": "#/definitions/RasterImageConversionFormat",
406
- "description": "New format. Default: `webp`."
493
+ "description": "New format. Default: `webp`.",
494
+ "markdownDescription": "New format. Default: `webp`."
407
495
  },
408
496
  "quality": {
409
497
  "type": "number",
410
- "description": "Image quality between 0 and 100. Default: 85."
498
+ "description": "Image quality between 0 and 100. Default: `85`.",
499
+ "markdownDescription": "Image quality between 0 and 100. Default: `85`."
411
500
  },
412
501
  "width": {
413
502
  "type": "number",
414
- "description": "Max width. Default: original width."
503
+ "description": "Max width. Default: original width.",
504
+ "markdownDescription": "Max width. Default: original width."
415
505
  },
416
506
  "height": {
417
507
  "type": "number",
418
- "description": "Max height. Default: original height."
508
+ "description": "Max height. Default: original height.",
509
+ "markdownDescription": "Max height. Default: original height."
419
510
  }
420
511
  },
421
512
  "additionalProperties": false,
422
- "description": "Raster image transformation options."
513
+ "description": "Raster image transformation options. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.",
514
+ "markdownDescription": "Raster image transformation options. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details."
423
515
  },
424
516
  "RasterImageConversionFormat": {
425
517
  "type": "string",
426
518
  "const": "webp",
427
- "description": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast."
519
+ "description": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast.",
520
+ "markdownDescription": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast."
428
521
  },
429
522
  "UploadcareMediaLibrarySettings": {
430
523
  "type": "object",
431
524
  "properties": {
432
525
  "autoFilename": {
433
526
  "type": "boolean",
434
- "description": "Whether to append a file name to an output URL. Default: `false`."
527
+ "description": "Whether to append a file name to an output URL. Default: `false`.",
528
+ "markdownDescription": "Whether to append a file name to an output URL. Default: `false`."
435
529
  },
436
530
  "defaultOperations": {
437
531
  "type": "string",
438
- "description": "Transformation operations to be included in an output URL. Default: empty string."
532
+ "description": "Transformation operations to be included in an output URL. Default: empty string.",
533
+ "markdownDescription": "Transformation operations to be included in an output URL. Default: empty string."
439
534
  }
440
535
  },
441
536
  "additionalProperties": false,
442
- "description": "Settings for the Uploadcare media library."
537
+ "description": "Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).",
538
+ "markdownDescription": "Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/)."
443
539
  },
444
540
  "StockAssetProviderName": {
445
541
  "type": "string",
@@ -448,79 +544,95 @@
448
544
  "pixabay",
449
545
  "unsplash"
450
546
  ],
451
- "description": "Name of supported stock photo/video provider."
547
+ "description": "Name of supported stock photo/video provider.",
548
+ "markdownDescription": "Name of supported stock photo/video provider."
452
549
  },
453
550
  "MediaLibraries": {
454
551
  "type": "object",
455
552
  "properties": {
456
553
  "default": {
457
554
  "$ref": "#/definitions/DefaultMediaLibrary",
458
- "description": "Options for the default media library."
555
+ "description": "Options for the default media library.",
556
+ "markdownDescription": "Options for the default media library."
459
557
  },
460
558
  "cloudinary": {
461
559
  "$ref": "#/definitions/CloudinaryMediaLibrary",
462
- "description": "Options for the Cloudinary media library."
560
+ "description": "Options for the Cloudinary media library.",
561
+ "markdownDescription": "Options for the Cloudinary media library."
463
562
  },
464
563
  "uploadcare": {
465
564
  "$ref": "#/definitions/UploadcareMediaLibrary",
466
- "description": "Options for the Uploadcare media library."
565
+ "description": "Options for the Uploadcare media library.",
566
+ "markdownDescription": "Options for the Uploadcare media library."
467
567
  },
468
568
  "stock_assets": {
469
569
  "$ref": "#/definitions/StockAssetMediaLibrary",
470
- "description": "Options for the unified stock photo/video media library."
570
+ "description": "Options for the unified stock photo/video media library.",
571
+ "markdownDescription": "Options for the unified stock photo/video media library."
471
572
  }
472
573
  },
473
574
  "additionalProperties": false,
474
- "description": "Unified media library option that supports multiple libraries."
575
+ "description": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details.",
576
+ "markdownDescription": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details."
475
577
  },
476
578
  "DefaultMediaLibrary": {
477
579
  "type": "object",
478
580
  "properties": {
479
581
  "config": {
480
582
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
481
- "description": "Configuration for the default media library."
583
+ "description": "Configuration for the default media library.",
584
+ "markdownDescription": "Configuration for the default media library."
482
585
  }
483
586
  },
484
587
  "additionalProperties": false,
485
- "description": "Options for the default media library."
588
+ "description": "Options for the default media library.",
589
+ "markdownDescription": "Options for the default media library."
486
590
  },
487
591
  "CloudinaryMediaLibrary": {
488
592
  "type": "object",
489
593
  "properties": {
490
594
  "output_filename_only": {
491
595
  "type": "boolean",
492
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
596
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
597
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
493
598
  },
494
599
  "use_transformations": {
495
600
  "type": "boolean",
496
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
601
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
602
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
497
603
  },
498
604
  "use_secure_url": {
499
605
  "type": "boolean",
500
- "description": "Whether to use an HTTP URL. Default: `true`."
606
+ "description": "Whether to use an HTTP URL. Default: `true`.",
607
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
501
608
  },
502
609
  "config": {
503
610
  "type": "object",
504
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
611
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
612
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
505
613
  }
506
614
  },
507
615
  "additionalProperties": false,
508
- "description": "Options for the Cloudinary media library."
616
+ "description": "Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/).",
617
+ "markdownDescription": "Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/)."
509
618
  },
510
619
  "UploadcareMediaLibrary": {
511
620
  "type": "object",
512
621
  "properties": {
513
622
  "config": {
514
623
  "type": "object",
515
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
624
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
625
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
516
626
  },
517
627
  "settings": {
518
628
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
519
- "description": "Integration settings."
629
+ "description": "Integration settings.",
630
+ "markdownDescription": "Integration settings."
520
631
  }
521
632
  },
522
633
  "additionalProperties": false,
523
- "description": "Options for the Uploadcare media library."
634
+ "description": "Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).",
635
+ "markdownDescription": "Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/)."
524
636
  },
525
637
  "StockAssetMediaLibrary": {
526
638
  "type": "object",
@@ -530,11 +642,13 @@
530
642
  "items": {
531
643
  "$ref": "#/definitions/StockAssetProviderName"
532
644
  },
533
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
645
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
646
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
534
647
  }
535
648
  },
536
649
  "additionalProperties": false,
537
- "description": "Options for the unified stock photo/video media library."
650
+ "description": "Options for the unified stock photo/video media library.",
651
+ "markdownDescription": "Options for the unified stock photo/video media library."
538
652
  },
539
653
  "SlugOptions": {
540
654
  "type": "object",
@@ -545,104 +659,127 @@
545
659
  "unicode",
546
660
  "ascii"
547
661
  ],
548
- "description": "Encoding option. Default: `unicode`."
662
+ "description": "Encoding option. Default: `unicode`.",
663
+ "markdownDescription": "Encoding option. Default: `unicode`."
549
664
  },
550
665
  "clean_accents": {
551
666
  "type": "boolean",
552
- "description": "Whether to remove accents. Default: `false`."
667
+ "description": "Whether to remove accents. Default: `false`.",
668
+ "markdownDescription": "Whether to remove accents. Default: `false`."
553
669
  },
554
670
  "sanitize_replacement": {
555
671
  "type": "string",
556
- "description": "String to replace sanitized characters. Default: `-`."
672
+ "description": "String to replace sanitized characters. Default: `-`.",
673
+ "markdownDescription": "String to replace sanitized characters. Default: `-`."
557
674
  }
558
675
  },
559
676
  "additionalProperties": false,
560
- "description": "Entry slug options."
677
+ "description": "Entry slug options.",
678
+ "markdownDescription": "Entry slug options."
561
679
  },
562
680
  "Collection": {
563
681
  "type": "object",
564
682
  "properties": {
565
683
  "name": {
566
684
  "type": "string",
567
- "description": "Unique identifier for the collection."
685
+ "description": "Unique identifier for the collection.",
686
+ "markdownDescription": "Unique identifier for the collection."
568
687
  },
569
688
  "label": {
570
689
  "type": "string",
571
- "description": "Label of the field to be displayed in the editor UI. Default: `name` option value."
690
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` option value.",
691
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` option value."
572
692
  },
573
693
  "label_singular": {
574
694
  "type": "string",
575
- "description": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value."
695
+ "description": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value.",
696
+ "markdownDescription": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value."
576
697
  },
577
698
  "description": {
578
699
  "type": "string",
579
- "description": "Short description of the collection to be displayed in the editor UI."
700
+ "description": "Short description of the collection to be displayed in the editor UI.",
701
+ "markdownDescription": "Short description of the collection to be displayed in the editor UI."
580
702
  },
581
703
  "icon": {
582
704
  "type": "string",
583
- "description": "Name of a Material Symbols icon to be displayed in the collection list."
705
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection list.",
706
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection list."
584
707
  },
585
708
  "identifier_field": {
586
709
  "$ref": "#/definitions/FieldKeyPath",
587
- "description": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`."
710
+ "description": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`.",
711
+ "markdownDescription": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`."
588
712
  },
589
713
  "files": {
590
714
  "type": "array",
591
715
  "items": {
592
716
  "$ref": "#/definitions/CollectionFile"
593
717
  },
594
- "description": "A set of files. File collection only."
718
+ "description": "A set of files. File collection only.",
719
+ "markdownDescription": "A set of files. File collection only."
595
720
  },
596
721
  "folder": {
597
722
  "type": "string",
598
- "description": "Base folder path relative to the project root. Entry collection only."
723
+ "description": "Base folder path relative to the project root. Entry collection only.",
724
+ "markdownDescription": "Base folder path relative to the project root. Entry collection only."
599
725
  },
600
726
  "fields": {
601
727
  "type": "array",
602
728
  "items": {
603
729
  "$ref": "#/definitions/Field"
604
730
  },
605
- "description": "Set of fields to be included in entries. Entry collection only."
731
+ "description": "Set of fields to be included in entries. Entry collection only.",
732
+ "markdownDescription": "Set of fields to be included in entries. Entry collection only."
606
733
  },
607
734
  "path": {
608
735
  "type": "string",
609
- "description": "File path relative to `folder`, without a file extension. Entry collection only."
736
+ "description": "File path relative to `folder`, without a file extension. Entry collection only.",
737
+ "markdownDescription": "File path relative to `folder`, without a file extension. Entry collection only."
610
738
  },
611
739
  "media_folder": {
612
740
  "type": "string",
613
- "description": "Internal media folder path for the collection. This overrides the global `media_folder` option."
741
+ "description": "Internal media folder path for the collection. This overrides the global `media_folder` option. It can be a relative path from the project root if it starts with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global `media_folder` option value is used. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for details.",
742
+ "markdownDescription": "Internal media folder path for the collection. This overrides the global `media_folder` option. It can be a relative path from the project root if it starts with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global `media_folder` option value is used. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for details."
614
743
  },
615
744
  "public_folder": {
616
745
  "type": "string",
617
- "description": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value."
746
+ "description": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value.",
747
+ "markdownDescription": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value."
618
748
  },
619
749
  "filter": {
620
750
  "$ref": "#/definitions/CollectionFilter",
621
- "description": "Entry filter. Entry collection only."
751
+ "description": "Entry filter. Entry collection only.",
752
+ "markdownDescription": "Entry filter. Entry collection only."
622
753
  },
623
754
  "hide": {
624
755
  "type": "boolean",
625
- "description": "Whether to hide the collection in the UI. Default: `false`."
756
+ "description": "Whether to hide the collection in the UI. Default: `false`.",
757
+ "markdownDescription": "Whether to hide the collection in the UI. Default: `false`."
626
758
  },
627
759
  "create": {
628
760
  "type": "boolean",
629
- "description": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`."
761
+ "description": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`.",
762
+ "markdownDescription": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`."
630
763
  },
631
764
  "delete": {
632
765
  "type": "boolean",
633
- "description": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`."
766
+ "description": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`.",
767
+ "markdownDescription": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`."
634
768
  },
635
769
  "publish": {
636
770
  "type": "boolean",
637
- "description": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`."
771
+ "description": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`.",
772
+ "markdownDescription": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`."
638
773
  },
639
774
  "extension": {
640
775
  "$ref": "#/definitions/FileExtension",
641
- "description": "File extension. Entry collection only. Default: `md`."
776
+ "description": "File extension. Entry collection only. Default: `md`.",
777
+ "markdownDescription": "File extension. Entry collection only. Default: `md`."
642
778
  },
643
779
  "format": {
644
780
  "$ref": "#/definitions/FileFormat",
645
- "description": "File format. It should match the file extension. Default: `yaml-frontmatter`."
781
+ "description": "File format. It should match the file extension. Default: `yaml-frontmatter`.",
782
+ "markdownDescription": "File format. It should match the file extension. Default: `yaml-frontmatter`."
646
783
  },
647
784
  "frontmatter_delimiter": {
648
785
  "anyOf": [
@@ -656,19 +793,23 @@
656
793
  }
657
794
  }
658
795
  ],
659
- "description": "Delimiters to be used for the front matter format. Default: depends on the front matter type."
796
+ "description": "Delimiters to be used for the front matter format. Default: depends on the front matter type.",
797
+ "markdownDescription": "Delimiters to be used for the front matter format. Default: depends on the front matter type."
660
798
  },
661
799
  "slug": {
662
800
  "type": "string",
663
- "description": "Item slug template. Entry collection only. Default: `identifier_field` option value."
801
+ "description": "Item slug template. Entry collection only. Default: `identifier_field` option value. It’s possible to [localize the slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or [use a random ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug).",
802
+ "markdownDescription": "Item slug template. Entry collection only. Default: `identifier_field` option value. It’s possible to [localize the slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or [use a random ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug)."
664
803
  },
665
804
  "slug_length": {
666
805
  "type": "number",
667
- "description": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: infinity."
806
+ "description": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: `Infinity`.",
807
+ "markdownDescription": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: `Infinity`."
668
808
  },
669
809
  "summary": {
670
810
  "type": "string",
671
- "description": "Entry summary template. Entry collection only. Default: `identifier_field`."
811
+ "description": "Entry summary template. Entry collection only. Default: `identifier_field`.",
812
+ "markdownDescription": "Entry summary template. Entry collection only. Default: `identifier_field`."
672
813
  },
673
814
  "sortable_fields": {
674
815
  "anyOf": [
@@ -682,21 +823,24 @@
682
823
  "$ref": "#/definitions/SortableFields"
683
824
  }
684
825
  ],
685
- "description": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default."
826
+ "description": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details.",
827
+ "markdownDescription": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details."
686
828
  },
687
829
  "view_filters": {
688
830
  "type": "array",
689
831
  "items": {
690
832
  "$ref": "#/definitions/ViewFilter"
691
833
  },
692
- "description": "View filters to be used in the entry list. Entry collection only."
834
+ "description": "View filters to be used in the entry list. Entry collection only.",
835
+ "markdownDescription": "View filters to be used in the entry list. Entry collection only."
693
836
  },
694
837
  "view_groups": {
695
838
  "type": "array",
696
839
  "items": {
697
840
  "$ref": "#/definitions/ViewGroup"
698
841
  },
699
- "description": "View groups to be used in the entry list. Entry collection only."
842
+ "description": "View groups to be used in the entry list. Entry collection only.",
843
+ "markdownDescription": "View groups to be used in the entry list. Entry collection only."
700
844
  },
701
845
  "i18n": {
702
846
  "anyOf": [
@@ -707,27 +851,33 @@
707
851
  "type": "boolean"
708
852
  }
709
853
  ],
710
- "description": "I18n options. Default: `false`."
854
+ "description": "I18n options. Default: `false`.",
855
+ "markdownDescription": "I18n options. Default: `false`."
711
856
  },
712
857
  "preview_path": {
713
858
  "type": "string",
714
- "description": "Preview URL path template."
859
+ "description": "Preview URL path template.",
860
+ "markdownDescription": "Preview URL path template."
715
861
  },
716
862
  "preview_path_date_field": {
717
863
  "type": "string",
718
- "description": "Date field name used for `preview_path`."
864
+ "description": "Date field name used for `preview_path`.",
865
+ "markdownDescription": "Date field name used for `preview_path`."
719
866
  },
720
867
  "editor": {
721
868
  "$ref": "#/definitions/EditorOptions",
722
- "description": "Editor view options."
869
+ "description": "Editor view options.",
870
+ "markdownDescription": "Editor view options."
723
871
  },
724
872
  "nested": {
725
873
  "$ref": "#/definitions/NestedCollectionOptions",
726
- "description": "Options for a nested collection. Entry collection only."
874
+ "description": "Options for a nested collection. Entry collection only.",
875
+ "markdownDescription": "Options for a nested collection. Entry collection only."
727
876
  },
728
877
  "meta": {
729
878
  "$ref": "#/definitions/CollectionMetaData",
730
- "description": "Meta data for a nested collection. Entry collection only."
879
+ "description": "Meta data for a nested collection. Entry collection only.",
880
+ "markdownDescription": "Meta data for a nested collection. Entry collection only."
731
881
  },
732
882
  "index_file": {
733
883
  "anyOf": [
@@ -738,15 +888,13 @@
738
888
  "type": "boolean"
739
889
  }
740
890
  ],
741
- "description": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file."
891
+ "description": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details.",
892
+ "markdownDescription": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details."
742
893
  },
743
894
  "yaml_quote": {
744
895
  "type": "boolean",
745
- "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options."
746
- },
747
- "divider": {
748
- "type": "boolean",
749
- "description": "A special option to make this collection a divider UI in the collection list. Default: `false`. If `true`, other options will be ignored, but you still have to provide a unique `name`."
896
+ "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options.",
897
+ "markdownDescription": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options."
750
898
  },
751
899
  "thumbnail": {
752
900
  "anyOf": [
@@ -760,60 +908,72 @@
760
908
  }
761
909
  }
762
910
  ],
763
- "description": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only."
911
+ "description": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only.",
912
+ "markdownDescription": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only."
764
913
  },
765
914
  "limit": {
766
915
  "type": "number",
767
- "description": "The maximum number of entries that can be created in the collection. Entry collection only. Default: infinity."
916
+ "description": "The maximum number of entries that can be created in the collection. Entry collection only. Default: `Infinity`.",
917
+ "markdownDescription": "The maximum number of entries that can be created in the collection. Entry collection only. Default: `Infinity`."
768
918
  }
769
919
  },
770
920
  "required": [
771
921
  "name"
772
922
  ],
773
923
  "additionalProperties": false,
774
- "description": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection."
924
+ "description": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection.",
925
+ "markdownDescription": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection."
775
926
  },
776
927
  "FieldKeyPath": {
777
928
  "type": "string",
778
- "description": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the IndexedDB API terminology, and use it everywhere, as entry data is managed as a flatten object for easier access."
929
+ "description": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the [IndexedDB API terminology](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path), and use it everywhere, as entry data is managed as a [flatten object](https://www.npmjs.com/package/flat) for easier access.",
930
+ "markdownDescription": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the [IndexedDB API terminology](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path), and use it everywhere, as entry data is managed as a [flatten object](https://www.npmjs.com/package/flat) for easier access."
779
931
  },
780
932
  "CollectionFile": {
781
933
  "type": "object",
782
934
  "properties": {
783
935
  "name": {
784
936
  "type": "string",
785
- "description": "Unique identifier for the file."
937
+ "description": "Unique identifier for the file.",
938
+ "markdownDescription": "Unique identifier for the file."
786
939
  },
787
940
  "label": {
788
941
  "type": "string",
789
- "description": "Label to be displayed in the editor UI. Default: `name` option value."
942
+ "description": "Label to be displayed in the editor UI. Default: `name` option value.",
943
+ "markdownDescription": "Label to be displayed in the editor UI. Default: `name` option value."
790
944
  },
791
945
  "icon": {
792
946
  "type": "string",
793
- "description": "Name of a Material Symbols icon to be displayed in the collection file list and other places."
947
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection file list and other places. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for details.",
948
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection file list and other places. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for details."
794
949
  },
795
950
  "file": {
796
951
  "type": "string",
797
- "description": "File path relative to the project root."
952
+ "description": "File path relative to the project root.",
953
+ "markdownDescription": "File path relative to the project root."
798
954
  },
799
955
  "fields": {
800
956
  "type": "array",
801
957
  "items": {
802
958
  "$ref": "#/definitions/Field"
803
959
  },
804
- "description": "Set of fields to be included in the file."
960
+ "description": "Set of fields to be included in the file.",
961
+ "markdownDescription": "Set of fields to be included in the file."
805
962
  },
806
963
  "media_folder": {
807
964
  "type": "string",
808
- "description": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option."
965
+ "description": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option.",
966
+ "markdownDescription": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option."
809
967
  },
810
968
  "public_folder": {
811
969
  "type": "string",
812
- "description": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value."
970
+ "description": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value.",
971
+ "markdownDescription": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value."
813
972
  },
814
973
  "format": {
815
974
  "$ref": "#/definitions/FileFormat",
816
- "description": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`."
975
+ "description": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`.",
976
+ "markdownDescription": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`."
817
977
  },
818
978
  "frontmatter_delimiter": {
819
979
  "anyOf": [
@@ -827,7 +987,8 @@
827
987
  }
828
988
  }
829
989
  ],
830
- "description": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type."
990
+ "description": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type.",
991
+ "markdownDescription": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type."
831
992
  },
832
993
  "i18n": {
833
994
  "anyOf": [
@@ -838,19 +999,18 @@
838
999
  "type": "boolean"
839
1000
  }
840
1001
  ],
841
- "description": "I18n options. Default: `false`."
842
- },
843
- "divider": {
844
- "type": "boolean",
845
- "description": "A special option to make this file a divider UI in the singleton file list. Default: `false`. Not supported in a file collection. If `true`, other options will be ignored, but you still have to provide a unique `name`."
1002
+ "description": "I18n options. Default: `false`.",
1003
+ "markdownDescription": "I18n options. Default: `false`."
846
1004
  },
847
1005
  "preview_path": {
848
1006
  "type": "string",
849
- "description": "Preview URL path template."
1007
+ "description": "Preview URL path template.",
1008
+ "markdownDescription": "Preview URL path template."
850
1009
  },
851
1010
  "preview_path_date_field": {
852
1011
  "$ref": "#/definitions/FieldKeyPath",
853
- "description": "Date field name used for `preview_path`."
1012
+ "description": "Date field name used for `preview_path`.",
1013
+ "markdownDescription": "Date field name used for `preview_path`."
854
1014
  }
855
1015
  },
856
1016
  "required": [
@@ -859,7 +1019,8 @@
859
1019
  "fields"
860
1020
  ],
861
1021
  "additionalProperties": false,
862
- "description": "Single file in a file/singleton collection."
1022
+ "description": "Single file in a file/singleton collection.",
1023
+ "markdownDescription": "Single file in a file/singleton collection."
863
1024
  },
864
1025
  "Field": {
865
1026
  "anyOf": [
@@ -870,7 +1031,8 @@
870
1031
  "$ref": "#/definitions/CustomField"
871
1032
  }
872
1033
  ],
873
- "description": "Entry field."
1034
+ "description": "Entry field.",
1035
+ "markdownDescription": "Entry field."
874
1036
  },
875
1037
  "StandardField": {
876
1038
  "anyOf": [
@@ -932,40 +1094,32 @@
932
1094
  "$ref": "#/definitions/UuidField"
933
1095
  }
934
1096
  ],
935
- "description": "Entry field using a built-in widget."
1097
+ "description": "Entry field using a built-in widget.",
1098
+ "markdownDescription": "Entry field using a built-in widget."
936
1099
  },
937
1100
  "BooleanField": {
938
1101
  "type": "object",
939
- "additionalProperties": false,
940
1102
  "properties": {
941
1103
  "before_input": {
942
1104
  "type": "string",
943
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
1105
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
1106
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
944
1107
  },
945
1108
  "after_input": {
946
1109
  "type": "string",
947
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
1110
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
1111
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
948
1112
  },
949
1113
  "widget": {
950
1114
  "type": "string",
951
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
952
- "const": "boolean"
1115
+ "const": "boolean",
1116
+ "description": "Widget name.",
1117
+ "markdownDescription": "Widget name."
953
1118
  },
954
1119
  "default": {
955
1120
  "type": "boolean",
956
- "description": "Default value. Accepts `true` or `false`."
957
- },
958
- "name": {
959
- "type": "string",
960
- "description": "Unique identifier for the field. It cannot include periods and spaces."
961
- },
962
- "label": {
963
- "type": "string",
964
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
965
- },
966
- "comment": {
967
- "type": "string",
968
- "description": "Short description of the field to be displayed in the editor UI."
1121
+ "description": "Default value. Accepts `true` or `false`.",
1122
+ "markdownDescription": "Default value. Accepts `true` or `false`."
969
1123
  },
970
1124
  "required": {
971
1125
  "anyOf": [
@@ -979,11 +1133,13 @@
979
1133
  }
980
1134
  }
981
1135
  ],
982
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1136
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1137
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
983
1138
  },
984
1139
  "readonly": {
985
1140
  "type": "boolean",
986
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1141
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1142
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
987
1143
  },
988
1144
  "pattern": {
989
1145
  "type": "array",
@@ -1005,15 +1161,33 @@
1005
1161
  }
1006
1162
  ],
1007
1163
  "maxItems": 2,
1008
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1164
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1165
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1166
+ },
1167
+ "name": {
1168
+ "type": "string",
1169
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1170
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1171
+ },
1172
+ "label": {
1173
+ "type": "string",
1174
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1175
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1176
+ },
1177
+ "comment": {
1178
+ "type": "string",
1179
+ "description": "Short description of the field to be displayed in the editor UI.",
1180
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1009
1181
  },
1010
1182
  "hint": {
1011
1183
  "type": "string",
1012
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1184
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1185
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1013
1186
  },
1014
1187
  "preview": {
1015
1188
  "type": "boolean",
1016
- "description": "Whether to show the preview of the field. Default: `true`."
1189
+ "description": "Whether to show the preview of the field. Default: `true`.",
1190
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1017
1191
  },
1018
1192
  "i18n": {
1019
1193
  "anyOf": [
@@ -1033,27 +1207,30 @@
1033
1207
  "const": "none"
1034
1208
  }
1035
1209
  ],
1036
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1210
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1211
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1037
1212
  }
1038
1213
  },
1039
1214
  "required": [
1040
1215
  "name",
1041
1216
  "widget"
1042
1217
  ],
1043
- "description": "Boolean field definition."
1218
+ "description": "Boolean field definition.",
1219
+ "markdownDescription": "Boolean field definition."
1044
1220
  },
1045
1221
  "LocaleCode": {
1046
1222
  "type": "string",
1047
- "description": "Standard IETF locale tag like `en` or `en-US`."
1223
+ "description": "Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_tag) like `en` or `en-US`.",
1224
+ "markdownDescription": "Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_tag) like `en` or `en-US`."
1048
1225
  },
1049
1226
  "CodeField": {
1050
1227
  "type": "object",
1051
- "additionalProperties": false,
1052
1228
  "properties": {
1053
1229
  "widget": {
1054
1230
  "type": "string",
1055
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1056
- "const": "code"
1231
+ "const": "code",
1232
+ "description": "Widget name.",
1233
+ "markdownDescription": "Widget name."
1057
1234
  },
1058
1235
  "default": {
1059
1236
  "anyOf": [
@@ -1067,19 +1244,23 @@
1067
1244
  }
1068
1245
  }
1069
1246
  ],
1070
- "description": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option."
1247
+ "description": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option.",
1248
+ "markdownDescription": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option."
1071
1249
  },
1072
1250
  "default_language": {
1073
1251
  "type": "string",
1074
- "description": "Default language to be selected, like `js`. See https://prismjs.com/#supported-languages for a list of supported languages. Default: empty string, which is plaintext."
1252
+ "description": "Default language to be selected, like `js`. See the [Prism documentation](https://prismjs.com/#supported-languages) for a list of supported languages. Default: empty string, which is plaintext.",
1253
+ "markdownDescription": "Default language to be selected, like `js`. See the [Prism documentation](https://prismjs.com/#supported-languages) for a list of supported languages. Default: empty string, which is plaintext."
1075
1254
  },
1076
1255
  "allow_language_selection": {
1077
1256
  "type": "boolean",
1078
- "description": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong)."
1257
+ "description": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong).",
1258
+ "markdownDescription": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong)."
1079
1259
  },
1080
1260
  "output_code_only": {
1081
1261
  "type": "boolean",
1082
- "description": "Whether to output code snippet only. Default: `false`."
1262
+ "description": "Whether to output code snippet only. Default: `false`.",
1263
+ "markdownDescription": "Whether to output code snippet only. Default: `false`."
1083
1264
  },
1084
1265
  "keys": {
1085
1266
  "type": "object",
@@ -1096,19 +1277,8 @@
1096
1277
  "lang"
1097
1278
  ],
1098
1279
  "additionalProperties": false,
1099
- "description": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`."
1100
- },
1101
- "name": {
1102
- "type": "string",
1103
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1104
- },
1105
- "label": {
1106
- "type": "string",
1107
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1108
- },
1109
- "comment": {
1110
- "type": "string",
1111
- "description": "Short description of the field to be displayed in the editor UI."
1280
+ "description": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`.",
1281
+ "markdownDescription": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`."
1112
1282
  },
1113
1283
  "required": {
1114
1284
  "anyOf": [
@@ -1122,11 +1292,13 @@
1122
1292
  }
1123
1293
  }
1124
1294
  ],
1125
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1295
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1296
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1126
1297
  },
1127
1298
  "readonly": {
1128
1299
  "type": "boolean",
1129
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1300
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1301
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1130
1302
  },
1131
1303
  "pattern": {
1132
1304
  "type": "array",
@@ -1148,15 +1320,33 @@
1148
1320
  }
1149
1321
  ],
1150
1322
  "maxItems": 2,
1151
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1323
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1324
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1325
+ },
1326
+ "name": {
1327
+ "type": "string",
1328
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1329
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1330
+ },
1331
+ "label": {
1332
+ "type": "string",
1333
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1334
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1335
+ },
1336
+ "comment": {
1337
+ "type": "string",
1338
+ "description": "Short description of the field to be displayed in the editor UI.",
1339
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1152
1340
  },
1153
1341
  "hint": {
1154
1342
  "type": "string",
1155
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1343
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1344
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1156
1345
  },
1157
1346
  "preview": {
1158
1347
  "type": "boolean",
1159
- "description": "Whether to show the preview of the field. Default: `true`."
1348
+ "description": "Whether to show the preview of the field. Default: `true`.",
1349
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1160
1350
  },
1161
1351
  "i18n": {
1162
1352
  "anyOf": [
@@ -1176,47 +1366,40 @@
1176
1366
  "const": "none"
1177
1367
  }
1178
1368
  ],
1179
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1369
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1370
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1180
1371
  }
1181
1372
  },
1182
1373
  "required": [
1183
1374
  "name",
1184
1375
  "widget"
1185
1376
  ],
1186
- "description": "Code field definition."
1377
+ "description": "Code field definition.",
1378
+ "markdownDescription": "Code field definition."
1187
1379
  },
1188
1380
  "ColorField": {
1189
1381
  "type": "object",
1190
- "additionalProperties": false,
1191
1382
  "properties": {
1192
1383
  "widget": {
1193
1384
  "type": "string",
1194
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1195
- "const": "color"
1385
+ "const": "color",
1386
+ "description": "Widget name.",
1387
+ "markdownDescription": "Widget name."
1196
1388
  },
1197
1389
  "default": {
1198
1390
  "type": "string",
1199
- "description": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax."
1391
+ "description": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax.",
1392
+ "markdownDescription": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax."
1200
1393
  },
1201
1394
  "allowInput": {
1202
1395
  "type": "boolean",
1203
- "description": "Whether to show a textbox that allows users to manually edit the value. Default: `false`."
1396
+ "description": "Whether to show a textbox that allows users to manually edit the value. Default: `false`.",
1397
+ "markdownDescription": "Whether to show a textbox that allows users to manually edit the value. Default: `false`."
1204
1398
  },
1205
1399
  "enableAlpha": {
1206
1400
  "type": "boolean",
1207
- "description": "Whether to edit/save the alpha channel value. Default: `false`."
1208
- },
1209
- "name": {
1210
- "type": "string",
1211
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1212
- },
1213
- "label": {
1214
- "type": "string",
1215
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1216
- },
1217
- "comment": {
1218
- "type": "string",
1219
- "description": "Short description of the field to be displayed in the editor UI."
1401
+ "description": "Whether to edit/save the alpha channel value. Default: `false`.",
1402
+ "markdownDescription": "Whether to edit/save the alpha channel value. Default: `false`."
1220
1403
  },
1221
1404
  "required": {
1222
1405
  "anyOf": [
@@ -1230,11 +1413,13 @@
1230
1413
  }
1231
1414
  }
1232
1415
  ],
1233
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1416
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1417
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1234
1418
  },
1235
1419
  "readonly": {
1236
1420
  "type": "boolean",
1237
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1421
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1422
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1238
1423
  },
1239
1424
  "pattern": {
1240
1425
  "type": "array",
@@ -1256,15 +1441,33 @@
1256
1441
  }
1257
1442
  ],
1258
1443
  "maxItems": 2,
1259
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1444
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1445
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1446
+ },
1447
+ "name": {
1448
+ "type": "string",
1449
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1450
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1451
+ },
1452
+ "label": {
1453
+ "type": "string",
1454
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1455
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1456
+ },
1457
+ "comment": {
1458
+ "type": "string",
1459
+ "description": "Short description of the field to be displayed in the editor UI.",
1460
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1260
1461
  },
1261
1462
  "hint": {
1262
1463
  "type": "string",
1263
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1464
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1465
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1264
1466
  },
1265
1467
  "preview": {
1266
1468
  "type": "boolean",
1267
- "description": "Whether to show the preview of the field. Default: `true`."
1469
+ "description": "Whether to show the preview of the field. Default: `true`.",
1470
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1268
1471
  },
1269
1472
  "i18n": {
1270
1473
  "anyOf": [
@@ -1284,39 +1487,30 @@
1284
1487
  "const": "none"
1285
1488
  }
1286
1489
  ],
1287
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1490
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1491
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1288
1492
  }
1289
1493
  },
1290
1494
  "required": [
1291
1495
  "name",
1292
1496
  "widget"
1293
1497
  ],
1294
- "description": "Color field definition."
1498
+ "description": "Color field definition.",
1499
+ "markdownDescription": "Color field definition."
1295
1500
  },
1296
1501
  "ComputeField": {
1297
1502
  "type": "object",
1298
- "additionalProperties": false,
1299
1503
  "properties": {
1300
1504
  "widget": {
1301
1505
  "type": "string",
1302
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1303
- "const": "compute"
1506
+ "const": "compute",
1507
+ "description": "Widget name.",
1508
+ "markdownDescription": "Widget name."
1304
1509
  },
1305
1510
  "value": {
1306
1511
  "type": "string",
1307
- "description": "Value template, like `posts-{{fields.slug}}`."
1308
- },
1309
- "name": {
1310
- "type": "string",
1311
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1312
- },
1313
- "label": {
1314
- "type": "string",
1315
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1316
- },
1317
- "comment": {
1318
- "type": "string",
1319
- "description": "Short description of the field to be displayed in the editor UI."
1512
+ "description": "Value template, like `posts-{{fields.slug}}`.",
1513
+ "markdownDescription": "Value template, like `posts-{{fields.slug}}`."
1320
1514
  },
1321
1515
  "required": {
1322
1516
  "anyOf": [
@@ -1330,11 +1524,13 @@
1330
1524
  }
1331
1525
  }
1332
1526
  ],
1333
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1527
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1528
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1334
1529
  },
1335
1530
  "readonly": {
1336
1531
  "type": "boolean",
1337
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1532
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1533
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1338
1534
  },
1339
1535
  "pattern": {
1340
1536
  "type": "array",
@@ -1356,15 +1552,33 @@
1356
1552
  }
1357
1553
  ],
1358
1554
  "maxItems": 2,
1359
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1555
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1556
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1557
+ },
1558
+ "name": {
1559
+ "type": "string",
1560
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1561
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1562
+ },
1563
+ "label": {
1564
+ "type": "string",
1565
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1566
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1567
+ },
1568
+ "comment": {
1569
+ "type": "string",
1570
+ "description": "Short description of the field to be displayed in the editor UI.",
1571
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1360
1572
  },
1361
1573
  "hint": {
1362
1574
  "type": "string",
1363
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1575
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1576
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1364
1577
  },
1365
1578
  "preview": {
1366
1579
  "type": "boolean",
1367
- "description": "Whether to show the preview of the field. Default: `true`."
1580
+ "description": "Whether to show the preview of the field. Default: `true`.",
1581
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1368
1582
  },
1369
1583
  "i18n": {
1370
1584
  "anyOf": [
@@ -1384,7 +1598,8 @@
1384
1598
  "const": "none"
1385
1599
  }
1386
1600
  ],
1387
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1601
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1602
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1388
1603
  }
1389
1604
  },
1390
1605
  "required": [
@@ -1392,54 +1607,48 @@
1392
1607
  "value",
1393
1608
  "widget"
1394
1609
  ],
1395
- "description": "Compute field definition."
1610
+ "description": "Compute field definition.",
1611
+ "markdownDescription": "Compute field definition."
1396
1612
  },
1397
1613
  "DateTimeField": {
1398
1614
  "type": "object",
1399
- "additionalProperties": false,
1400
1615
  "properties": {
1401
1616
  "widget": {
1402
1617
  "type": "string",
1403
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1404
- "const": "datetime"
1618
+ "const": "datetime",
1619
+ "description": "Widget name.",
1620
+ "markdownDescription": "Widget name."
1405
1621
  },
1406
1622
  "default": {
1407
1623
  "type": "string",
1408
- "description": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string."
1624
+ "description": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string.",
1625
+ "markdownDescription": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string."
1409
1626
  },
1410
1627
  "format": {
1411
1628
  "type": "string",
1412
- "description": "Storage format written in Moment.js tokens. See https://momentjs.com/docs/#/displaying/format/ for supported tokens. Default: ISO 8601 format."
1629
+ "description": "Storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/). Default: ISO 8601 format.",
1630
+ "markdownDescription": "Storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/). Default: ISO 8601 format."
1413
1631
  },
1414
1632
  "date_format": {
1415
1633
  "type": [
1416
1634
  "string",
1417
1635
  "boolean"
1418
1636
  ],
1419
- "description": "Date storage format written in Moment.js tokens if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled."
1637
+ "description": "Date storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled.",
1638
+ "markdownDescription": "Date storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled."
1420
1639
  },
1421
1640
  "time_format": {
1422
1641
  "type": [
1423
1642
  "string",
1424
1643
  "boolean"
1425
1644
  ],
1426
- "description": "Time storage format written in Moment.js tokens if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled."
1645
+ "description": "Time storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled.",
1646
+ "markdownDescription": "Time storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled."
1427
1647
  },
1428
1648
  "picker_utc": {
1429
1649
  "type": "boolean",
1430
- "description": "Whether to make the date input/output UTC. Default: `false`."
1431
- },
1432
- "name": {
1433
- "type": "string",
1434
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1435
- },
1436
- "label": {
1437
- "type": "string",
1438
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1439
- },
1440
- "comment": {
1441
- "type": "string",
1442
- "description": "Short description of the field to be displayed in the editor UI."
1650
+ "description": "Whether to make the date input/output UTC. Default: `false`.",
1651
+ "markdownDescription": "Whether to make the date input/output UTC. Default: `false`."
1443
1652
  },
1444
1653
  "required": {
1445
1654
  "anyOf": [
@@ -1453,11 +1662,13 @@
1453
1662
  }
1454
1663
  }
1455
1664
  ],
1456
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1665
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1666
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1457
1667
  },
1458
1668
  "readonly": {
1459
1669
  "type": "boolean",
1460
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1670
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1671
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1461
1672
  },
1462
1673
  "pattern": {
1463
1674
  "type": "array",
@@ -1479,15 +1690,33 @@
1479
1690
  }
1480
1691
  ],
1481
1692
  "maxItems": 2,
1482
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1693
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1694
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1695
+ },
1696
+ "name": {
1697
+ "type": "string",
1698
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1699
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1700
+ },
1701
+ "label": {
1702
+ "type": "string",
1703
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1704
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1705
+ },
1706
+ "comment": {
1707
+ "type": "string",
1708
+ "description": "Short description of the field to be displayed in the editor UI.",
1709
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1483
1710
  },
1484
1711
  "hint": {
1485
1712
  "type": "string",
1486
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1713
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1714
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1487
1715
  },
1488
1716
  "preview": {
1489
1717
  "type": "boolean",
1490
- "description": "Whether to show the preview of the field. Default: `true`."
1718
+ "description": "Whether to show the preview of the field. Default: `true`.",
1719
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1491
1720
  },
1492
1721
  "i18n": {
1493
1722
  "anyOf": [
@@ -1507,43 +1736,50 @@
1507
1736
  "const": "none"
1508
1737
  }
1509
1738
  ],
1510
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1739
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1740
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1511
1741
  }
1512
1742
  },
1513
1743
  "required": [
1514
1744
  "name",
1515
1745
  "widget"
1516
1746
  ],
1517
- "description": "DateTime field definition."
1747
+ "description": "DateTime field definition.",
1748
+ "markdownDescription": "DateTime field definition."
1518
1749
  },
1519
1750
  "FileField": {
1520
1751
  "type": "object",
1521
- "additionalProperties": false,
1522
1752
  "properties": {
1523
1753
  "widget": {
1524
1754
  "type": "string",
1525
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1526
- "const": "file"
1755
+ "const": "file",
1756
+ "description": "Widget name.",
1757
+ "markdownDescription": "Widget name."
1527
1758
  },
1528
1759
  "default": {
1529
1760
  "type": "string",
1530
- "description": "Default value. Accepts a file path or complete URL."
1761
+ "description": "Default value. Accepts a file path or complete URL.",
1762
+ "markdownDescription": "Default value. Accepts a file path or complete URL."
1531
1763
  },
1532
1764
  "accept": {
1533
1765
  "type": "string",
1534
- "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML `accept` attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept."
1766
+ "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute.",
1767
+ "markdownDescription": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute."
1535
1768
  },
1536
1769
  "choose_url": {
1537
1770
  "type": "boolean",
1538
- "description": "Whether to show the URL input UI. Default: `true`."
1771
+ "description": "Whether to show the URL input UI. Default: `true`.",
1772
+ "markdownDescription": "Whether to show the URL input UI. Default: `true`."
1539
1773
  },
1540
1774
  "media_folder": {
1541
1775
  "type": "string",
1542
- "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1776
+ "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value.",
1777
+ "markdownDescription": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1543
1778
  },
1544
1779
  "public_folder": {
1545
1780
  "type": "string",
1546
- "description": "Public media folder path for the field. Default: `media_folder` option value."
1781
+ "description": "Public media folder path for the field. Default: `media_folder` option value.",
1782
+ "markdownDescription": "Public media folder path for the field. Default: `media_folder` option value."
1547
1783
  },
1548
1784
  "media_library": {
1549
1785
  "anyOf": [
@@ -1553,11 +1789,13 @@
1553
1789
  "properties": {
1554
1790
  "name": {
1555
1791
  "$ref": "#/definitions/MediaLibraryName",
1556
- "description": "Library name."
1792
+ "description": "Library name.",
1793
+ "markdownDescription": "Library name."
1557
1794
  },
1558
1795
  "config": {
1559
1796
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
1560
- "description": "Configuration for the default media library."
1797
+ "description": "Configuration for the default media library.",
1798
+ "markdownDescription": "Configuration for the default media library."
1561
1799
  }
1562
1800
  }
1563
1801
  },
@@ -1567,23 +1805,28 @@
1567
1805
  "properties": {
1568
1806
  "name": {
1569
1807
  "$ref": "#/definitions/MediaLibraryName",
1570
- "description": "Library name."
1808
+ "description": "Library name.",
1809
+ "markdownDescription": "Library name."
1571
1810
  },
1572
1811
  "output_filename_only": {
1573
1812
  "type": "boolean",
1574
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
1813
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
1814
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
1575
1815
  },
1576
1816
  "use_transformations": {
1577
1817
  "type": "boolean",
1578
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
1818
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
1819
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
1579
1820
  },
1580
1821
  "use_secure_url": {
1581
1822
  "type": "boolean",
1582
- "description": "Whether to use an HTTP URL. Default: `true`."
1823
+ "description": "Whether to use an HTTP URL. Default: `true`.",
1824
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
1583
1825
  },
1584
1826
  "config": {
1585
1827
  "type": "object",
1586
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
1828
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
1829
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
1587
1830
  }
1588
1831
  }
1589
1832
  },
@@ -1593,15 +1836,18 @@
1593
1836
  "properties": {
1594
1837
  "name": {
1595
1838
  "$ref": "#/definitions/MediaLibraryName",
1596
- "description": "Library name."
1839
+ "description": "Library name.",
1840
+ "markdownDescription": "Library name."
1597
1841
  },
1598
1842
  "config": {
1599
1843
  "type": "object",
1600
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
1844
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
1845
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
1601
1846
  },
1602
1847
  "settings": {
1603
1848
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
1604
- "description": "Integration settings."
1849
+ "description": "Integration settings.",
1850
+ "markdownDescription": "Integration settings."
1605
1851
  }
1606
1852
  }
1607
1853
  },
@@ -1611,39 +1857,32 @@
1611
1857
  "properties": {
1612
1858
  "name": {
1613
1859
  "$ref": "#/definitions/MediaLibraryName",
1614
- "description": "Library name."
1860
+ "description": "Library name.",
1861
+ "markdownDescription": "Library name."
1615
1862
  },
1616
1863
  "providers": {
1617
1864
  "type": "array",
1618
1865
  "items": {
1619
1866
  "$ref": "#/definitions/StockAssetProviderName"
1620
1867
  },
1621
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1868
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
1869
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1622
1870
  }
1623
1871
  }
1624
1872
  }
1625
1873
  ],
1626
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1874
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
1875
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1627
1876
  },
1628
1877
  "media_libraries": {
1629
1878
  "$ref": "#/definitions/MediaLibraries",
1630
- "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1879
+ "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option.",
1880
+ "markdownDescription": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1631
1881
  },
1632
1882
  "allow_multiple": {
1633
1883
  "type": "boolean",
1634
- "description": "Whether to enable multiple item selection in an external media library. Default: `true`."
1635
- },
1636
- "name": {
1637
- "type": "string",
1638
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1639
- },
1640
- "label": {
1641
- "type": "string",
1642
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1643
- },
1644
- "comment": {
1645
- "type": "string",
1646
- "description": "Short description of the field to be displayed in the editor UI."
1884
+ "description": "Whether to enable multiple item selection in an external media library. Default: `true`.",
1885
+ "markdownDescription": "Whether to enable multiple item selection in an external media library. Default: `true`."
1647
1886
  },
1648
1887
  "required": {
1649
1888
  "anyOf": [
@@ -1657,11 +1896,13 @@
1657
1896
  }
1658
1897
  }
1659
1898
  ],
1660
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1899
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1900
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1661
1901
  },
1662
1902
  "readonly": {
1663
1903
  "type": "boolean",
1664
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1904
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1905
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1665
1906
  },
1666
1907
  "pattern": {
1667
1908
  "type": "array",
@@ -1683,15 +1924,33 @@
1683
1924
  }
1684
1925
  ],
1685
1926
  "maxItems": 2,
1686
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1927
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1928
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1929
+ },
1930
+ "name": {
1931
+ "type": "string",
1932
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1933
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1934
+ },
1935
+ "label": {
1936
+ "type": "string",
1937
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1938
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1939
+ },
1940
+ "comment": {
1941
+ "type": "string",
1942
+ "description": "Short description of the field to be displayed in the editor UI.",
1943
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1687
1944
  },
1688
1945
  "hint": {
1689
1946
  "type": "string",
1690
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1947
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1948
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1691
1949
  },
1692
1950
  "preview": {
1693
1951
  "type": "boolean",
1694
- "description": "Whether to show the preview of the field. Default: `true`."
1952
+ "description": "Whether to show the preview of the field. Default: `true`.",
1953
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1695
1954
  },
1696
1955
  "i18n": {
1697
1956
  "anyOf": [
@@ -1711,38 +1970,29 @@
1711
1970
  "const": "none"
1712
1971
  }
1713
1972
  ],
1714
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1973
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1974
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1715
1975
  }
1716
1976
  },
1717
1977
  "required": [
1718
1978
  "name",
1719
1979
  "widget"
1720
1980
  ],
1721
- "description": "File field definition."
1981
+ "description": "File field definition.",
1982
+ "markdownDescription": "File field definition."
1722
1983
  },
1723
1984
  "HiddenField": {
1724
1985
  "type": "object",
1725
- "additionalProperties": false,
1726
1986
  "properties": {
1727
1987
  "widget": {
1728
1988
  "type": "string",
1729
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1730
- "const": "hidden"
1989
+ "const": "hidden",
1990
+ "description": "Widget name.",
1991
+ "markdownDescription": "Widget name."
1731
1992
  },
1732
1993
  "default": {
1733
- "description": "Default value. Accepts any data type that can be stored with the configured file format."
1734
- },
1735
- "name": {
1736
- "type": "string",
1737
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1738
- },
1739
- "label": {
1740
- "type": "string",
1741
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1742
- },
1743
- "comment": {
1744
- "type": "string",
1745
- "description": "Short description of the field to be displayed in the editor UI."
1994
+ "description": "Default value. Accepts any data type that can be stored with the configured file format.",
1995
+ "markdownDescription": "Default value. Accepts any data type that can be stored with the configured file format."
1746
1996
  },
1747
1997
  "required": {
1748
1998
  "anyOf": [
@@ -1756,11 +2006,13 @@
1756
2006
  }
1757
2007
  }
1758
2008
  ],
1759
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2009
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2010
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1760
2011
  },
1761
2012
  "readonly": {
1762
2013
  "type": "boolean",
1763
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2014
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2015
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1764
2016
  },
1765
2017
  "pattern": {
1766
2018
  "type": "array",
@@ -1782,15 +2034,33 @@
1782
2034
  }
1783
2035
  ],
1784
2036
  "maxItems": 2,
1785
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2037
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2038
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2039
+ },
2040
+ "name": {
2041
+ "type": "string",
2042
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2043
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2044
+ },
2045
+ "label": {
2046
+ "type": "string",
2047
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2048
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2049
+ },
2050
+ "comment": {
2051
+ "type": "string",
2052
+ "description": "Short description of the field to be displayed in the editor UI.",
2053
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1786
2054
  },
1787
2055
  "hint": {
1788
2056
  "type": "string",
1789
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2057
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2058
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1790
2059
  },
1791
2060
  "preview": {
1792
2061
  "type": "boolean",
1793
- "description": "Whether to show the preview of the field. Default: `true`."
2062
+ "description": "Whether to show the preview of the field. Default: `true`.",
2063
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1794
2064
  },
1795
2065
  "i18n": {
1796
2066
  "anyOf": [
@@ -1810,43 +2080,50 @@
1810
2080
  "const": "none"
1811
2081
  }
1812
2082
  ],
1813
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2083
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2084
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1814
2085
  }
1815
2086
  },
1816
2087
  "required": [
1817
2088
  "name",
1818
2089
  "widget"
1819
2090
  ],
1820
- "description": "Hidden field definition."
2091
+ "description": "Hidden field definition.",
2092
+ "markdownDescription": "Hidden field definition."
1821
2093
  },
1822
2094
  "ImageField": {
1823
2095
  "type": "object",
1824
- "additionalProperties": false,
1825
2096
  "properties": {
1826
2097
  "widget": {
1827
2098
  "type": "string",
1828
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
1829
- "const": "image"
2099
+ "const": "image",
2100
+ "description": "Widget name.",
2101
+ "markdownDescription": "Widget name."
1830
2102
  },
1831
2103
  "default": {
1832
2104
  "type": "string",
1833
- "description": "Default value. Accepts a file path or complete URL."
2105
+ "description": "Default value. Accepts a file path or complete URL.",
2106
+ "markdownDescription": "Default value. Accepts a file path or complete URL."
1834
2107
  },
1835
2108
  "accept": {
1836
2109
  "type": "string",
1837
- "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML `accept` attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept."
2110
+ "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute.",
2111
+ "markdownDescription": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute."
1838
2112
  },
1839
2113
  "choose_url": {
1840
2114
  "type": "boolean",
1841
- "description": "Whether to show the URL input UI. Default: `true`."
2115
+ "description": "Whether to show the URL input UI. Default: `true`.",
2116
+ "markdownDescription": "Whether to show the URL input UI. Default: `true`."
1842
2117
  },
1843
2118
  "media_folder": {
1844
2119
  "type": "string",
1845
- "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
2120
+ "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value.",
2121
+ "markdownDescription": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1846
2122
  },
1847
2123
  "public_folder": {
1848
2124
  "type": "string",
1849
- "description": "Public media folder path for the field. Default: `media_folder` option value."
2125
+ "description": "Public media folder path for the field. Default: `media_folder` option value.",
2126
+ "markdownDescription": "Public media folder path for the field. Default: `media_folder` option value."
1850
2127
  },
1851
2128
  "media_library": {
1852
2129
  "anyOf": [
@@ -1856,11 +2133,13 @@
1856
2133
  "properties": {
1857
2134
  "name": {
1858
2135
  "$ref": "#/definitions/MediaLibraryName",
1859
- "description": "Library name."
2136
+ "description": "Library name.",
2137
+ "markdownDescription": "Library name."
1860
2138
  },
1861
2139
  "config": {
1862
2140
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
1863
- "description": "Configuration for the default media library."
2141
+ "description": "Configuration for the default media library.",
2142
+ "markdownDescription": "Configuration for the default media library."
1864
2143
  }
1865
2144
  }
1866
2145
  },
@@ -1870,23 +2149,28 @@
1870
2149
  "properties": {
1871
2150
  "name": {
1872
2151
  "$ref": "#/definitions/MediaLibraryName",
1873
- "description": "Library name."
2152
+ "description": "Library name.",
2153
+ "markdownDescription": "Library name."
1874
2154
  },
1875
2155
  "output_filename_only": {
1876
2156
  "type": "boolean",
1877
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
2157
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
2158
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
1878
2159
  },
1879
2160
  "use_transformations": {
1880
2161
  "type": "boolean",
1881
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
2162
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
2163
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
1882
2164
  },
1883
2165
  "use_secure_url": {
1884
2166
  "type": "boolean",
1885
- "description": "Whether to use an HTTP URL. Default: `true`."
2167
+ "description": "Whether to use an HTTP URL. Default: `true`.",
2168
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
1886
2169
  },
1887
2170
  "config": {
1888
2171
  "type": "object",
1889
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
2172
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
2173
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
1890
2174
  }
1891
2175
  }
1892
2176
  },
@@ -1896,15 +2180,18 @@
1896
2180
  "properties": {
1897
2181
  "name": {
1898
2182
  "$ref": "#/definitions/MediaLibraryName",
1899
- "description": "Library name."
2183
+ "description": "Library name.",
2184
+ "markdownDescription": "Library name."
1900
2185
  },
1901
2186
  "config": {
1902
2187
  "type": "object",
1903
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
2188
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
2189
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
1904
2190
  },
1905
2191
  "settings": {
1906
2192
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
1907
- "description": "Integration settings."
2193
+ "description": "Integration settings.",
2194
+ "markdownDescription": "Integration settings."
1908
2195
  }
1909
2196
  }
1910
2197
  },
@@ -1914,39 +2201,32 @@
1914
2201
  "properties": {
1915
2202
  "name": {
1916
2203
  "$ref": "#/definitions/MediaLibraryName",
1917
- "description": "Library name."
2204
+ "description": "Library name.",
2205
+ "markdownDescription": "Library name."
1918
2206
  },
1919
2207
  "providers": {
1920
2208
  "type": "array",
1921
2209
  "items": {
1922
2210
  "$ref": "#/definitions/StockAssetProviderName"
1923
2211
  },
1924
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
2212
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
2213
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1925
2214
  }
1926
2215
  }
1927
2216
  }
1928
2217
  ],
1929
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
2218
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
2219
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1930
2220
  },
1931
2221
  "media_libraries": {
1932
2222
  "$ref": "#/definitions/MediaLibraries",
1933
- "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
2223
+ "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option.",
2224
+ "markdownDescription": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1934
2225
  },
1935
2226
  "allow_multiple": {
1936
2227
  "type": "boolean",
1937
- "description": "Whether to enable multiple item selection in an external media library. Default: `true`."
1938
- },
1939
- "name": {
1940
- "type": "string",
1941
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1942
- },
1943
- "label": {
1944
- "type": "string",
1945
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1946
- },
1947
- "comment": {
1948
- "type": "string",
1949
- "description": "Short description of the field to be displayed in the editor UI."
2228
+ "description": "Whether to enable multiple item selection in an external media library. Default: `true`.",
2229
+ "markdownDescription": "Whether to enable multiple item selection in an external media library. Default: `true`."
1950
2230
  },
1951
2231
  "required": {
1952
2232
  "anyOf": [
@@ -1960,11 +2240,13 @@
1960
2240
  }
1961
2241
  }
1962
2242
  ],
1963
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2243
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2244
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1964
2245
  },
1965
2246
  "readonly": {
1966
2247
  "type": "boolean",
1967
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2248
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2249
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1968
2250
  },
1969
2251
  "pattern": {
1970
2252
  "type": "array",
@@ -1986,15 +2268,33 @@
1986
2268
  }
1987
2269
  ],
1988
2270
  "maxItems": 2,
1989
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2271
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2272
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2273
+ },
2274
+ "name": {
2275
+ "type": "string",
2276
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2277
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2278
+ },
2279
+ "label": {
2280
+ "type": "string",
2281
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2282
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2283
+ },
2284
+ "comment": {
2285
+ "type": "string",
2286
+ "description": "Short description of the field to be displayed in the editor UI.",
2287
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1990
2288
  },
1991
2289
  "hint": {
1992
2290
  "type": "string",
1993
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2291
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2292
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1994
2293
  },
1995
2294
  "preview": {
1996
2295
  "type": "boolean",
1997
- "description": "Whether to show the preview of the field. Default: `true`."
2296
+ "description": "Whether to show the preview of the field. Default: `true`.",
2297
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1998
2298
  },
1999
2299
  "i18n": {
2000
2300
  "anyOf": [
@@ -2014,58 +2314,53 @@
2014
2314
  "const": "none"
2015
2315
  }
2016
2316
  ],
2017
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2317
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2318
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2018
2319
  }
2019
2320
  },
2020
2321
  "required": [
2021
2322
  "name",
2022
2323
  "widget"
2023
2324
  ],
2024
- "description": "Image field definition."
2325
+ "description": "Image field definition.",
2326
+ "markdownDescription": "Image field definition."
2025
2327
  },
2026
2328
  "KeyValueField": {
2027
2329
  "type": "object",
2028
- "additionalProperties": false,
2029
2330
  "properties": {
2030
2331
  "min": {
2031
2332
  "type": "number",
2032
- "description": "Minimum number of items that can be added. Default: 0."
2333
+ "description": "Minimum number of items that can be added. Default: `0`.",
2334
+ "markdownDescription": "Minimum number of items that can be added. Default: `0`."
2033
2335
  },
2034
2336
  "max": {
2035
2337
  "type": "number",
2036
- "description": "Maximum number of items that can be added. Default: infinity."
2338
+ "description": "Maximum number of items that can be added. Default: `Infinity`.",
2339
+ "markdownDescription": "Maximum number of items that can be added. Default: `Infinity`."
2037
2340
  },
2038
2341
  "widget": {
2039
2342
  "type": "string",
2040
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2041
- "const": "keyvalue"
2343
+ "const": "keyvalue",
2344
+ "description": "Widget name.",
2345
+ "markdownDescription": "Widget name."
2042
2346
  },
2043
2347
  "default": {
2044
2348
  "type": "object",
2045
2349
  "additionalProperties": {
2046
2350
  "type": "string"
2047
2351
  },
2048
- "description": "Default key-value pairs."
2352
+ "description": "Default key-value pairs.",
2353
+ "markdownDescription": "Default key-value pairs."
2049
2354
  },
2050
2355
  "key_label": {
2051
2356
  "type": "string",
2052
- "description": "Label for the key column. Default: Key."
2357
+ "description": "Label for the key column. Default: Key.",
2358
+ "markdownDescription": "Label for the key column. Default: Key."
2053
2359
  },
2054
2360
  "value_label": {
2055
2361
  "type": "string",
2056
- "description": "Label for the value column. Default: Value."
2057
- },
2058
- "name": {
2059
- "type": "string",
2060
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2061
- },
2062
- "label": {
2063
- "type": "string",
2064
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2065
- },
2066
- "comment": {
2067
- "type": "string",
2068
- "description": "Short description of the field to be displayed in the editor UI."
2362
+ "description": "Label for the value column. Default: Value.",
2363
+ "markdownDescription": "Label for the value column. Default: Value."
2069
2364
  },
2070
2365
  "required": {
2071
2366
  "anyOf": [
@@ -2079,11 +2374,13 @@
2079
2374
  }
2080
2375
  }
2081
2376
  ],
2082
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2377
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2378
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2083
2379
  },
2084
2380
  "readonly": {
2085
2381
  "type": "boolean",
2086
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2382
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2383
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2087
2384
  },
2088
2385
  "pattern": {
2089
2386
  "type": "array",
@@ -2105,15 +2402,33 @@
2105
2402
  }
2106
2403
  ],
2107
2404
  "maxItems": 2,
2108
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2405
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2406
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2407
+ },
2408
+ "name": {
2409
+ "type": "string",
2410
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2411
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2412
+ },
2413
+ "label": {
2414
+ "type": "string",
2415
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2416
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2417
+ },
2418
+ "comment": {
2419
+ "type": "string",
2420
+ "description": "Short description of the field to be displayed in the editor UI.",
2421
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2109
2422
  },
2110
2423
  "hint": {
2111
2424
  "type": "string",
2112
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2425
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2426
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2113
2427
  },
2114
2428
  "preview": {
2115
2429
  "type": "boolean",
2116
- "description": "Whether to show the preview of the field. Default: `true`."
2430
+ "description": "Whether to show the preview of the field. Default: `true`.",
2431
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2117
2432
  },
2118
2433
  "i18n": {
2119
2434
  "anyOf": [
@@ -2133,42 +2448,48 @@
2133
2448
  "const": "none"
2134
2449
  }
2135
2450
  ],
2136
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2451
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2452
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2137
2453
  }
2138
2454
  },
2139
2455
  "required": [
2140
2456
  "name",
2141
2457
  "widget"
2142
2458
  ],
2143
- "description": "KeyValue field definition."
2459
+ "description": "KeyValue field definition.",
2460
+ "markdownDescription": "KeyValue field definition."
2144
2461
  },
2145
2462
  "ListField": {
2146
2463
  "type": "object",
2147
- "additionalProperties": false,
2148
2464
  "properties": {
2149
2465
  "types": {
2150
2466
  "type": "array",
2151
2467
  "items": {
2152
2468
  "$ref": "#/definitions/VariableFieldType"
2153
2469
  },
2154
- "description": "Set of nested Object fields to be selected or added."
2470
+ "description": "Set of nested Object fields to be selected or added.",
2471
+ "markdownDescription": "Set of nested Object fields to be selected or added."
2155
2472
  },
2156
2473
  "typeKey": {
2157
2474
  "type": "string",
2158
- "description": "Property name to store the type name in nested objects. Default: `type`."
2475
+ "description": "Property name to store the type name in nested objects. Default: `type`.",
2476
+ "markdownDescription": "Property name to store the type name in nested objects. Default: `type`."
2159
2477
  },
2160
2478
  "min": {
2161
2479
  "type": "number",
2162
- "description": "Minimum number of items that can be added. Default: 0."
2480
+ "description": "Minimum number of items that can be added. Default: `0`.",
2481
+ "markdownDescription": "Minimum number of items that can be added. Default: `0`."
2163
2482
  },
2164
2483
  "max": {
2165
2484
  "type": "number",
2166
- "description": "Maximum number of items that can be added. Default: infinity."
2485
+ "description": "Maximum number of items that can be added. Default: `Infinity`.",
2486
+ "markdownDescription": "Maximum number of items that can be added. Default: `Infinity`."
2167
2487
  },
2168
2488
  "widget": {
2169
2489
  "type": "string",
2170
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2171
- "const": "list"
2490
+ "const": "list",
2491
+ "description": "Widget name.",
2492
+ "markdownDescription": "Widget name."
2172
2493
  },
2173
2494
  "default": {
2174
2495
  "anyOf": [
@@ -2188,23 +2509,28 @@
2188
2509
  "type": "object"
2189
2510
  }
2190
2511
  ],
2191
- "description": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details."
2512
+ "description": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details.",
2513
+ "markdownDescription": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details."
2192
2514
  },
2193
2515
  "allow_add": {
2194
2516
  "type": "boolean",
2195
- "description": "Whether to allow users to add new values. Default: `true`."
2517
+ "description": "Whether to allow users to add new values. Default: `true`.",
2518
+ "markdownDescription": "Whether to allow users to add new values. Default: `true`."
2196
2519
  },
2197
2520
  "add_to_top": {
2198
2521
  "type": "boolean",
2199
- "description": "Whether to add new items to the top of the list instead of the bottom. Default: `false`."
2522
+ "description": "Whether to add new items to the top of the list instead of the bottom. Default: `false`.",
2523
+ "markdownDescription": "Whether to add new items to the top of the list instead of the bottom. Default: `false`."
2200
2524
  },
2201
2525
  "label_singular": {
2202
2526
  "type": "string",
2203
- "description": "Label to be displayed on the Add button. Default: `label` field value."
2527
+ "description": "Label to be displayed on the Add button. Default: `label` field value.",
2528
+ "markdownDescription": "Label to be displayed on the Add button. Default: `label` field value."
2204
2529
  },
2205
2530
  "summary": {
2206
2531
  "type": "string",
2207
- "description": "Template of a label to be displayed on a collapsed list item."
2532
+ "description": "Template of a label to be displayed on a collapsed list item.",
2533
+ "markdownDescription": "Template of a label to be displayed on a collapsed list item."
2208
2534
  },
2209
2535
  "collapsed": {
2210
2536
  "anyOf": [
@@ -2216,7 +2542,8 @@
2216
2542
  "const": "auto"
2217
2543
  }
2218
2544
  ],
2219
- "description": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty."
2545
+ "description": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty.",
2546
+ "markdownDescription": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty."
2220
2547
  },
2221
2548
  "minimize_collapsed": {
2222
2549
  "anyOf": [
@@ -2228,34 +2555,26 @@
2228
2555
  "const": "auto"
2229
2556
  }
2230
2557
  ],
2231
- "description": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty."
2558
+ "description": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty.",
2559
+ "markdownDescription": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty."
2232
2560
  },
2233
2561
  "field": {
2234
2562
  "$ref": "#/definitions/Field",
2235
- "description": "Single field to be included in a list item."
2563
+ "description": "Single field to be included in a list item.",
2564
+ "markdownDescription": "Single field to be included in a list item."
2236
2565
  },
2237
2566
  "fields": {
2238
2567
  "type": "array",
2239
2568
  "items": {
2240
2569
  "$ref": "#/definitions/Field"
2241
2570
  },
2242
- "description": "Set of fields to be included in a list item."
2571
+ "description": "Set of fields to be included in a list item.",
2572
+ "markdownDescription": "Set of fields to be included in a list item."
2243
2573
  },
2244
2574
  "root": {
2245
2575
  "type": "boolean",
2246
- "description": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list for details."
2247
- },
2248
- "name": {
2249
- "type": "string",
2250
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2251
- },
2252
- "label": {
2253
- "type": "string",
2254
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2255
- },
2256
- "comment": {
2257
- "type": "string",
2258
- "description": "Short description of the field to be displayed in the editor UI."
2576
+ "description": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See our [README](https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list) for details.",
2577
+ "markdownDescription": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See our [README](https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list) for details."
2259
2578
  },
2260
2579
  "required": {
2261
2580
  "anyOf": [
@@ -2269,11 +2588,13 @@
2269
2588
  }
2270
2589
  }
2271
2590
  ],
2272
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2591
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2592
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2273
2593
  },
2274
2594
  "readonly": {
2275
2595
  "type": "boolean",
2276
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2596
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2597
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2277
2598
  },
2278
2599
  "pattern": {
2279
2600
  "type": "array",
@@ -2295,15 +2616,33 @@
2295
2616
  }
2296
2617
  ],
2297
2618
  "maxItems": 2,
2298
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2619
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2620
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2621
+ },
2622
+ "name": {
2623
+ "type": "string",
2624
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2625
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2626
+ },
2627
+ "label": {
2628
+ "type": "string",
2629
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2630
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2631
+ },
2632
+ "comment": {
2633
+ "type": "string",
2634
+ "description": "Short description of the field to be displayed in the editor UI.",
2635
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2299
2636
  },
2300
2637
  "hint": {
2301
2638
  "type": "string",
2302
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2639
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2640
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2303
2641
  },
2304
2642
  "preview": {
2305
2643
  "type": "boolean",
2306
- "description": "Whether to show the preview of the field. Default: `true`."
2644
+ "description": "Whether to show the preview of the field. Default: `true`.",
2645
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2307
2646
  },
2308
2647
  "i18n": {
2309
2648
  "anyOf": [
@@ -2323,65 +2662,75 @@
2323
2662
  "const": "none"
2324
2663
  }
2325
2664
  ],
2326
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2665
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2666
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2327
2667
  }
2328
2668
  },
2329
2669
  "required": [
2330
2670
  "name",
2331
2671
  "widget"
2332
2672
  ],
2333
- "description": "List field definition."
2673
+ "description": "List field definition.",
2674
+ "markdownDescription": "List field definition."
2334
2675
  },
2335
2676
  "VariableFieldType": {
2336
2677
  "type": "object",
2337
2678
  "properties": {
2338
2679
  "name": {
2339
2680
  "type": "string",
2340
- "description": "Unique identifier for the type."
2681
+ "description": "Unique identifier for the type.",
2682
+ "markdownDescription": "Unique identifier for the type."
2341
2683
  },
2342
2684
  "label": {
2343
2685
  "type": "string",
2344
- "description": "Label of the type to be displayed in the editor UI. Default: `name` field value."
2686
+ "description": "Label of the type to be displayed in the editor UI. Default: `name` field value.",
2687
+ "markdownDescription": "Label of the type to be displayed in the editor UI. Default: `name` field value."
2345
2688
  },
2346
2689
  "widget": {
2347
2690
  "type": "string",
2348
2691
  "const": "object",
2349
- "description": "Widget name. Values other than `object` are ignored."
2692
+ "description": "Widget name. Values other than `object` are ignored.",
2693
+ "markdownDescription": "Widget name. Values other than `object` are ignored."
2350
2694
  },
2351
2695
  "summary": {
2352
2696
  "type": "string",
2353
- "description": "Template of a label to be displayed on a collapsed object."
2697
+ "description": "Template of a label to be displayed on a collapsed object.",
2698
+ "markdownDescription": "Template of a label to be displayed on a collapsed object."
2354
2699
  },
2355
2700
  "fields": {
2356
2701
  "type": "array",
2357
2702
  "items": {
2358
2703
  "$ref": "#/definitions/Field"
2359
2704
  },
2360
- "description": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved."
2705
+ "description": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved.",
2706
+ "markdownDescription": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved."
2361
2707
  }
2362
2708
  },
2363
2709
  "required": [
2364
2710
  "name"
2365
2711
  ],
2366
2712
  "additionalProperties": false,
2367
- "description": "Variable type for List/Object fields."
2713
+ "description": "Variable type for List/Object fields.",
2714
+ "markdownDescription": "Variable type for List/Object fields."
2368
2715
  },
2369
2716
  "MapField": {
2370
2717
  "type": "object",
2371
- "additionalProperties": false,
2372
2718
  "properties": {
2373
2719
  "widget": {
2374
2720
  "type": "string",
2375
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2376
- "const": "map"
2721
+ "const": "map",
2722
+ "description": "Widget name.",
2723
+ "markdownDescription": "Widget name."
2377
2724
  },
2378
2725
  "default": {
2379
2726
  "type": "string",
2380
- "description": "Default value. Accepts a stringified single GeoJSON geometry object that contains `type` and `coordinates` properties."
2727
+ "description": "Default value. Accepts a stringified single [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates` properties.",
2728
+ "markdownDescription": "Default value. Accepts a stringified single [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates` properties."
2381
2729
  },
2382
2730
  "decimals": {
2383
2731
  "type": "number",
2384
- "description": "Precision of coordinates to be saved. Default: 7."
2732
+ "description": "Precision of coordinates to be saved. Default: `7`.",
2733
+ "markdownDescription": "Precision of coordinates to be saved. Default: `7`."
2385
2734
  },
2386
2735
  "type": {
2387
2736
  "type": "string",
@@ -2390,19 +2739,8 @@
2390
2739
  "LineString",
2391
2740
  "Polygon"
2392
2741
  ],
2393
- "description": "Geometry type. Default: Point."
2394
- },
2395
- "name": {
2396
- "type": "string",
2397
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2398
- },
2399
- "label": {
2400
- "type": "string",
2401
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2402
- },
2403
- "comment": {
2404
- "type": "string",
2405
- "description": "Short description of the field to be displayed in the editor UI."
2742
+ "description": "Geometry type. Default: `Point`.",
2743
+ "markdownDescription": "Geometry type. Default: `Point`."
2406
2744
  },
2407
2745
  "required": {
2408
2746
  "anyOf": [
@@ -2416,11 +2754,13 @@
2416
2754
  }
2417
2755
  }
2418
2756
  ],
2419
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2757
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2758
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2420
2759
  },
2421
2760
  "readonly": {
2422
2761
  "type": "boolean",
2423
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2762
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2763
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2424
2764
  },
2425
2765
  "pattern": {
2426
2766
  "type": "array",
@@ -2442,15 +2782,33 @@
2442
2782
  }
2443
2783
  ],
2444
2784
  "maxItems": 2,
2445
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2785
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2786
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2787
+ },
2788
+ "name": {
2789
+ "type": "string",
2790
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2791
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2792
+ },
2793
+ "label": {
2794
+ "type": "string",
2795
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2796
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2797
+ },
2798
+ "comment": {
2799
+ "type": "string",
2800
+ "description": "Short description of the field to be displayed in the editor UI.",
2801
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2446
2802
  },
2447
2803
  "hint": {
2448
2804
  "type": "string",
2449
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2805
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2806
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2450
2807
  },
2451
2808
  "preview": {
2452
2809
  "type": "boolean",
2453
- "description": "Whether to show the preview of the field. Default: `true`."
2810
+ "description": "Whether to show the preview of the field. Default: `true`.",
2811
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2454
2812
  },
2455
2813
  "i18n": {
2456
2814
  "anyOf": [
@@ -2470,38 +2828,43 @@
2470
2828
  "const": "none"
2471
2829
  }
2472
2830
  ],
2473
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2831
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2832
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2474
2833
  }
2475
2834
  },
2476
2835
  "required": [
2477
2836
  "name",
2478
2837
  "widget"
2479
2838
  ],
2480
- "description": "Map field definition."
2839
+ "description": "Map field definition.",
2840
+ "markdownDescription": "Map field definition."
2481
2841
  },
2482
2842
  "MarkdownField": {
2483
2843
  "type": "object",
2484
- "additionalProperties": false,
2485
2844
  "properties": {
2486
2845
  "widget": {
2487
2846
  "type": "string",
2488
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2489
- "const": "markdown"
2847
+ "const": "markdown",
2848
+ "description": "Widget name.",
2849
+ "markdownDescription": "Widget name."
2490
2850
  },
2491
2851
  "default": {
2492
2852
  "type": "string",
2493
- "description": "Default value."
2853
+ "description": "Default value.",
2854
+ "markdownDescription": "Default value."
2494
2855
  },
2495
2856
  "minimal": {
2496
2857
  "type": "boolean",
2497
- "description": "Whether to minimize the toolbar height."
2858
+ "description": "Whether to minimize the toolbar height.",
2859
+ "markdownDescription": "Whether to minimize the toolbar height."
2498
2860
  },
2499
2861
  "buttons": {
2500
2862
  "type": "array",
2501
2863
  "items": {
2502
2864
  "$ref": "#/definitions/RichTextEditorButtonName"
2503
2865
  },
2504
- "description": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names."
2866
+ "description": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names.",
2867
+ "markdownDescription": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names."
2505
2868
  },
2506
2869
  "editor_components": {
2507
2870
  "type": "array",
@@ -2515,34 +2878,26 @@
2515
2878
  }
2516
2879
  ]
2517
2880
  },
2518
- "description": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names."
2881
+ "description": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names.",
2882
+ "markdownDescription": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names."
2519
2883
  },
2520
2884
  "modes": {
2521
2885
  "type": "array",
2522
2886
  "items": {
2523
2887
  "$ref": "#/definitions/RichTextEditorMode"
2524
2888
  },
2525
- "description": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`."
2889
+ "description": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`.",
2890
+ "markdownDescription": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`."
2526
2891
  },
2527
2892
  "sanitize_preview": {
2528
2893
  "type": "boolean",
2529
- "description": "Whether to sanitize the preview HTML. Default: `false`."
2894
+ "description": "Whether to sanitize the preview HTML. Default: `false`.",
2895
+ "markdownDescription": "Whether to sanitize the preview HTML. Default: `false`."
2530
2896
  },
2531
2897
  "linked_images": {
2532
2898
  "type": "boolean",
2533
- "description": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks."
2534
- },
2535
- "name": {
2536
- "type": "string",
2537
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2538
- },
2539
- "label": {
2540
- "type": "string",
2541
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2542
- },
2543
- "comment": {
2544
- "type": "string",
2545
- "description": "Short description of the field to be displayed in the editor UI."
2899
+ "description": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks.",
2900
+ "markdownDescription": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks."
2546
2901
  },
2547
2902
  "required": {
2548
2903
  "anyOf": [
@@ -2556,11 +2911,13 @@
2556
2911
  }
2557
2912
  }
2558
2913
  ],
2559
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2914
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2915
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2560
2916
  },
2561
2917
  "readonly": {
2562
2918
  "type": "boolean",
2563
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2919
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2920
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2564
2921
  },
2565
2922
  "pattern": {
2566
2923
  "type": "array",
@@ -2582,15 +2939,33 @@
2582
2939
  }
2583
2940
  ],
2584
2941
  "maxItems": 2,
2585
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2942
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2943
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2944
+ },
2945
+ "name": {
2946
+ "type": "string",
2947
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2948
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2949
+ },
2950
+ "label": {
2951
+ "type": "string",
2952
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2953
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2954
+ },
2955
+ "comment": {
2956
+ "type": "string",
2957
+ "description": "Short description of the field to be displayed in the editor UI.",
2958
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2586
2959
  },
2587
2960
  "hint": {
2588
2961
  "type": "string",
2589
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2962
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2963
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2590
2964
  },
2591
2965
  "preview": {
2592
2966
  "type": "boolean",
2593
- "description": "Whether to show the preview of the field. Default: `true`."
2967
+ "description": "Whether to show the preview of the field. Default: `true`.",
2968
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2594
2969
  },
2595
2970
  "i18n": {
2596
2971
  "anyOf": [
@@ -2610,14 +2985,16 @@
2610
2985
  "const": "none"
2611
2986
  }
2612
2987
  ],
2613
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2988
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2989
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2614
2990
  }
2615
2991
  },
2616
2992
  "required": [
2617
2993
  "name",
2618
2994
  "widget"
2619
2995
  ],
2620
- "description": "Markdown field definition."
2996
+ "description": "Markdown field definition.",
2997
+ "markdownDescription": "Markdown field definition."
2621
2998
  },
2622
2999
  "RichTextEditorButtonName": {
2623
3000
  "type": "string",
@@ -2636,7 +3013,8 @@
2636
3013
  "bulleted-list",
2637
3014
  "numbered-list"
2638
3015
  ],
2639
- "description": "Supported button name for the rich text editor."
3016
+ "description": "Supported button name for the rich text editor.",
3017
+ "markdownDescription": "Supported button name for the rich text editor."
2640
3018
  },
2641
3019
  "RichTextEditorComponentName": {
2642
3020
  "type": "string",
@@ -2644,7 +3022,8 @@
2644
3022
  "code-block",
2645
3023
  "image"
2646
3024
  ],
2647
- "description": "Built-in editor component name for the rich text editor."
3025
+ "description": "Built-in editor component name for the rich text editor.",
3026
+ "markdownDescription": "Built-in editor component name for the rich text editor."
2648
3027
  },
2649
3028
  "RichTextEditorMode": {
2650
3029
  "type": "string",
@@ -2652,59 +3031,55 @@
2652
3031
  "rich_text",
2653
3032
  "raw"
2654
3033
  ],
2655
- "description": "Supported mode name for the rich text editor."
3034
+ "description": "Supported mode name for the rich text editor.",
3035
+ "markdownDescription": "Supported mode name for the rich text editor."
2656
3036
  },
2657
3037
  "NumberField": {
2658
3038
  "type": "object",
2659
- "additionalProperties": false,
2660
3039
  "properties": {
2661
3040
  "before_input": {
2662
3041
  "type": "string",
2663
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3042
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
3043
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
2664
3044
  },
2665
3045
  "after_input": {
2666
3046
  "type": "string",
2667
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3047
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
3048
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
2668
3049
  },
2669
3050
  "widget": {
2670
3051
  "type": "string",
2671
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2672
- "const": "number"
3052
+ "const": "number",
3053
+ "description": "Widget name.",
3054
+ "markdownDescription": "Widget name."
2673
3055
  },
2674
3056
  "default": {
2675
3057
  "type": [
2676
3058
  "number",
2677
3059
  "string"
2678
3060
  ],
2679
- "description": "Default value."
3061
+ "description": "Default value.",
3062
+ "markdownDescription": "Default value."
2680
3063
  },
2681
3064
  "value_type": {
2682
3065
  "type": "string",
2683
- "description": "Type of value to be saved. Default: `int`."
3066
+ "description": "Type of value to be saved. Default: `int`.",
3067
+ "markdownDescription": "Type of value to be saved. Default: `int`."
2684
3068
  },
2685
3069
  "min": {
2686
3070
  "type": "number",
2687
- "description": "Minimum value that can be entered in the input. Default: undefined."
3071
+ "description": "Minimum value that can be entered in the input. Default: `-Infinity`.",
3072
+ "markdownDescription": "Minimum value that can be entered in the input. Default: `-Infinity`."
2688
3073
  },
2689
3074
  "max": {
2690
3075
  "type": "number",
2691
- "description": "Maximum value that can be entered in the input. Default: undefined."
3076
+ "description": "Maximum value that can be entered in the input. Default: `Infinity`.",
3077
+ "markdownDescription": "Maximum value that can be entered in the input. Default: `Infinity`."
2692
3078
  },
2693
3079
  "step": {
2694
3080
  "type": "number",
2695
- "description": "Number to increase/decrease with the arrow key/button. Default: 1."
2696
- },
2697
- "name": {
2698
- "type": "string",
2699
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2700
- },
2701
- "label": {
2702
- "type": "string",
2703
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2704
- },
2705
- "comment": {
2706
- "type": "string",
2707
- "description": "Short description of the field to be displayed in the editor UI."
3081
+ "description": "Number to increase/decrease with the arrow key/button. Default: `1`.",
3082
+ "markdownDescription": "Number to increase/decrease with the arrow key/button. Default: `1`."
2708
3083
  },
2709
3084
  "required": {
2710
3085
  "anyOf": [
@@ -2718,11 +3093,13 @@
2718
3093
  }
2719
3094
  }
2720
3095
  ],
2721
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3096
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3097
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2722
3098
  },
2723
3099
  "readonly": {
2724
3100
  "type": "boolean",
2725
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3101
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3102
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2726
3103
  },
2727
3104
  "pattern": {
2728
3105
  "type": "array",
@@ -2744,15 +3121,33 @@
2744
3121
  }
2745
3122
  ],
2746
3123
  "maxItems": 2,
2747
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3124
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3125
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3126
+ },
3127
+ "name": {
3128
+ "type": "string",
3129
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3130
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3131
+ },
3132
+ "label": {
3133
+ "type": "string",
3134
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3135
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3136
+ },
3137
+ "comment": {
3138
+ "type": "string",
3139
+ "description": "Short description of the field to be displayed in the editor UI.",
3140
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2748
3141
  },
2749
3142
  "hint": {
2750
3143
  "type": "string",
2751
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3144
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3145
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2752
3146
  },
2753
3147
  "preview": {
2754
3148
  "type": "boolean",
2755
- "description": "Whether to show the preview of the field. Default: `true`."
3149
+ "description": "Whether to show the preview of the field. Default: `true`.",
3150
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2756
3151
  },
2757
3152
  "i18n": {
2758
3153
  "anyOf": [
@@ -2772,38 +3167,43 @@
2772
3167
  "const": "none"
2773
3168
  }
2774
3169
  ],
2775
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3170
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3171
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2776
3172
  }
2777
3173
  },
2778
3174
  "required": [
2779
3175
  "name",
2780
3176
  "widget"
2781
3177
  ],
2782
- "description": "Number field definition."
3178
+ "description": "Number field definition.",
3179
+ "markdownDescription": "Number field definition."
2783
3180
  },
2784
3181
  "ObjectField": {
2785
3182
  "type": "object",
2786
- "additionalProperties": false,
2787
3183
  "properties": {
2788
3184
  "types": {
2789
3185
  "type": "array",
2790
3186
  "items": {
2791
3187
  "$ref": "#/definitions/VariableFieldType"
2792
3188
  },
2793
- "description": "Set of nested Object fields to be selected or added."
3189
+ "description": "Set of nested Object fields to be selected or added.",
3190
+ "markdownDescription": "Set of nested Object fields to be selected or added."
2794
3191
  },
2795
3192
  "typeKey": {
2796
3193
  "type": "string",
2797
- "description": "Property name to store the type name in nested objects. Default: `type`."
3194
+ "description": "Property name to store the type name in nested objects. Default: `type`.",
3195
+ "markdownDescription": "Property name to store the type name in nested objects. Default: `type`."
2798
3196
  },
2799
3197
  "widget": {
2800
3198
  "type": "string",
2801
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2802
- "const": "object"
3199
+ "const": "object",
3200
+ "description": "Widget name.",
3201
+ "markdownDescription": "Widget name."
2803
3202
  },
2804
3203
  "default": {
2805
3204
  "type": "object",
2806
- "description": "Default values."
3205
+ "description": "Default values.",
3206
+ "markdownDescription": "Default values."
2807
3207
  },
2808
3208
  "collapsed": {
2809
3209
  "anyOf": [
@@ -2815,30 +3215,21 @@
2815
3215
  "const": "auto"
2816
3216
  }
2817
3217
  ],
2818
- "description": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty."
3218
+ "description": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty.",
3219
+ "markdownDescription": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty."
2819
3220
  },
2820
3221
  "summary": {
2821
3222
  "type": "string",
2822
- "description": "Template of a label to be displayed on a collapsed object."
3223
+ "description": "Template of a label to be displayed on a collapsed object.",
3224
+ "markdownDescription": "Template of a label to be displayed on a collapsed object."
2823
3225
  },
2824
3226
  "fields": {
2825
3227
  "type": "array",
2826
3228
  "items": {
2827
3229
  "$ref": "#/definitions/Field"
2828
3230
  },
2829
- "description": "Set of fields to be included."
2830
- },
2831
- "name": {
2832
- "type": "string",
2833
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2834
- },
2835
- "label": {
2836
- "type": "string",
2837
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2838
- },
2839
- "comment": {
2840
- "type": "string",
2841
- "description": "Short description of the field to be displayed in the editor UI."
3231
+ "description": "Set of fields to be included.",
3232
+ "markdownDescription": "Set of fields to be included."
2842
3233
  },
2843
3234
  "required": {
2844
3235
  "anyOf": [
@@ -2852,11 +3243,13 @@
2852
3243
  }
2853
3244
  }
2854
3245
  ],
2855
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3246
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3247
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2856
3248
  },
2857
3249
  "readonly": {
2858
3250
  "type": "boolean",
2859
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3251
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3252
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2860
3253
  },
2861
3254
  "pattern": {
2862
3255
  "type": "array",
@@ -2878,15 +3271,33 @@
2878
3271
  }
2879
3272
  ],
2880
3273
  "maxItems": 2,
2881
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3274
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3275
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3276
+ },
3277
+ "name": {
3278
+ "type": "string",
3279
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3280
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3281
+ },
3282
+ "label": {
3283
+ "type": "string",
3284
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3285
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3286
+ },
3287
+ "comment": {
3288
+ "type": "string",
3289
+ "description": "Short description of the field to be displayed in the editor UI.",
3290
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2882
3291
  },
2883
3292
  "hint": {
2884
3293
  "type": "string",
2885
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3294
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3295
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2886
3296
  },
2887
3297
  "preview": {
2888
3298
  "type": "boolean",
2889
- "description": "Whether to show the preview of the field. Default: `true`."
3299
+ "description": "Whether to show the preview of the field. Default: `true`.",
3300
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2890
3301
  },
2891
3302
  "i18n": {
2892
3303
  "anyOf": [
@@ -2906,7 +3317,8 @@
2906
3317
  "const": "none"
2907
3318
  }
2908
3319
  ],
2909
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3320
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3321
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2910
3322
  }
2911
3323
  },
2912
3324
  "required": [
@@ -2914,32 +3326,37 @@
2914
3326
  "name",
2915
3327
  "widget"
2916
3328
  ],
2917
- "description": "Object field definition."
3329
+ "description": "Object field definition.",
3330
+ "markdownDescription": "Object field definition."
2918
3331
  },
2919
3332
  "RelationField": {
2920
3333
  "type": "object",
2921
- "additionalProperties": false,
2922
3334
  "properties": {
2923
3335
  "multiple": {
2924
3336
  "type": "boolean",
2925
- "description": "Whether to accept multiple values. Default: `false`."
3337
+ "description": "Whether to accept multiple values. Default: `false`.",
3338
+ "markdownDescription": "Whether to accept multiple values. Default: `false`."
2926
3339
  },
2927
3340
  "min": {
2928
3341
  "type": "number",
2929
- "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: 0."
3342
+ "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`.",
3343
+ "markdownDescription": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
2930
3344
  },
2931
3345
  "max": {
2932
3346
  "type": "number",
2933
- "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: infinity."
3347
+ "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`.",
3348
+ "markdownDescription": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
2934
3349
  },
2935
3350
  "dropdown_threshold": {
2936
3351
  "type": "number",
2937
- "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: 5."
3352
+ "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.",
3353
+ "markdownDescription": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
2938
3354
  },
2939
3355
  "widget": {
2940
3356
  "type": "string",
2941
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
2942
- "const": "relation"
3357
+ "const": "relation",
3358
+ "description": "Widget name.",
3359
+ "markdownDescription": "Widget name."
2943
3360
  },
2944
3361
  "default": {
2945
3362
  "anyOf": [
@@ -2949,15 +3366,18 @@
2949
3366
  "items": {}
2950
3367
  }
2951
3368
  ],
2952
- "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option."
3369
+ "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option.",
3370
+ "markdownDescription": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option."
2953
3371
  },
2954
3372
  "collection": {
2955
3373
  "type": "string",
2956
- "description": "Referenced collection name. Use `_singletons` for the singleton collection."
3374
+ "description": "Referenced collection name. Use `_singletons` for the singleton collection.",
3375
+ "markdownDescription": "Referenced collection name. Use `_singletons` for the singleton collection."
2957
3376
  },
2958
3377
  "file": {
2959
3378
  "type": "string",
2960
- "description": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined."
3379
+ "description": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined.",
3380
+ "markdownDescription": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined."
2961
3381
  },
2962
3382
  "value_field": {
2963
3383
  "anyOf": [
@@ -2968,7 +3388,8 @@
2968
3388
  "type": "string"
2969
3389
  }
2970
3390
  ],
2971
- "description": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`."
3391
+ "description": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`.",
3392
+ "markdownDescription": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`."
2972
3393
  },
2973
3394
  "display_fields": {
2974
3395
  "type": "array",
@@ -2982,33 +3403,24 @@
2982
3403
  }
2983
3404
  ]
2984
3405
  },
2985
- "description": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default."
3406
+ "description": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default.",
3407
+ "markdownDescription": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default."
2986
3408
  },
2987
3409
  "search_fields": {
2988
3410
  "type": "array",
2989
3411
  "items": {
2990
3412
  "$ref": "#/definitions/FieldKeyPath"
2991
3413
  },
2992
- "description": "Name of fields to be searched. Default: `display_fields` field value."
3414
+ "description": "Name of fields to be searched. Default: `display_fields` field value.",
3415
+ "markdownDescription": "Name of fields to be searched. Default: `display_fields` field value."
2993
3416
  },
2994
3417
  "filters": {
2995
3418
  "type": "array",
2996
3419
  "items": {
2997
3420
  "$ref": "#/definitions/RelationFieldFilterOptions"
2998
3421
  },
2999
- "description": "Entry filter options."
3000
- },
3001
- "name": {
3002
- "type": "string",
3003
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3004
- },
3005
- "label": {
3006
- "type": "string",
3007
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3008
- },
3009
- "comment": {
3010
- "type": "string",
3011
- "description": "Short description of the field to be displayed in the editor UI."
3422
+ "description": "Entry filter options.",
3423
+ "markdownDescription": "Entry filter options."
3012
3424
  },
3013
3425
  "required": {
3014
3426
  "anyOf": [
@@ -3022,11 +3434,13 @@
3022
3434
  }
3023
3435
  }
3024
3436
  ],
3025
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3437
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3438
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3026
3439
  },
3027
3440
  "readonly": {
3028
3441
  "type": "boolean",
3029
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3442
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3443
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3030
3444
  },
3031
3445
  "pattern": {
3032
3446
  "type": "array",
@@ -3048,15 +3462,33 @@
3048
3462
  }
3049
3463
  ],
3050
3464
  "maxItems": 2,
3051
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3465
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3466
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3467
+ },
3468
+ "name": {
3469
+ "type": "string",
3470
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3471
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3472
+ },
3473
+ "label": {
3474
+ "type": "string",
3475
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3476
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3477
+ },
3478
+ "comment": {
3479
+ "type": "string",
3480
+ "description": "Short description of the field to be displayed in the editor UI.",
3481
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3052
3482
  },
3053
3483
  "hint": {
3054
3484
  "type": "string",
3055
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3485
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3486
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3056
3487
  },
3057
3488
  "preview": {
3058
3489
  "type": "boolean",
3059
- "description": "Whether to show the preview of the field. Default: `true`."
3490
+ "description": "Whether to show the preview of the field. Default: `true`.",
3491
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3060
3492
  },
3061
3493
  "i18n": {
3062
3494
  "anyOf": [
@@ -3076,7 +3508,8 @@
3076
3508
  "const": "none"
3077
3509
  }
3078
3510
  ],
3079
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3511
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3512
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3080
3513
  }
3081
3514
  },
3082
3515
  "required": [
@@ -3084,19 +3517,22 @@
3084
3517
  "name",
3085
3518
  "widget"
3086
3519
  ],
3087
- "description": "Relation field definition."
3520
+ "description": "Relation field definition.",
3521
+ "markdownDescription": "Relation field definition."
3088
3522
  },
3089
3523
  "RelationFieldFilterOptions": {
3090
3524
  "type": "object",
3091
3525
  "properties": {
3092
3526
  "field": {
3093
3527
  "$ref": "#/definitions/FieldKeyPath",
3094
- "description": "Field name."
3528
+ "description": "Field name.",
3529
+ "markdownDescription": "Field name."
3095
3530
  },
3096
3531
  "values": {
3097
3532
  "type": "array",
3098
3533
  "items": {},
3099
- "description": "One or more values to be matched."
3534
+ "description": "One or more values to be matched.",
3535
+ "markdownDescription": "One or more values to be matched."
3100
3536
  }
3101
3537
  },
3102
3538
  "required": [
@@ -3104,32 +3540,37 @@
3104
3540
  "values"
3105
3541
  ],
3106
3542
  "additionalProperties": false,
3107
- "description": "Entry filter options for a Relation field."
3543
+ "description": "Entry filter options for a Relation field.",
3544
+ "markdownDescription": "Entry filter options for a Relation field."
3108
3545
  },
3109
3546
  "SelectField": {
3110
3547
  "type": "object",
3111
- "additionalProperties": false,
3112
3548
  "properties": {
3113
3549
  "multiple": {
3114
3550
  "type": "boolean",
3115
- "description": "Whether to accept multiple values. Default: `false`."
3551
+ "description": "Whether to accept multiple values. Default: `false`.",
3552
+ "markdownDescription": "Whether to accept multiple values. Default: `false`."
3116
3553
  },
3117
3554
  "min": {
3118
3555
  "type": "number",
3119
- "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: 0."
3556
+ "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`.",
3557
+ "markdownDescription": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
3120
3558
  },
3121
3559
  "max": {
3122
3560
  "type": "number",
3123
- "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: infinity."
3561
+ "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`.",
3562
+ "markdownDescription": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
3124
3563
  },
3125
3564
  "dropdown_threshold": {
3126
3565
  "type": "number",
3127
- "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: 5."
3566
+ "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.",
3567
+ "markdownDescription": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
3128
3568
  },
3129
3569
  "widget": {
3130
3570
  "type": "string",
3131
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
3132
- "const": "select"
3571
+ "const": "select",
3572
+ "description": "Widget name.",
3573
+ "markdownDescription": "Widget name."
3133
3574
  },
3134
3575
  "default": {
3135
3576
  "anyOf": [
@@ -3139,7 +3580,8 @@
3139
3580
  "items": {}
3140
3581
  }
3141
3582
  ],
3142
- "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option."
3583
+ "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option.",
3584
+ "markdownDescription": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option."
3143
3585
  },
3144
3586
  "options": {
3145
3587
  "anyOf": [
@@ -3169,19 +3611,8 @@
3169
3611
  }
3170
3612
  }
3171
3613
  ],
3172
- "description": "Options."
3173
- },
3174
- "name": {
3175
- "type": "string",
3176
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3177
- },
3178
- "label": {
3179
- "type": "string",
3180
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3181
- },
3182
- "comment": {
3183
- "type": "string",
3184
- "description": "Short description of the field to be displayed in the editor UI."
3614
+ "description": "Options.",
3615
+ "markdownDescription": "Options."
3185
3616
  },
3186
3617
  "required": {
3187
3618
  "anyOf": [
@@ -3195,11 +3626,13 @@
3195
3626
  }
3196
3627
  }
3197
3628
  ],
3198
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3629
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3630
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3199
3631
  },
3200
3632
  "readonly": {
3201
3633
  "type": "boolean",
3202
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3634
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3635
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3203
3636
  },
3204
3637
  "pattern": {
3205
3638
  "type": "array",
@@ -3221,15 +3654,33 @@
3221
3654
  }
3222
3655
  ],
3223
3656
  "maxItems": 2,
3224
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3657
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3658
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3659
+ },
3660
+ "name": {
3661
+ "type": "string",
3662
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3663
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3664
+ },
3665
+ "label": {
3666
+ "type": "string",
3667
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3668
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3669
+ },
3670
+ "comment": {
3671
+ "type": "string",
3672
+ "description": "Short description of the field to be displayed in the editor UI.",
3673
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3225
3674
  },
3226
3675
  "hint": {
3227
3676
  "type": "string",
3228
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3677
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3678
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3229
3679
  },
3230
3680
  "preview": {
3231
3681
  "type": "boolean",
3232
- "description": "Whether to show the preview of the field. Default: `true`."
3682
+ "description": "Whether to show the preview of the field. Default: `true`.",
3683
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3233
3684
  },
3234
3685
  "i18n": {
3235
3686
  "anyOf": [
@@ -3249,7 +3700,8 @@
3249
3700
  "const": "none"
3250
3701
  }
3251
3702
  ],
3252
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3703
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3704
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3253
3705
  }
3254
3706
  },
3255
3707
  "required": [
@@ -3257,36 +3709,42 @@
3257
3709
  "options",
3258
3710
  "widget"
3259
3711
  ],
3260
- "description": "Select field definition."
3712
+ "description": "Select field definition.",
3713
+ "markdownDescription": "Select field definition."
3261
3714
  },
3262
3715
  "StringField": {
3263
3716
  "type": "object",
3264
- "additionalProperties": false,
3265
3717
  "properties": {
3266
3718
  "minlength": {
3267
3719
  "type": "number",
3268
- "description": "Minimum number of characters that can be entered in the input. Default: 0."
3720
+ "description": "Minimum number of characters that can be entered in the input. Default: `0`.",
3721
+ "markdownDescription": "Minimum number of characters that can be entered in the input. Default: `0`."
3269
3722
  },
3270
3723
  "maxlength": {
3271
3724
  "type": "number",
3272
- "description": "Maximum number of characters that can be entered in the input. Default: infinity."
3725
+ "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`.",
3726
+ "markdownDescription": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3273
3727
  },
3274
3728
  "before_input": {
3275
3729
  "type": "string",
3276
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3730
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
3731
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3277
3732
  },
3278
3733
  "after_input": {
3279
3734
  "type": "string",
3280
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3735
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
3736
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3281
3737
  },
3282
3738
  "widget": {
3283
3739
  "type": "string",
3284
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
3285
- "const": "string"
3740
+ "const": "string",
3741
+ "description": "Widget name.",
3742
+ "markdownDescription": "Widget name."
3286
3743
  },
3287
3744
  "default": {
3288
3745
  "type": "string",
3289
- "description": "Default value."
3746
+ "description": "Default value.",
3747
+ "markdownDescription": "Default value."
3290
3748
  },
3291
3749
  "type": {
3292
3750
  "type": "string",
@@ -3295,27 +3753,18 @@
3295
3753
  "url",
3296
3754
  "email"
3297
3755
  ],
3298
- "description": "Data type. It’s useful when the input value needs a validation. Default: text."
3756
+ "description": "Data type. It’s useful when the input value needs a validation. Default: `text`.",
3757
+ "markdownDescription": "Data type. It’s useful when the input value needs a validation. Default: `text`."
3299
3758
  },
3300
3759
  "prefix": {
3301
3760
  "type": "string",
3302
- "description": "A string to be prepended to the value. Default: empty string."
3761
+ "description": "A string to be prepended to the value. Default: empty string.",
3762
+ "markdownDescription": "A string to be prepended to the value. Default: empty string."
3303
3763
  },
3304
3764
  "suffix": {
3305
3765
  "type": "string",
3306
- "description": "A string to be appended to the value. Default: empty string."
3307
- },
3308
- "name": {
3309
- "type": "string",
3310
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3311
- },
3312
- "label": {
3313
- "type": "string",
3314
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3315
- },
3316
- "comment": {
3317
- "type": "string",
3318
- "description": "Short description of the field to be displayed in the editor UI."
3766
+ "description": "A string to be appended to the value. Default: empty string.",
3767
+ "markdownDescription": "A string to be appended to the value. Default: empty string."
3319
3768
  },
3320
3769
  "required": {
3321
3770
  "anyOf": [
@@ -3329,11 +3778,13 @@
3329
3778
  }
3330
3779
  }
3331
3780
  ],
3332
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3781
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3782
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3333
3783
  },
3334
3784
  "readonly": {
3335
3785
  "type": "boolean",
3336
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3786
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3787
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3337
3788
  },
3338
3789
  "pattern": {
3339
3790
  "type": "array",
@@ -3355,15 +3806,33 @@
3355
3806
  }
3356
3807
  ],
3357
3808
  "maxItems": 2,
3358
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3809
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3810
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3811
+ },
3812
+ "name": {
3813
+ "type": "string",
3814
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3815
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3816
+ },
3817
+ "label": {
3818
+ "type": "string",
3819
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3820
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3821
+ },
3822
+ "comment": {
3823
+ "type": "string",
3824
+ "description": "Short description of the field to be displayed in the editor UI.",
3825
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3359
3826
  },
3360
3827
  "hint": {
3361
3828
  "type": "string",
3362
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3829
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3830
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3363
3831
  },
3364
3832
  "preview": {
3365
3833
  "type": "boolean",
3366
- "description": "Whether to show the preview of the field. Default: `true`."
3834
+ "description": "Whether to show the preview of the field. Default: `true`.",
3835
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3367
3836
  },
3368
3837
  "i18n": {
3369
3838
  "anyOf": [
@@ -3383,47 +3852,39 @@
3383
3852
  "const": "none"
3384
3853
  }
3385
3854
  ],
3386
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3855
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3856
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3387
3857
  }
3388
3858
  },
3389
3859
  "required": [
3390
- "name",
3391
- "widget"
3860
+ "name"
3392
3861
  ],
3393
- "description": "String field definition."
3862
+ "description": "String field definition.",
3863
+ "markdownDescription": "String field definition."
3394
3864
  },
3395
3865
  "TextField": {
3396
3866
  "type": "object",
3397
- "additionalProperties": false,
3398
3867
  "properties": {
3399
3868
  "minlength": {
3400
3869
  "type": "number",
3401
- "description": "Minimum number of characters that can be entered in the input. Default: 0."
3870
+ "description": "Minimum number of characters that can be entered in the input. Default: `0`.",
3871
+ "markdownDescription": "Minimum number of characters that can be entered in the input. Default: `0`."
3402
3872
  },
3403
3873
  "maxlength": {
3404
3874
  "type": "number",
3405
- "description": "Maximum number of characters that can be entered in the input. Default: infinity."
3875
+ "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`.",
3876
+ "markdownDescription": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3406
3877
  },
3407
3878
  "widget": {
3408
3879
  "type": "string",
3409
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
3410
- "const": "text"
3880
+ "const": "text",
3881
+ "description": "Widget name.",
3882
+ "markdownDescription": "Widget name."
3411
3883
  },
3412
3884
  "default": {
3413
3885
  "type": "string",
3414
- "description": "Default value."
3415
- },
3416
- "name": {
3417
- "type": "string",
3418
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3419
- },
3420
- "label": {
3421
- "type": "string",
3422
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3423
- },
3424
- "comment": {
3425
- "type": "string",
3426
- "description": "Short description of the field to be displayed in the editor UI."
3886
+ "description": "Default value.",
3887
+ "markdownDescription": "Default value."
3427
3888
  },
3428
3889
  "required": {
3429
3890
  "anyOf": [
@@ -3437,11 +3898,13 @@
3437
3898
  }
3438
3899
  }
3439
3900
  ],
3440
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3901
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3902
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3441
3903
  },
3442
3904
  "readonly": {
3443
3905
  "type": "boolean",
3444
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3906
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3907
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3445
3908
  },
3446
3909
  "pattern": {
3447
3910
  "type": "array",
@@ -3463,15 +3926,33 @@
3463
3926
  }
3464
3927
  ],
3465
3928
  "maxItems": 2,
3466
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3929
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3930
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3931
+ },
3932
+ "name": {
3933
+ "type": "string",
3934
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3935
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3936
+ },
3937
+ "label": {
3938
+ "type": "string",
3939
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3940
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3941
+ },
3942
+ "comment": {
3943
+ "type": "string",
3944
+ "description": "Short description of the field to be displayed in the editor UI.",
3945
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3467
3946
  },
3468
3947
  "hint": {
3469
3948
  "type": "string",
3470
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3949
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3950
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3471
3951
  },
3472
3952
  "preview": {
3473
3953
  "type": "boolean",
3474
- "description": "Whether to show the preview of the field. Default: `true`."
3954
+ "description": "Whether to show the preview of the field. Default: `true`.",
3955
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3475
3956
  },
3476
3957
  "i18n": {
3477
3958
  "anyOf": [
@@ -3491,51 +3972,45 @@
3491
3972
  "const": "none"
3492
3973
  }
3493
3974
  ],
3494
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3975
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3976
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3495
3977
  }
3496
3978
  },
3497
3979
  "required": [
3498
3980
  "name",
3499
3981
  "widget"
3500
3982
  ],
3501
- "description": "Text field definition."
3983
+ "description": "Text field definition.",
3984
+ "markdownDescription": "Text field definition."
3502
3985
  },
3503
3986
  "UuidField": {
3504
3987
  "type": "object",
3505
- "additionalProperties": false,
3506
3988
  "properties": {
3507
3989
  "widget": {
3508
3990
  "type": "string",
3509
- "description": "Name of a widget that defines the input UI and data type. Default: `string`.",
3510
- "const": "uuid"
3991
+ "const": "uuid",
3992
+ "description": "Widget name.",
3993
+ "markdownDescription": "Widget name."
3511
3994
  },
3512
3995
  "default": {
3513
3996
  "type": "string",
3514
- "description": "Default value."
3997
+ "description": "Default value.",
3998
+ "markdownDescription": "Default value."
3515
3999
  },
3516
4000
  "prefix": {
3517
4001
  "type": "string",
3518
- "description": "A string to be prepended to the value. Default: empty string."
4002
+ "description": "A string to be prepended to the value. Default: empty string.",
4003
+ "markdownDescription": "A string to be prepended to the value. Default: empty string."
3519
4004
  },
3520
4005
  "use_b32_encoding": {
3521
4006
  "type": "boolean",
3522
- "description": "Whether to encode the value with Base32. Default: `false`."
4007
+ "description": "Whether to encode the value with Base32. Default: `false`.",
4008
+ "markdownDescription": "Whether to encode the value with Base32. Default: `false`."
3523
4009
  },
3524
4010
  "read_only": {
3525
4011
  "type": "boolean",
3526
- "description": "Whether to make the field read-only. Default: `true`."
3527
- },
3528
- "name": {
3529
- "type": "string",
3530
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3531
- },
3532
- "label": {
3533
- "type": "string",
3534
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3535
- },
3536
- "comment": {
3537
- "type": "string",
3538
- "description": "Short description of the field to be displayed in the editor UI."
4012
+ "description": "Whether to make the field read-only. Default: `true`.",
4013
+ "markdownDescription": "Whether to make the field read-only. Default: `true`."
3539
4014
  },
3540
4015
  "required": {
3541
4016
  "anyOf": [
@@ -3549,11 +4024,13 @@
3549
4024
  }
3550
4025
  }
3551
4026
  ],
3552
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
4027
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
4028
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3553
4029
  },
3554
4030
  "readonly": {
3555
4031
  "type": "boolean",
3556
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
4032
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
4033
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3557
4034
  },
3558
4035
  "pattern": {
3559
4036
  "type": "array",
@@ -3575,15 +4052,33 @@
3575
4052
  }
3576
4053
  ],
3577
4054
  "maxItems": 2,
3578
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
4055
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
4056
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
4057
+ },
4058
+ "name": {
4059
+ "type": "string",
4060
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
4061
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
4062
+ },
4063
+ "label": {
4064
+ "type": "string",
4065
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
4066
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
4067
+ },
4068
+ "comment": {
4069
+ "type": "string",
4070
+ "description": "Short description of the field to be displayed in the editor UI.",
4071
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3579
4072
  },
3580
4073
  "hint": {
3581
4074
  "type": "string",
3582
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
4075
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
4076
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3583
4077
  },
3584
4078
  "preview": {
3585
4079
  "type": "boolean",
3586
- "description": "Whether to show the preview of the field. Default: `true`."
4080
+ "description": "Whether to show the preview of the field. Default: `true`.",
4081
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3587
4082
  },
3588
4083
  "i18n": {
3589
4084
  "anyOf": [
@@ -3603,81 +4098,49 @@
3603
4098
  "const": "none"
3604
4099
  }
3605
4100
  ],
3606
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
4101
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
4102
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3607
4103
  }
3608
4104
  },
3609
4105
  "required": [
3610
4106
  "name",
3611
4107
  "widget"
3612
4108
  ],
3613
- "description": "UUID field definition."
4109
+ "description": "UUID field definition.",
4110
+ "markdownDescription": "UUID field definition."
3614
4111
  },
3615
4112
  "CustomField": {
3616
4113
  "type": "object",
3617
4114
  "properties": {
4115
+ "widget": {
4116
+ "type": "string",
4117
+ "description": "Widget name.",
4118
+ "markdownDescription": "Widget name."
4119
+ },
3618
4120
  "name": {
3619
4121
  "type": "string",
3620
- "description": "Unique identifier for the field. It cannot include periods and spaces."
4122
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
4123
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3621
4124
  },
3622
4125
  "label": {
3623
4126
  "type": "string",
3624
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
4127
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
4128
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3625
4129
  },
3626
4130
  "comment": {
3627
4131
  "type": "string",
3628
- "description": "Short description of the field to be displayed in the editor UI."
3629
- },
3630
- "widget": {
3631
- "type": "string",
3632
- "description": "Name of a widget that defines the input UI and data type. Default: `string`."
3633
- },
3634
- "required": {
3635
- "anyOf": [
3636
- {
3637
- "type": "boolean"
3638
- },
3639
- {
3640
- "type": "array",
3641
- "items": {
3642
- "$ref": "#/definitions/LocaleCode"
3643
- }
3644
- }
3645
- ],
3646
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3647
- },
3648
- "readonly": {
3649
- "type": "boolean",
3650
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3651
- },
3652
- "pattern": {
3653
- "type": "array",
3654
- "minItems": 2,
3655
- "items": [
3656
- {
3657
- "anyOf": [
3658
- {
3659
- "type": "string"
3660
- },
3661
- {
3662
- "type": "string",
3663
- "format": "regex"
3664
- }
3665
- ]
3666
- },
3667
- {
3668
- "type": "string"
3669
- }
3670
- ],
3671
- "maxItems": 2,
3672
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
4132
+ "description": "Short description of the field to be displayed in the editor UI.",
4133
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3673
4134
  },
3674
4135
  "hint": {
3675
4136
  "type": "string",
3676
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
4137
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
4138
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3677
4139
  },
3678
4140
  "preview": {
3679
4141
  "type": "boolean",
3680
- "description": "Whether to show the preview of the field. Default: `true`."
4142
+ "description": "Whether to show the preview of the field. Default: `true`.",
4143
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3681
4144
  },
3682
4145
  "i18n": {
3683
4146
  "anyOf": [
@@ -3697,13 +4160,16 @@
3697
4160
  "const": "none"
3698
4161
  }
3699
4162
  ],
3700
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
4163
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
4164
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3701
4165
  }
3702
4166
  },
3703
4167
  "required": [
3704
- "name"
4168
+ "name",
4169
+ "widget"
3705
4170
  ],
3706
- "description": "Entry field using a custom widget. It can contain any properties."
4171
+ "description": "Entry field using a custom widget.",
4172
+ "markdownDescription": "Entry field using a custom widget."
3707
4173
  },
3708
4174
  "FileFormat": {
3709
4175
  "anyOf": [
@@ -3731,7 +4197,8 @@
3731
4197
  "$ref": "#/definitions/FrontMatterFormat"
3732
4198
  }
3733
4199
  ],
3734
- "description": "Supported file format."
4200
+ "description": "Supported file format.",
4201
+ "markdownDescription": "Supported file format."
3735
4202
  },
3736
4203
  "FrontMatterFormat": {
3737
4204
  "type": "string",
@@ -3740,25 +4207,29 @@
3740
4207
  "toml-frontmatter",
3741
4208
  "json-frontmatter"
3742
4209
  ],
3743
- "description": "Supported Markdown front matter format."
4210
+ "description": "Supported Markdown front matter format.",
4211
+ "markdownDescription": "Supported Markdown front matter format."
3744
4212
  },
3745
4213
  "I18nOptions": {
3746
4214
  "type": "object",
3747
4215
  "properties": {
3748
4216
  "structure": {
3749
4217
  "$ref": "#/definitions/I18nFileStructure",
3750
- "description": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option."
4218
+ "description": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option.",
4219
+ "markdownDescription": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option."
3751
4220
  },
3752
4221
  "locales": {
3753
4222
  "type": "array",
3754
4223
  "items": {
3755
4224
  "$ref": "#/definitions/LocaleCode"
3756
4225
  },
3757
- "description": "List of all available locales."
4226
+ "description": "List of all available locales.",
4227
+ "markdownDescription": "List of all available locales."
3758
4228
  },
3759
4229
  "default_locale": {
3760
4230
  "$ref": "#/definitions/LocaleCode",
3761
- "description": "Default locale. Default: first locale in the `locales` option."
4231
+ "description": "Default locale. Default: first locale in the `locales` option.",
4232
+ "markdownDescription": "Default locale. Default: first locale in the `locales` option."
3762
4233
  },
3763
4234
  "initial_locales": {
3764
4235
  "anyOf": [
@@ -3777,11 +4248,13 @@
3777
4248
  "const": "default"
3778
4249
  }
3779
4250
  ],
3780
- "description": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details."
4251
+ "description": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details.",
4252
+ "markdownDescription": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details."
3781
4253
  },
3782
4254
  "save_all_locales": {
3783
4255
  "type": "boolean",
3784
- "description": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details."
4256
+ "description": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details.",
4257
+ "markdownDescription": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details."
3785
4258
  },
3786
4259
  "canonical_slug": {
3787
4260
  "type": "object",
@@ -3798,11 +4271,13 @@
3798
4271
  "value"
3799
4272
  ],
3800
4273
  "additionalProperties": false,
3801
- "description": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See https://github.com/sveltia/sveltia-cms#localizing-entry-slugs for details."
4274
+ "description": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See our [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details.",
4275
+ "markdownDescription": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See our [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details."
3802
4276
  },
3803
4277
  "omit_default_locale_from_filename": {
3804
4278
  "type": "boolean",
3805
- "description": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support Zola’s multilingual sites: https://www.getzola.org/documentation/content/multilingual/."
4279
+ "description": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support [Zola’s multilingual sites](https://www.getzola.org/documentation/content/multilingual/).",
4280
+ "markdownDescription": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support [Zola’s multilingual sites](https://www.getzola.org/documentation/content/multilingual/)."
3806
4281
  }
3807
4282
  },
3808
4283
  "required": [
@@ -3810,7 +4285,8 @@
3810
4285
  "locales"
3811
4286
  ],
3812
4287
  "additionalProperties": false,
3813
- "description": "Global, collection-level or collection file-level i18n options."
4288
+ "description": "Global, collection-level or collection file-level i18n options.",
4289
+ "markdownDescription": "Global, collection-level or collection file-level i18n options."
3814
4290
  },
3815
4291
  "I18nFileStructure": {
3816
4292
  "type": "string",
@@ -3820,14 +4296,16 @@
3820
4296
  "multiple_folders",
3821
4297
  "multiple_folders_i18n_root"
3822
4298
  ],
3823
- "description": "Internationalization (i18n) file structure type."
4299
+ "description": "Internationalization (i18n) file structure type.",
4300
+ "markdownDescription": "Internationalization (i18n) file structure type."
3824
4301
  },
3825
4302
  "CollectionFilter": {
3826
4303
  "type": "object",
3827
4304
  "properties": {
3828
4305
  "field": {
3829
4306
  "$ref": "#/definitions/FieldKeyPath",
3830
- "description": "Field name."
4307
+ "description": "Field name.",
4308
+ "markdownDescription": "Field name."
3831
4309
  },
3832
4310
  "value": {
3833
4311
  "anyOf": [
@@ -3837,7 +4315,8 @@
3837
4315
  "items": {}
3838
4316
  }
3839
4317
  ],
3840
- "description": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required."
4318
+ "description": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required.",
4319
+ "markdownDescription": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required."
3841
4320
  },
3842
4321
  "pattern": {
3843
4322
  "anyOf": [
@@ -3849,18 +4328,21 @@
3849
4328
  "format": "regex"
3850
4329
  }
3851
4330
  ],
3852
- "description": "Regular expression matching pattern."
4331
+ "description": "Regular expression matching pattern.",
4332
+ "markdownDescription": "Regular expression matching pattern."
3853
4333
  }
3854
4334
  },
3855
4335
  "required": [
3856
4336
  "field"
3857
4337
  ],
3858
4338
  "additionalProperties": false,
3859
- "description": "Collection filter options."
4339
+ "description": "Collection filter options.",
4340
+ "markdownDescription": "Collection filter options."
3860
4341
  },
3861
4342
  "FileExtension": {
3862
4343
  "type": "string",
3863
- "description": "Supported file extension."
4344
+ "description": "Supported file extension. Actually it can be any string.",
4345
+ "markdownDescription": "Supported file extension. Actually it can be any string."
3864
4346
  },
3865
4347
  "SortableFields": {
3866
4348
  "type": "object",
@@ -3870,25 +4352,29 @@
3870
4352
  "items": {
3871
4353
  "$ref": "#/definitions/FieldKeyPath"
3872
4354
  },
3873
- "description": "A list of sortable field names."
4355
+ "description": "A list of sortable field names.",
4356
+ "markdownDescription": "A list of sortable field names."
3874
4357
  },
3875
4358
  "default": {
3876
4359
  "$ref": "#/definitions/SortableFieldsDefaultOptions",
3877
- "description": "Default sort settings. See https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction for details."
4360
+ "description": "Default sort settings. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details.",
4361
+ "markdownDescription": "Default sort settings. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details."
3878
4362
  }
3879
4363
  },
3880
4364
  "required": [
3881
4365
  "fields"
3882
4366
  ],
3883
4367
  "additionalProperties": false,
3884
- "description": "A collection’s advanced sortable fields definition, which is compatible with Static CMS."
4368
+ "description": "A collection’s advanced sortable fields definition, which is compatible with Static CMS.",
4369
+ "markdownDescription": "A collection’s advanced sortable fields definition, which is compatible with Static CMS."
3885
4370
  },
3886
4371
  "SortableFieldsDefaultOptions": {
3887
4372
  "type": "object",
3888
4373
  "properties": {
3889
4374
  "field": {
3890
4375
  "$ref": "#/definitions/FieldKeyPath",
3891
- "description": "A field name to be sorted by default."
4376
+ "description": "A field name to be sorted by default.",
4377
+ "markdownDescription": "A field name to be sorted by default."
3892
4378
  },
3893
4379
  "direction": {
3894
4380
  "type": "string",
@@ -3899,25 +4385,29 @@
3899
4385
  "Descending",
3900
4386
  "None"
3901
4387
  ],
3902
- "description": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`."
4388
+ "description": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`.",
4389
+ "markdownDescription": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`."
3903
4390
  }
3904
4391
  },
3905
4392
  "required": [
3906
4393
  "field"
3907
4394
  ],
3908
4395
  "additionalProperties": false,
3909
- "description": "The default options for the sortable fields."
4396
+ "description": "The default options for the sortable fields.",
4397
+ "markdownDescription": "The default options for the sortable fields."
3910
4398
  },
3911
4399
  "ViewFilter": {
3912
4400
  "type": "object",
3913
4401
  "properties": {
3914
4402
  "label": {
3915
4403
  "type": "string",
3916
- "description": "Label."
4404
+ "description": "Label.",
4405
+ "markdownDescription": "Label."
3917
4406
  },
3918
4407
  "field": {
3919
4408
  "$ref": "#/definitions/FieldKeyPath",
3920
- "description": "Field name."
4409
+ "description": "Field name.",
4410
+ "markdownDescription": "Field name."
3921
4411
  },
3922
4412
  "pattern": {
3923
4413
  "anyOf": [
@@ -3932,7 +4422,8 @@
3932
4422
  "type": "boolean"
3933
4423
  }
3934
4424
  ],
3935
- "description": "Regular expression matching pattern or exact value."
4425
+ "description": "Regular expression matching pattern or exact value.",
4426
+ "markdownDescription": "Regular expression matching pattern or exact value."
3936
4427
  }
3937
4428
  },
3938
4429
  "required": [
@@ -3941,18 +4432,21 @@
3941
4432
  "pattern"
3942
4433
  ],
3943
4434
  "additionalProperties": false,
3944
- "description": "View filter."
4435
+ "description": "View filter.",
4436
+ "markdownDescription": "View filter."
3945
4437
  },
3946
4438
  "ViewGroup": {
3947
4439
  "type": "object",
3948
4440
  "properties": {
3949
4441
  "label": {
3950
4442
  "type": "string",
3951
- "description": "Label."
4443
+ "description": "Label.",
4444
+ "markdownDescription": "Label."
3952
4445
  },
3953
4446
  "field": {
3954
4447
  "$ref": "#/definitions/FieldKeyPath",
3955
- "description": "Field name."
4448
+ "description": "Field name.",
4449
+ "markdownDescription": "Field name."
3956
4450
  },
3957
4451
  "pattern": {
3958
4452
  "anyOf": [
@@ -3967,7 +4461,8 @@
3967
4461
  "type": "boolean"
3968
4462
  }
3969
4463
  ],
3970
- "description": "Regular expression matching pattern or exact value."
4464
+ "description": "Regular expression matching pattern or exact value.",
4465
+ "markdownDescription": "Regular expression matching pattern or exact value."
3971
4466
  }
3972
4467
  },
3973
4468
  "required": [
@@ -3976,47 +4471,55 @@
3976
4471
  "pattern"
3977
4472
  ],
3978
4473
  "additionalProperties": false,
3979
- "description": "View group."
4474
+ "description": "View group.",
4475
+ "markdownDescription": "View group."
3980
4476
  },
3981
4477
  "EditorOptions": {
3982
4478
  "type": "object",
3983
4479
  "properties": {
3984
4480
  "preview": {
3985
4481
  "type": "boolean",
3986
- "description": "Whether to show the preview pane. Default: `true`."
4482
+ "description": "Whether to show the preview pane. Default: `true`.",
4483
+ "markdownDescription": "Whether to show the preview pane. Default: `true`."
3987
4484
  }
3988
4485
  },
3989
4486
  "required": [
3990
4487
  "preview"
3991
4488
  ],
3992
4489
  "additionalProperties": false,
3993
- "description": "Editor options."
4490
+ "description": "Editor options.",
4491
+ "markdownDescription": "Editor options."
3994
4492
  },
3995
4493
  "NestedCollectionOptions": {
3996
4494
  "type": "object",
3997
4495
  "properties": {
3998
4496
  "depth": {
3999
4497
  "type": "number",
4000
- "description": "Maximum depth to show nested items in the collection tree. Default: infinity."
4498
+ "description": "Maximum depth to show nested items in the collection tree. Default: `Infinity`.",
4499
+ "markdownDescription": "Maximum depth to show nested items in the collection tree. Default: `Infinity`."
4001
4500
  },
4002
4501
  "summary": {
4003
4502
  "type": "string",
4004
- "description": "Summary template for a tree item. Default: `{{title}}`."
4503
+ "description": "Summary template for a tree item. Default: `{{title}}`.",
4504
+ "markdownDescription": "Summary template for a tree item. Default: `{{title}}`."
4005
4505
  }
4006
4506
  },
4007
4507
  "additionalProperties": false,
4008
- "description": "Nested collection options."
4508
+ "description": "Nested collection options.",
4509
+ "markdownDescription": "Nested collection options."
4009
4510
  },
4010
4511
  "CollectionMetaData": {
4011
4512
  "type": "object",
4012
4513
  "properties": {
4013
4514
  "path": {
4014
4515
  "$ref": "#/definitions/CollectionMetaDataPath",
4015
- "description": "Entry path options."
4516
+ "description": "Entry path options.",
4517
+ "markdownDescription": "Entry path options."
4016
4518
  }
4017
4519
  },
4018
4520
  "additionalProperties": false,
4019
- "description": "Collection meta data."
4521
+ "description": "Collection meta data.",
4522
+ "markdownDescription": "Collection meta data."
4020
4523
  },
4021
4524
  "CollectionMetaDataPath": {
4022
4525
  "type": "object",
@@ -4024,72 +4527,108 @@
4024
4527
  "widget": {
4025
4528
  "type": "string",
4026
4529
  "const": "string",
4027
- "description": "Widget for editing the path name."
4530
+ "description": "Widget for editing the path name.",
4531
+ "markdownDescription": "Widget for editing the path name."
4028
4532
  },
4029
4533
  "label": {
4030
4534
  "type": "string",
4031
- "description": "Label for the path editor."
4535
+ "description": "Label for the path editor.",
4536
+ "markdownDescription": "Label for the path editor."
4032
4537
  },
4033
4538
  "index_file": {
4034
4539
  "type": "string",
4035
- "description": "Index file name to be used."
4540
+ "description": "Index file name to be used.",
4541
+ "markdownDescription": "Index file name to be used."
4036
4542
  }
4037
4543
  },
4038
4544
  "additionalProperties": false,
4039
- "description": "Collection meta data’s path options."
4545
+ "description": "Collection meta data’s path options.",
4546
+ "markdownDescription": "Collection meta data’s path options."
4040
4547
  },
4041
4548
  "CollectionIndexFile": {
4042
4549
  "type": "object",
4043
4550
  "properties": {
4044
4551
  "name": {
4045
4552
  "type": "string",
4046
- "description": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file."
4553
+ "description": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file.",
4554
+ "markdownDescription": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file."
4047
4555
  },
4048
4556
  "label": {
4049
4557
  "type": "string",
4050
- "description": "Label to be displayed in the editor UI. Default: Index File or its localized version."
4558
+ "description": "Label to be displayed in the editor UI. Default: Index File or its localized version.",
4559
+ "markdownDescription": "Label to be displayed in the editor UI. Default: Index File or its localized version."
4051
4560
  },
4052
4561
  "icon": {
4053
4562
  "type": "string",
4054
- "description": "Name of a Material Symbols icon to be displayed in the editor UI. Default: `home`."
4563
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI. Default: `home`.",
4564
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI. Default: `home`."
4055
4565
  },
4056
4566
  "fields": {
4057
4567
  "type": "array",
4058
4568
  "items": {
4059
4569
  "$ref": "#/definitions/Field"
4060
4570
  },
4061
- "description": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead."
4571
+ "description": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead.",
4572
+ "markdownDescription": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead."
4062
4573
  },
4063
4574
  "editor": {
4064
4575
  "$ref": "#/definitions/EditorOptions",
4065
- "description": "Editor view options."
4576
+ "description": "Editor view options.",
4577
+ "markdownDescription": "Editor view options."
4066
4578
  }
4067
4579
  },
4068
4580
  "additionalProperties": false,
4069
- "description": "Index file inclusion options."
4581
+ "description": "Index file inclusion options. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details.",
4582
+ "markdownDescription": "Index file inclusion options. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details."
4583
+ },
4584
+ "CollectionDivider": {
4585
+ "type": "object",
4586
+ "properties": {
4587
+ "name": {
4588
+ "type": "string",
4589
+ "description": "Unique identifier for the divider. Can be omitted, but it must be unique across all the collections and singletons. This property is included here because in the previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option set to `true`, and the `name` option was required.",
4590
+ "markdownDescription": "Unique identifier for the divider. Can be omitted, but it must be unique across all the collections and singletons. This property is included here because in the previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option set to `true`, and the `name` option was required."
4591
+ },
4592
+ "divider": {
4593
+ "type": "boolean",
4594
+ "description": "Whether to make this collection a divider UI in the collection list. It must be `true` to be used as a divider.",
4595
+ "markdownDescription": "Whether to make this collection a divider UI in the collection list. It must be `true` to be used as a divider."
4596
+ }
4597
+ },
4598
+ "required": [
4599
+ "divider"
4600
+ ],
4601
+ "additionalProperties": false,
4602
+ "description": "A divider in the collection list and singleton list. See our [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for details.",
4603
+ "markdownDescription": "A divider in the collection list and singleton list. See our [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for details."
4070
4604
  },
4071
4605
  "OutputOptions": {
4072
4606
  "type": "object",
4073
4607
  "properties": {
4074
4608
  "omit_empty_optional_fields": {
4075
4609
  "type": "boolean",
4076
- "description": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`."
4610
+ "description": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`.",
4611
+ "markdownDescription": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`."
4077
4612
  },
4078
4613
  "encode_file_path": {
4079
4614
  "type": "boolean",
4080
- "description": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code."
4615
+ "description": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code.",
4616
+ "markdownDescription": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code."
4081
4617
  },
4082
4618
  "json": {
4083
4619
  "$ref": "#/definitions/JsonFormatOptions",
4084
- "description": "JSON format options."
4620
+ "description": "JSON format options.",
4621
+ "markdownDescription": "JSON format options."
4085
4622
  },
4086
4623
  "yaml": {
4087
4624
  "$ref": "#/definitions/YamlFormatOptions",
4088
- "description": "YAML format options."
4625
+ "description": "YAML format options.",
4626
+ "markdownDescription": "YAML format options."
4089
4627
  }
4090
4628
  },
4091
4629
  "additionalProperties": false,
4092
- "description": "Data output options."
4630
+ "description": "Data output options.",
4631
+ "markdownDescription": "Data output options."
4093
4632
  },
4094
4633
  "JsonFormatOptions": {
4095
4634
  "type": "object",
@@ -4100,22 +4639,26 @@
4100
4639
  "space",
4101
4640
  "tab"
4102
4641
  ],
4103
- "description": "Indent style. Default: 'space'."
4642
+ "description": "Indent style. Default: 'space'.",
4643
+ "markdownDescription": "Indent style. Default: 'space'."
4104
4644
  },
4105
4645
  "indent_size": {
4106
4646
  "type": "number",
4107
- "description": "Indent size. Default: 2."
4647
+ "description": "Indent size. Default: `2`.",
4648
+ "markdownDescription": "Indent size. Default: `2`."
4108
4649
  }
4109
4650
  },
4110
4651
  "additionalProperties": false,
4111
- "description": "JSON format options."
4652
+ "description": "JSON format options.",
4653
+ "markdownDescription": "JSON format options."
4112
4654
  },
4113
4655
  "YamlFormatOptions": {
4114
4656
  "type": "object",
4115
4657
  "properties": {
4116
4658
  "indent_size": {
4117
4659
  "type": "number",
4118
- "description": "Indent size. Default: 2."
4660
+ "description": "Indent size. Default: `2`.",
4661
+ "markdownDescription": "Indent size. Default: `2`."
4119
4662
  },
4120
4663
  "quote": {
4121
4664
  "type": "string",
@@ -4124,11 +4667,13 @@
4124
4667
  "single",
4125
4668
  "double"
4126
4669
  ],
4127
- "description": "String value’s default quote type. Default: 'none'."
4670
+ "description": "String value’s default quote type. Default: 'none'.",
4671
+ "markdownDescription": "String value’s default quote type. Default: 'none'."
4128
4672
  }
4129
4673
  },
4130
4674
  "additionalProperties": false,
4131
- "description": "YAML format options."
4675
+ "description": "YAML format options.",
4676
+ "markdownDescription": "YAML format options."
4132
4677
  }
4133
4678
  },
4134
4679
  "title": "Sveltia CMS Configuration",