field.schema.yml

drupal/core/modules/field/config/schema/field.schema.yml

File

drupal/core/modules/field/config/schema/field.schema.yml
View source
  1. # Schema for configuration files of the Field module.

  2. 

  3. field.settings:

  4.   type: mapping

  5.   label: 'Field settings'

  6.   mapping:

  7.     default_storage:

  8.       type: string

  9.       label: 'The default storage backend for a field'

  10.     language_fallback:

  11.       type: boolean

  12.       label: 'Whether the field display falls back to global language fallback configuration'

  13.     purge_batch_size:

  14.       type: integer

  15.       label: 'Maximum number of field data records to purge'

  16. 

  17. field.field.*:

  18.   type: mapping

  19.   label: 'Field'

  20.   mapping:

  21.     id:

  22.       type: string

  23.       label: 'Machine name'

  24.     uuid:

  25.       type: string

  26.       label: 'UUID'

  27.     status:

  28.       type: boolean

  29.       label: 'Status'

  30.     langcode:

  31.       type: string

  32.       label: 'Default language'

  33.     type:

  34.       type: string

  35.       label: 'Type'

  36.     settings:

  37.       type: field.[%parent.type].settings

  38.     module:

  39.       type: string

  40.       label: 'Module'

  41.     active:

  42.       type: boolean

  43.       label: 'Active'

  44.     entity_types:

  45.       type: sequence

  46.       label: 'Allowed entity types'

  47.       sequence:

  48.         - type: string

  49.           label: 'Entity type'

  50.     storage:

  51.       type: mapping

  52.       label: 'Storage'

  53.       mapping:

  54.         type:

  55.           type: string

  56.           label: 'Type'

  57.         settings:

  58.           type: field_storage.[%parent.type].settings

  59.           label: 'Settings'

  60.         module:

  61.           type: string

  62.           label: 'Module'

  63.         active:

  64.           type: boolean

  65.           label: 'Active'

  66.     locked:

  67.       type: boolean

  68.       label: 'Locked'

  69.     cardinality:

  70.       type: integer

  71.       label: 'Maximum number of values users can enter'

  72.     translatable:

  73.       type: boolean

  74.       label: 'Translatable'

  75.     indexes:

  76.       type: sequence

  77.       label: 'Indexes'

  78.       sequence:

  79.         - type: sequence

  80.           label: 'Indexes'

  81.           sequence:

  82.             - type: string

  83.               label: 'Column'

  84. 

  85. field.instance.*.*.*:

  86.   type: mapping

  87.   label: 'Field instance'

  88.   mapping:

  89.     id:

  90.       type: string

  91.       label: 'ID'

  92.     uuid:

  93.       type: string

  94.       label: 'UUID'

  95.     status:

  96.       type: boolean

  97.       label: 'Status'

  98.     langcode:

  99.       type: string

  100.       label: 'Default language'

  101.     field_uuid:

  102.       type: string

  103.       label: 'Field UUID'

  104.     entity_type:

  105.       type: string

  106.       label: 'Allowed entity types'

  107.     bundle:

  108.       type: string

  109.       label: 'Bundle'

  110.     label:

  111.       type: label

  112.       label: 'Label'

  113.     description:

  114.       type: text

  115.       label: 'Help text'

  116.     required:

  117.       type: boolean

  118.       label: 'Required field'

  119.     default_value:

  120.       type: field.[%parent.field_type].value

  121.     default_value_function:

  122.       type: string

  123.       label: 'Default value funtion'

  124.     settings:

  125.       type: field.[%parent.field_type].instance_settings

  126.     field_type:

  127.       type: string

  128.       label: 'Field type'