You are here

Home » API reference » Drupal 9

system.schema.yml in Drupal 9

Same filename and directory in other branches
  1. 8 core/modules/system/config/schema/system.schema.yml
core/modules/system/config/schema/system.schema.yml
2 string references to 'system.schema'
system_post_update_schema_version_int in core/modules/system/system.post_update.php
Update schema version to integers.
UpdateHookRegistryFactory::create in core/lib/Drupal/Core/Update/UpdateHookRegistryFactory.php
Creates a new UpdateHookRegistry instance.

File

core/modules/system/config/schema/system.schema.yml
View source 
  1. # Schema for the configuration files of the System module.

  2. 

  3. system.site:

  4.   type: config_object

  5.   label: 'Site information'

  6.   mapping:

  7.     uuid:

  8.       type: uuid

  9.       label: 'Site UUID'

  10.       constraints:

  11.         Uuid: []

  12.         NotNull: []

  13.     name:

  14.       type: label

  15.       label: 'Site name'

  16.     mail:

  17.       type: email

  18.       label: 'Email address'

  19.     slogan:

  20.       type: label

  21.       label: 'Slogan'

  22.     page:

  23.       type: mapping

  24.       label: 'Pages'

  25.       mapping:

  26.         403:

  27.           type: path

  28.           label: 'Default 403 (access denied) page'

  29.         404:

  30.           type: path

  31.           label: 'Default 404 (not found) page'

  32.         front:

  33.           type: path

  34.           label: 'Default front page'

  35.     admin_compact_mode:

  36.       type: boolean

  37.       label: 'Compact mode'

  38.     weight_select_max:

  39.       type: integer

  40.       label: 'Weight element maximum value'

  41.     default_langcode:

  42.       type: string

  43.       label: 'Site default language code'

  44.     mail_notification:

  45.       type: string

  46.       label: 'Notification email address'

  47. 

  48. system.maintenance:

  49.   type: config_object

  50.   label: 'Maintenance mode'

  51.   mapping:

  52.     message:

  53.       type: text

  54.       label: 'Message to display when in maintenance mode'

  55. 

  56. system.cron:

  57.   type: config_object

  58.   label: 'Cron settings'

  59.   mapping:

  60.     threshold:

  61.       type: mapping

  62.       label: 'Thresholds'

  63.       mapping:

  64.         requirements_warning:

  65.           type: integer

  66.           label: 'Requirements warning period'

  67.         requirements_error:

  68.           type: integer

  69.           label: 'Requirements error period'

  70.     logging:

  71.       type: integer

  72.       label: 'Detailed cron logging'

  73. 

  74. system.date:

  75.   type: config_object

  76.   label: 'Date settings'

  77.   mapping:

  78.     first_day:

  79.       type: integer

  80.       label: 'First day of week'

  81.     country:

  82.       type: mapping

  83.       label: 'Country'

  84.       mapping:

  85.         default:

  86.           type: string

  87.           label: 'Default country'

  88.     timezone:

  89.       type: mapping

  90.       label: 'Time zone settings'

  91.       mapping:

  92.         default:

  93.           type: string

  94.           label: 'Default time zone'

  95.         user:

  96.           type: mapping

  97.           label: 'User'

  98.           mapping:

  99.             configurable:

  100.               type: boolean

  101.               label: 'Users may set their own time zone'

  102.             default:

  103.               type: integer

  104.               label: 'Time zone for new users'

  105.             warn:

  106.               type: boolean

  107.               label: 'Remind users at login if their time zone is not set'

  108. 

  109. system.diff:

  110.   type: config_object

  111.   label: 'Diff settings'

  112.   mapping:

  113.     context:

  114.       type: mapping

  115.       label: 'Context'

  116.       mapping:

  117.         lines_leading:

  118.           type: integer

  119.           label: 'Number of leading lines in a diff'

  120.         lines_trailing:

  121.           type: integer

  122.           label: 'Number of trailing lines in a diff'

  123. 

  124. system.logging:

  125.   type: config_object

  126.   label: 'Logging settings'

  127.   mapping:

  128.     error_level:

  129.       type: string

  130.       label: 'Error messages to display'

  131. 

  132. system.performance:

  133.   type: config_object

  134.   label: 'Performance settings'

  135.   mapping:

  136.     cache:

  137.       type: mapping

  138.       label: 'Caching'

  139.       mapping:

  140.         page:

  141.           type: mapping

  142.           label: 'Page caching'

  143.           mapping:

  144.             max_age:

  145.               type: integer

  146.               label: 'Max age'

  147.     css:

  148.       type: mapping

  149.       label: 'CSS performance settings'

  150.       mapping:

  151.         preprocess:

  152.           type: boolean

  153.           label: 'Aggregate CSS files'

  154.         gzip:

  155.           type: boolean

  156.           label: 'Compress CSS files'

  157.     fast_404:

  158.       type: mapping

  159.       label: 'Fast 404 settings'

  160.       mapping:

  161.         enabled:

  162.           type: boolean

  163.           label: 'Fast 404 enabled'

  164.         paths:

  165.           type: string

  166.           label: 'Regular expression to match'

  167.         exclude_paths:

  168.           type: string

  169.           label: 'Regular expression to not match'

  170.         html:

  171.           type: string

  172.           label: 'Fast 404 page html'

  173.     js:

  174.       type: mapping

  175.       label: 'JavaScript performance settings'

  176.       mapping:

  177.         preprocess:

  178.           type: boolean

  179.           label: 'JavaScript preprocess'

  180.         gzip:

  181.           type: boolean

  182.           label: 'Compress JavaScript files.'

  183.     stale_file_threshold:

  184.       type: integer

  185.       label: 'Stale file threshold'

  186. 

  187. system.rss:

  188.   type: config_object

  189.   label: 'Feed settings'

  190.   mapping:

  191.     items:

  192.       type: mapping

  193.       label: 'Feed items'

  194.       mapping:

  195.         view_mode:

  196.           type: string

  197.           label: 'Feed content'

  198. 

  199. system.theme:

  200.   type: config_object

  201.   label: 'Theme settings'

  202.   mapping:

  203.     admin:

  204.       type: string

  205.       label: 'Administration theme'

  206.     default:

  207.       type: string

  208.       label: 'Default theme'

  209. 

  210. system.menu.*:

  211.   type: config_entity

  212.   label: 'Menu'

  213.   mapping:

  214.     id:

  215.       type: string

  216.       label: 'ID'

  217.     label:

  218.       type: label

  219.       label: 'Label'

  220.     description:

  221.       type: label

  222.       label: 'Menu description'

  223.     locked:

  224.       type: boolean

  225.       label: ''

  226. 

  227. system.action.*:

  228.   type: config_entity

  229.   label: 'System action'

  230.   mapping:

  231.     id:

  232.       type: string

  233.       label: 'ID'

  234.     label:

  235.       type: label

  236.       label: 'Label'

  237.     type:

  238.       type: string

  239.       label: 'Type'

  240.     plugin:

  241.       type: string

  242.       label: 'Plugin'

  243.     configuration:

  244.       type: action.configuration.[%parent.plugin]

  245. 

  246. system.file:

  247.   type: config_object

  248.   label: 'File system'

  249.   mapping:

  250.     allow_insecure_uploads:

  251.       type: boolean

  252.       label: 'Allow insecure uploads'

  253.     default_scheme:

  254.       type: string

  255.       label: 'Default download method'

  256.     path:

  257.       type: mapping

  258.       label: 'Path settings'

  259.       mapping:

  260.         temporary:

  261.           type: string

  262.           label: 'Temporary directory'

  263.     temporary_maximum_age:

  264.       type: integer

  265.       label: 'Maximum age for temporary files'

  266. 

  267. system.image:

  268.   type: config_object

  269.   label: 'Image settings'

  270.   mapping:

  271.     toolkit:

  272.       type: string

  273.       label: 'Toolkit'

  274. 

  275. system.image.gd:

  276.   type: config_object

  277.   label: 'Image settings'

  278.   mapping:

  279.     jpeg_quality:

  280.       type: integer

  281.       label: 'JPEG quality'

  282. 

  283. system.mail:

  284.   type: config_object

  285.   label: 'Mail system'

  286.   mapping:

  287.     interface:

  288.       type: sequence

  289.       label: 'Interfaces'

  290.       sequence:

  291.         type: string

  292.         label: 'Interface'

  293. 

  294. system.theme.global:

  295.   type: theme_settings

  296.   label: 'Theme global settings'

  297. 

  298. system.advisories:

  299.   type: config_object

  300.   label: 'Security advisory settings'

  301.   mapping:

  302.     enabled:

  303.       type: boolean

  304.       label: 'Display critical security advisories'

  305.     interval_hours:

  306.       type: integer

  307.       label: 'How often to check for security advisories, in hours'

  308. 

  309. block.settings.system_branding_block:

  310.   type: block_settings

  311.   label: 'Branding block'

  312.   mapping:

  313.     use_site_logo:

  314.       type: boolean

  315.       label: 'Use site logo'

  316.     use_site_name:

  317.       type: boolean

  318.       label: 'Use site name'

  319.     use_site_slogan:

  320.       type: boolean

  321.       label: 'Use site slogan'

  322. 

  323. block.settings.system_menu_block:*:

  324.   type: block_settings

  325.   label: 'Menu block'

  326.   mapping:

  327.     level:

  328.       type: integer

  329.       label: 'Starting level'

  330.     depth:

  331.       type: integer

  332.       label: 'Maximum number of levels'

  333.     expand_all_items:

  334.       type: boolean

  335.       label: 'Expand all items'

  336. 

  337. block.settings.local_tasks_block:

  338.   type: block_settings

  339.   label: 'Tabs block'

  340.   mapping:

  341.     primary:

  342.       type: boolean

  343.       label: 'Whether primary tabs are shown'

  344.     secondary:

  345.       type: boolean

  346.       label: 'Whether secondary tabs are shown'

  347. 

  348. condition.plugin.request_path:

  349.   type: condition.plugin

  350.   mapping:

  351.     pages:

  352.       type: string