Issue Task Closed

#92503JSON Schemas for YAML configurations

Jan Kiesewetter 10/07/20, 15:50 updated 11/09/26, 07:27

Description

Common IDEs and code editors support JSON schema to validate YAML files.
With a JSON schema for YAML configurations shipped by the core extensions, the configuration would be much easier.
Such schemas brings for example:
  • Auto completion
  • Tooltips
  • Validation
Configurations that should have a schema:
  • Site configuration
  • Form configuration
  • RTE configuration

See:
https://www.schemastore.org/json/

Reviews 1

History 1011

  1. Georg Ringer commented and changed TYPO3 Version 10 14 <span data-processor="relativetime" data-value="2026-11-01T17:16:42+00:00" > 11/01/26, 17:16 </span>

    WHAT NEEDS A SCHEMA (all YAML configuration core reads)
    Sites (config/sites/<identifier>/, in classic mode typo3conf/sites/<identifier>/)<br> [ ] config.yaml covered by SchemaStore, has drifted, see below<br> [ ] settings.yaml free values, defined by the Sets in use<br> [ ] csp.yaml Content Security Policy<br>Site Sets (EXT:<ext>/Configuration/Sets/<name>/)<br> [ ] config.yaml name, label, dependencies, …<br> [ ] settings.definitions.yaml<br> [ ] settings.yaml free values, as above<br> [ ] route-enhancers.yaml shares its routeEnhancers definition with sites config.yaml<br>System (config/system/, in classic mode typo3conf/system/)<br> [ ] file-storages.yaml new in 15.0 (#110762). Driver options depend on the driver,<br> <span>env()</span> placeholders are expected for credentials<br>Lower priority<br> [ ] RTE presets EXT:<ext>/Configuration/RTE/*.yaml, mostly CKEditor options<br> [ ] Form *.form.yaml and Configuration/Form/<name>/config.yaml,<br> extensions add to it</name></ext></name></ext></identifier></identifier>

    Checked on main (c573af252d9). Core still ships no schema. The site configuration is covered by https://www.schemastore.org/typo3.json, Form and RTE are not, and Site Sets are new since this issue was filed and also not covered.

    Validating sample configurations against the SchemaStore schema shows it has drifted. These are reported as errors although core accepts them:
    • errorHandler: LoginRedirect (since 13.3)
    • %env(...)% for languageId, rootPageId and enabled
    • base provided through imports
    • limitToPages with an expression (since 14.2)

    Routing is covered in typo3.json for routeEnhancers in the site configuration, but not for route-enhancers.yaml in Site Sets (since 14.1).

  2. Gerrit Code Review pushed patch set 1 for main to change 97345 status Accepted Under Review <span data-processor="relativetime" data-value="2026-11-04T18:37:07+00:00" > 11/04/26, 18:37 </span>