Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.This was brought up in #2144413-182: Config translation does not support text elements with a format.
Problem/Motivation
Data definitions support descriptions but we do not use descriptions in our configuration schema in core. This would be helpful concretely for auto-generated configuration forms and also generally for making bring configuration schema more inline with field definitions of content entities.
Because config schema arrays get turned into DataDefinition objects they already support setting a description key, it is just that we do not do that anywhere in core yet.
Proposed resolution
Add descriptions to configuration schemas.
Please note (again) that this is not an API change and not even an API addition. The API is already there. Therefore we could also decide to do this step by step or something.
Remaining tasks
User interface changes
API changes
| Comment | File | Size | Author |
|---|---|---|---|
| #14 | 2376693-14-PoC-do-not-test.patch | 1.94 KB | Wim Leers |
Comments
Comment #1
Gábor HojtsyDo you have an example of where would you use this?
Comment #14
Wim Leers#1: AFAICT @tstoeckler intended for it to be used in the "add/edit translation" config translation forms:
\Drupal\config_translation\Form\ConfigTranslationAddFormand friends. That would provide context to the person working on translations.In a next step, we could remove the hardcoded descriptions from config forms. See the attached PoC patch as an example
But by now, I think it'd also be valuable for API responses and generating config forms in general, which would enable decoupled admin UIs. See #2164373: [META] Untie config validation from form validation — enables validatable Recipes, decoupled admin UIs ….