Showing:

Annotations
Diagram
Properties
Constraints
Enumerations
Compositions
Used By
Source
Main Schema
Properties
Definitions
Main Schema Netlify.jschema
Document version http://json-schema.org/draft-07/schema#
Annotations
Title  Netlify config schema

Description  Config file for Netlify CMS
Diagram
Type object
Properties
Name Occurrence
backend
local_backend
publish_mode
media_folder
public_folder
media_library
site_url
display_url
logo_url
locale
show_preview_links
slug
collections
editor
summary
sortableFields
view_filters
required
optional
optional
required
optional
optional
optional
optional
optional
optional
optional
optional
required
optional
optional
optional
optional
Additional Properties true
Source

{
  "type": "object",
  "title": "Netlify config schema",
  "description": "Config file for Netlify CMS",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "backend",
    "media_folder",
    "collections"
  ],
  "properties": {
    "backend": {
      "type": "object",
      "description": "specifies how to access the content for your site, including authentication"
    },
    "local_backend": {
      "description": "Set this property to connect Netlify to a local Git repo instead of a live one",
      "type": "boolean"
    },
    "publish_mode": {},
    "media_folder": {
      "type": "string",
      "description": "specifies the folder path where uploaded files should be saved, relative to the base of the repo."
    },
    "public_folder": {
      "type": "string",
      "description": "specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included."
    },
    "media_library": {
      "type": "object",
      "description": "Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.",
      "required": ["name"],
      "properties": {}
    },
    "site_url": {
      "type": "string",
      "description": "should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content."
    },
    "display_url": {
      "type": "string",
      "description": "When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).\nDefaults to site_url."
    },
    "logo_url": {
      "type": "string",
      "description": "Logo at the top of the login page. Assumed to be a URL to an image file"
    },
    "locale": {
      "type": "string",
      "default": "en"
    },
    "show_preview_links": {
      "description": "shows Deploy Preview Links",
      "type": "boolean"
    },
    "slug": {
      "type": "object",
      "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).\n \nThe slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.\n \nAvailable template tags:\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date",
      "properties": {}
    },
    "collections": {
      "type": "array",
      "description": "The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.",
      "items": {}
    },
    "editor": {
      "type": "object",
      "description": "This setting changes options for the editor view of the collection. It has one option so far: preview",
      "properties": {}
    },
    "summary": {
      "type": "string",
      "description": "This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field\nTemplate tags are the same as those for slug, with the following additions: \n\n \n{{filename}} The file name without the extension part. \n{{extension}} The file extension. \n{{commit_date}} The file commit date on supported backends (git based backends). \n{{commit_author}} The file author date on supported backends (git based backends)."
    },
    "sortableFields": {
      "type": "array",
      "description": "An optional list of sort fields to show in the UI.\nDefaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.\nWhen author field can't be inferred commit author will be used."
    },
    "view_filters": {
      "type": "array",
      "description": "An optional list of predefined view filters to show in the UI.\nDefaults to an empty list."
    }
  }
}


Property backend
Annotations
Description  specifies how to access the content for your site, including authentication
Diagram
Type object
Additional Properties true
Used by
Schema
#/schema
Source

 "backend": {
  "type": "object",
  "description": "specifies how to access the content for your site, including authentication"
}


Property local_backend
Annotations
Description  Set this property to connect Netlify to a local Git repo instead of a live one
Diagram
Type boolean
Used by
Schema
#/schema
Source

 "local_backend": {
  "description": "Set this property to connect Netlify to a local Git repo instead of a live one",
  "type": "boolean"
}


Property publish_mode
Diagram
Type empty schema
Used by
Schema
#/schema
Source

 "publish_mode": {}


Property media_folder
Annotations
Description  specifies the folder path where uploaded files should be saved, relative to the base of the repo.
Diagram
Type string
Used by
Schema
#/schema
Source

 "media_folder": {
  "type": "string",
  "description": "specifies the folder path where uploaded files should be saved, relative to the base of the repo."
}


Property public_folder
Annotations
Description  specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included.
Diagram
Type string
Used by
Schema
#/schema
Source

 "public_folder": {
  "type": "string",
  "description": "specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included."
}


Property media_library
Annotations
Description  Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.
Diagram
Type object
Properties
Name Occurrence
name
config
required
optional
Additional Properties true
Used by
Schema
#/schema
Source

 "media_library": {
  "type": "object",
  "description": "Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.",
  "required": ["name"],
  "properties": {
    "name": {"type": "string"},
    "config": {"type": "object"}
  }
}


Property name
Diagram
Type string
Used by
Schema
media_library
Source

 "name": {"type": "string"}


Property config
Diagram
Type object
Additional Properties true
Used by
Schema
media_library
Source

 "config": {"type": "object"}


Property site_url
Annotations
Description  should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content.
Diagram
Type string
Used by
Schema
#/schema
Source

 "site_url": {
  "type": "string",
  "description": "should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content."
}


Property display_url
Annotations
Description  When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).
Defaults to site_url.
Diagram
Type string
Used by
Schema
#/schema
Source

 "display_url": {
  "type": "string",
  "description": "When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).\nDefaults to site_url."
}


Property logo_url
Annotations
Description  Logo at the top of the login page. Assumed to be a URL to an image file
Diagram
Type string
Used by
Schema
#/schema
Source

 "logo_url": {
  "type": "string",
  "description": "Logo at the top of the login page. Assumed to be a URL to an image file"
}


Property locale
Diagram
Type string
Constraints
Default : en

Used by
Schema
#/schema
Source

 "locale": {
  "type": "string",
  "default": "en"
}


Property show_preview_links
Annotations
Diagram
Type boolean
Used by
Source

Property slug
Annotations
Description  For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).
 
The slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.
 
Available template tags:
 
Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}} 
{{slug}}: a url-safe version of the title field (or identifier field) for the file 
{{year}}: 4-digit year of the file creation date 
{{month}}: 2-digit month of the file creation date 
{{day}}: 2-digit day of the month of the file creation date 
{{hour}}: 2-digit hour of the file creation date 
{{minute}}: 2-digit minute of the file creation date 
{{second}}: 2-digit second of the file creation date
Diagram
Type object
Properties
Name Occurrence
encoding
clean_accents
sanitize_replacement
optional
optional
optional
Additional Properties true
Used by
Schema
#/schema
Source

 "slug": {
  "type": "object",
  "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).\n \nThe slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.\n \nAvailable template tags:\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date",
  "properties": {
    "encoding": {
      "enum": [
        "unicode",
        "ascii"
      ],
      "description": "\nunicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.\nascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).",
      "default": "unicode"
    },
    "clean_accents": {
      "description": "Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding.",
      "type": "boolean"
    },
    "sanitize_replacement": {
      "type": "string",
      "description": "The replacement string used to substitute unsafe characters; defaults to -"
    }
  }
}


Property encoding
Annotations
Description  
unicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.
ascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).
Diagram
Type string
Constraints
Default : unicode

Enumeration
Values
unicode
ascii
Used by
Schema
slug
Source

 "encoding": {
  "enum": [
    "unicode",
    "ascii"
  ],
  "description": "\nunicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.\nascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).",
  "default": "unicode"
}


Property clean_accents
Annotations
Description  Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding.
Diagram
Type boolean
Used by
Schema
slug
Source

 "clean_accents": {
  "description": "Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding.",
  "type": "boolean"
}


Property sanitize_replacement
Annotations
Description  The replacement string used to substitute unsafe characters; defaults to -
Diagram
Type string
Used by
Schema
slug
Source

 "sanitize_replacement": {
  "type": "string",
  "description": "The replacement string used to substitute unsafe characters; defaults to -"
}


Property collections
Annotations
Description  The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.
Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Schema
#/schema
Source

 "collections": {
  "type": "array",
  "description": "The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.",
  "items": {"$ref": "#/definitions/collectionItems"}
}


Definition collections/items
Diagram
Type reference
Refers collectionItems
Used by
Schema
collections
Source

 "items": {"$ref": "#/definitions/collectionItems"}


Property editor
Annotations
Description  This setting changes options for the editor view of the collection. It has one option so far: preview
Diagram
Type object
Properties
Name Occurrence
preview
optional
Additional Properties true
Used by
Schema
#/schema
Source

 "editor": {
  "type": "object",
  "description": "This setting changes options for the editor view of the collection. It has one option so far: preview",
  "properties": {
    "preview": {
      "description": "Enable preview pane for this collection; defaults to true",
      "default": true,
      "type": "boolean"
    }
  }
}


Property preview
true
Annotations
Description  Enable preview pane for this collection; defaults to true
Diagram
Type boolean
Used by
Schema
editor
Source

 "preview": {
  "description": "Enable preview pane for this collection; defaults to true",
  "default": true,
  "type": "boolean"
}


Property summary
Annotations
Description  This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field
Template tags are the same as those for slug, with the following additions: 

 
{{filename}} The file name without the extension part. 
{{extension}} The file extension. 
{{commit_date}} The file commit date on supported backends (git based backends). 
{{commit_author}} The file author date on supported backends (git based backends).
Diagram
Type string
Used by
Schema
#/schema
Source

 "summary": {
  "type": "string",
  "description": "This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field\nTemplate tags are the same as those for slug, with the following additions: \n\n \n{{filename}} The file name without the extension part. \n{{extension}} The file extension. \n{{commit_date}} The file commit date on supported backends (git based backends). \n{{commit_author}} The file author date on supported backends (git based backends)."
}


Property sortableFields
Annotations
Description  An optional list of sort fields to show in the UI.
Defaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.
When author field can't be inferred commit author will be used.
Diagram
Type array
Constraints
Unique Items : false

Additional Items true
Used by
Schema
#/schema
Source

 "sortableFields": {
  "type": "array",
  "description": "An optional list of sort fields to show in the UI.\nDefaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.\nWhen author field can't be inferred commit author will be used."
}


Property view_filters
Annotations
Description  An optional list of predefined view filters to show in the UI.
Defaults to an empty list.
Diagram
Type array
Constraints
Unique Items : false

Additional Items true
Used by
Schema
#/schema
Source

 "view_filters": {
  "type": "array",
  "description": "An optional list of predefined view filters to show in the UI.\nDefaults to an empty list."
}


Definition collectionItems
Diagram
Type object
All of
Additional Properties false
Used by
Source

 "collectionItems": {
  "oneOf": [
    {
      "required": ["files"]
    },
    {
      "required": ["folder"]
    }
  ],
  "required": ["name"],
  "properties": {
    "fields": {"$ref": "#/definitions/fields"},
    "label": {
      "type": "string",
      "description": "label for the collection in the editor UI; defaults to the value of name"
    },
    "label_singular": {"description": "singular label for certain elements in the editor; defaults to the value of label"},
    "folder": {
      "type": "string",
      "description": "Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. \nNote: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection \"must have a field that is a valid entry identifier\"."
    },
    "files": {"$ref": "#/definitions/files"},
    "path": {
      "type": "string",
      "description": "Path"
    },
    "format": {
      "description": "determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.",
      "type": "string",
      "enum": [
        "yaml-frontmatter",
        "yml",
        "json",
        "frontmatter",
        "toml-frontmatter",
        "toml",
        "json-frontmatter",
        "yaml"
      ]
    },
    "slug": {
      "type": "string",
      "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date"
    },
    "create": {
      "description": "for folder collections only; allows users to create new items in the collection",
      "default": false,
      "type": "boolean"
    },
    "hide": {
      "description": "hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.",
      "default": false,
      "type": "boolean"
    },
    "delete": {
      "description": "prevents users from deleting items in a collection; defaults to true",
      "default": true,
      "type": "boolean"
    },
    "name": {
      "type": "string",
      "description": "unique identifier for the collection, used as the key when referenced in other contexts"
    },
    "filter": {"description": "optional filter for folder collections"},
    "description": {
      "type": "string",
      "description": "optional text, displayed below the label when viewing a collection"
    },
    "extension": {
      "type": "string",
      "description": "the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items"
    }
  }
}


Definition oneOf
Diagram
Type object
One of
Additional Properties false
Used by
Source

 "#/definitions/collectionItems/oneOf": {
  "oneOf": [
    {
      "required": ["files"]
    },
    {
      "required": ["folder"]
    }
  ]
}


Definition oneOf/0
Diagram
Type object
Additional Properties true
Used by
Source

{
  "required": ["files"]
}


Definition oneOf/1
Diagram
Type object
Additional Properties true
Used by
Source

{
  "required": ["folder"]
}


Definition collectionItems/0
Diagram
Type object
Properties
Name Occurrence
fields
label
label_singular
folder
files
path
format
slug
create
hide
delete
name
filter
description
extension
optional
optional
optional
optional
optional
optional
optional
optional
optional
optional
optional
required
optional
optional
optional
Additional Properties true
Used by
Source

 "#/definitions/collectionItems/0": {
  "required": ["name"],
  "properties": {
    "fields": {"$ref": "#/definitions/fields"},
    "label": {
      "type": "string",
      "description": "label for the collection in the editor UI; defaults to the value of name"
    },
    "label_singular": {"description": "singular label for certain elements in the editor; defaults to the value of label"},
    "folder": {
      "type": "string",
      "description": "Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. \nNote: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection \"must have a field that is a valid entry identifier\"."
    },
    "files": {"$ref": "#/definitions/files"},
    "path": {
      "type": "string",
      "description": "Path"
    },
    "format": {
      "description": "determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.",
      "type": "string",
      "enum": [
        "yaml-frontmatter",
        "yml",
        "json",
        "frontmatter",
        "toml-frontmatter",
        "toml",
        "json-frontmatter",
        "yaml"
      ]
    },
    "slug": {
      "type": "string",
      "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date"
    },
    "create": {
      "description": "for folder collections only; allows users to create new items in the collection",
      "default": false,
      "type": "boolean"
    },
    "hide": {
      "description": "hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.",
      "default": false,
      "type": "boolean"
    },
    "delete": {
      "description": "prevents users from deleting items in a collection; defaults to true",
      "default": true,
      "type": "boolean"
    },
    "name": {
      "type": "string",
      "description": "unique identifier for the collection, used as the key when referenced in other contexts"
    },
    "filter": {"description": "optional filter for folder collections"},
    "description": {
      "type": "string",
      "description": "optional text, displayed below the label when viewing a collection"
    },
    "extension": {
      "type": "string",
      "description": "the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items"
    }
  }
}


Definition fields
Annotations
Description  The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.
Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Source

 "fields": {
  "type": "array",
  "description": "The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.",
  "items": {
    "required": ["name"],
    "properties": {
      "name": {
        "type": "string",
        "description": "unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)"
      },
      "label": {
        "type": "string",
        "description": "label for the field in the editor UI; defaults to the value of name"
      },
      "widget": {"$ref": "#/definitions/widget"},
      "default": {"description": "specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type."},
      "required": {
        "description": "makes a field required; defaults to true",
        "default": true,
        "type": "boolean"
      },
      "pattern": {
        "type": "array",
        "description": "add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)"
      },
      "fields": {"$ref": "#/definitions/fields"}
    }
  }
}


Definition fields/items
Diagram
Type object
Properties
Name Occurrence
name
label
widget
default
required
pattern
fields
required
optional
optional
optional
optional
optional
optional
Additional Properties true
Used by
Schema
fields
Source

 "items": {
  "required": ["name"],
  "properties": {
    "name": {
      "type": "string",
      "description": "unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)"
    },
    "label": {
      "type": "string",
      "description": "label for the field in the editor UI; defaults to the value of name"
    },
    "widget": {"$ref": "#/definitions/widget"},
    "default": {"description": "specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type."},
    "required": {
      "description": "makes a field required; defaults to true",
      "default": true,
      "type": "boolean"
    },
    "pattern": {
      "type": "array",
      "description": "add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)"
    },
    "fields": {"$ref": "#/definitions/fields"}
  }
}


Definition name
Annotations
Description  unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)
Diagram
Type string
Used by
Schema
fields/items
Source

 "name": {
  "type": "string",
  "description": "unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)"
}


Definition label
Annotations
Description  label for the field in the editor UI; defaults to the value of name
Diagram
Type string
Used by
Schema
fields/items
Source

 "label": {
  "type": "string",
  "description": "label for the field in the editor UI; defaults to the value of name"
}


Definition widget
Diagram
Type object
Properties
Name Occurrence
required
hint
pattern
optional
optional
optional
Additional Properties true
Used by
Source

 "widget": {
  "properties": {
    "required": {
      "description": "Defaults to True",
      "type": "boolean"
    },
    "hint": {
      "type": "string",
      "description": "optionally add helper text directly below a widget."
    },
    "pattern": {
      "type": "array",
      "description": "add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets"
    }
  }
}


Definition required
Annotations
Description  Defaults to True
Diagram
Type boolean
Used by
Schema
widget
Source

 "required": {
  "description": "Defaults to True",
  "type": "boolean"
}


Definition hint
Annotations
Description  optionally add helper text directly below a widget.
Diagram
Type string
Used by
Schema
widget
Source

 "hint": {
  "type": "string",
  "description": "optionally add helper text directly below a widget."
}


Definition pattern
Annotations
Description  add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets
Diagram
Type array
Constraints
Unique Items : false

Additional Items true
Used by
Schema
widget
Source

 "pattern": {
  "type": "array",
  "description": "add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets"
}


Definition widget
Diagram
Type reference
Refers widget
Used by
Schema
fields/items
Source

 "widget": {"$ref": "#/definitions/widget"}


Definition default
Annotations
Description  specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type.
Diagram
Type empty schema
Used by
Schema
fields/items
Source

 "default": {"description": "specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type."}


Definition required
true
Annotations
Description  makes a field required; defaults to true
Diagram
Type boolean
Used by
Schema
fields/items
Source

 "required": {
  "description": "makes a field required; defaults to true",
  "default": true,
  "type": "boolean"
}


Definition pattern
Annotations
Description  add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)
Diagram
Type array
Constraints
Unique Items : false

Additional Items true
Used by
Schema
fields/items
Source

 "pattern": {
  "type": "array",
  "description": "add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)"
}


Definition fields
Diagram
Type reference
Refers fields
Used by
Schema
fields/items
Source

 "fields": {"$ref": "#/definitions/fields"}


Definition fields
Diagram
Type reference
Refers fields
Used by
Source

 "fields": {"$ref": "#/definitions/fields"}


Definition label
Annotations
Description  label for the collection in the editor UI; defaults to the value of name
Diagram
Type string
Used by
Source

 "label": {
  "type": "string",
  "description": "label for the collection in the editor UI; defaults to the value of name"
}


Definition label_singular
Annotations
Description  singular label for certain elements in the editor; defaults to the value of label
Diagram
Type empty schema
Used by
Source

 "label_singular": {"description": "singular label for certain elements in the editor; defaults to the value of label"}


Definition folder
Annotations
Description  Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. 
Note: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection "must have a field that is a valid entry identifier".
Diagram
Type string
Used by
Source

 "folder": {
  "type": "string",
  "description": "Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. \nNote: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection \"must have a field that is a valid entry identifier\"."
}


Definition files
Diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items true
Used by
Source

 "files": {
  "type": "array",
  "items": {
    "properties": {
      "name": {
        "type": "string",
        "description": "unique identifier for the file"
      },
      "label": {
        "type": "string",
        "description": "file label"
      },
      "file": {
        "type": "string",
        "description": "unique filepath (relative to the base of the repo)."
      },
      "fields": {"$ref": "#/definitions/fields"}
    }
  }
}


Definition files/items
Diagram
Type object
Properties
Name Occurrence
name
label
file
fields
optional
optional
optional
optional
Additional Properties true
Used by
Schema
files
Source

 "items": {
  "properties": {
    "name": {
      "type": "string",
      "description": "unique identifier for the file"
    },
    "label": {
      "type": "string",
      "description": "file label"
    },
    "file": {
      "type": "string",
      "description": "unique filepath (relative to the base of the repo)."
    },
    "fields": {"$ref": "#/definitions/fields"}
  }
}


Definition name
Annotations
Description  unique identifier for the file
Diagram
Type string
Used by
Schema
files/items
Source

 "name": {
  "type": "string",
  "description": "unique identifier for the file"
}


Definition label
Annotations
Description  file label
Diagram
Type string
Used by
Schema
files/items
Source

 "label": {
  "type": "string",
  "description": "file label"
}


Definition file
Annotations
Description  unique filepath (relative to the base of the repo).
Diagram
Type string
Used by
Schema
files/items
Source

 "file": {
  "type": "string",
  "description": "unique filepath (relative to the base of the repo)."
}


Definition fields
Diagram
Type reference
Refers fields
Used by
Schema
files/items
Source

 "fields": {"$ref": "#/definitions/fields"}


Definition files
Diagram
Type reference
Refers files
Used by
Source

 "files": {"$ref": "#/definitions/files"}


Definition path
Annotations
Description  Path
Diagram
Type string
Used by
Source

 "path": {
  "type": "string",
  "description": "Path"
}


Definition format
Annotations
Description  determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.
Diagram
Type string
Enumeration
Values
yaml-frontmatter
yml
json
frontmatter
toml-frontmatter
toml
json-frontmatter
yaml
Used by
Source

 "format": {
  "description": "determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.",
  "type": "string",
  "enum": [
    "yaml-frontmatter",
    "yml",
    "json",
    "frontmatter",
    "toml-frontmatter",
    "toml",
    "json-frontmatter",
    "yaml"
  ]
}


Definition slug
Annotations
Description  For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).
 
Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}} 
{{slug}}: a url-safe version of the title field (or identifier field) for the file 
{{year}}: 4-digit year of the file creation date 
{{month}}: 2-digit month of the file creation date 
{{day}}: 2-digit day of the month of the file creation date 
{{hour}}: 2-digit hour of the file creation date 
{{minute}}: 2-digit minute of the file creation date 
{{second}}: 2-digit second of the file creation date
Diagram
Type string
Used by
Source

 "slug": {
  "type": "string",
  "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date"
}


Definition create
false
Annotations
Description  for folder collections only; allows users to create new items in the collection
Diagram
Type boolean
Used by
Source

 "create": {
  "description": "for folder collections only; allows users to create new items in the collection",
  "default": false,
  "type": "boolean"
}


Definition hide
false
Annotations
Description  hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.
Diagram
Type boolean
Used by
Source

 "hide": {
  "description": "hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.",
  "default": false,
  "type": "boolean"
}


Definition delete
true
Annotations
Description  prevents users from deleting items in a collection; defaults to true
Diagram
Type boolean
Used by
Source

 "delete": {
  "description": "prevents users from deleting items in a collection; defaults to true",
  "default": true,
  "type": "boolean"
}


Definition name
Annotations
Description  unique identifier for the collection, used as the key when referenced in other contexts
Diagram
Type string
Used by
Source

 "name": {
  "type": "string",
  "description": "unique identifier for the collection, used as the key when referenced in other contexts"
}


Definition filter
Annotations
Description  optional filter for folder collections
Diagram
Type empty schema
Used by
Source

 "filter": {"description": "optional filter for folder collections"}


Definition description
Annotations
Description  optional text, displayed below the label when viewing a collection
Diagram
Type string
Used by
Source

 "description": {
  "type": "string",
  "description": "optional text, displayed below the label when viewing a collection"
}


Definition extension
Annotations
Description  the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items
Diagram
Type string
Used by
Source

 "extension": {
  "type": "string",
  "description": "the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items"
}