Fields

A field is one entry in a type’s fields: list. Every field has a name and a type; the other keys below are common to all field types, and any key that is not one of them is a parameter of the field type, checked against that type’s parameter list.

fields:
  - name: distanceKm          # the handle templates and the API use
    type: number              # one of the field types below
    label: { en-GB: Distance }
    help: { en-GB: The length of the whole route. }
    required: true            # needed to publish
    index: true               # projected for filtering and sorting
    min: 0.1                  # number parameters
    max: 200
    unit: km

Keys every field takesCopy Anchor Link

A field may sit inside a repeater item or a block; the same keys apply there except site_overridable, unique and summary_of, which are top-level only.

Field typesCopy Anchor Link

engine-dmo describe fieldtypes lists these with every parameter; --json gives the same as data. Both bundles have the same field types.

There is no file, image, colour, table, duration or daterange field type. Use asset for files and images, and two date or datetime fields with a validation rule for a range.

Field groupsCopy Anchor Link

A field group is a named list of fields declared once in config/schema/_shared.yaml and included in any type, repeater or block with - use: <name>:

# config/schema/_shared.yaml
field_groups:
  contact:
    - { name: email, type: text, format: email }
    - { name: phone, type: phone }

# config/schema/venue.yaml
key: venue
label: Venue
fields:
  - { name: title, type: text, required: true }
  - use: contact

The group’s fields become fields of the including type, exactly as if declared there. A group name is camelCase. A use: entry declares nothing else (no name, no type). A group may include another group, but not itself. A variant’s fields cannot use a group.

Ids for a group’s fields are written into _shared.yaml by check --fix, and a field id is unique by declaration, so every type that includes the group shares the same field ids.

Errors you may seeCopy Anchor Link