Valeurs de configuration affichant des noms techniques

Description du problème

Lorsque le schéma a été mis à niveau vers une version plus récente, mais que l'interface de configuration ou le CLI de configuration déployés sont toujours à l'ancienne version, les nouvelles valeurs de configuration introduites auront des noms techniques tels que cfg.server.mail.notification.delay au lieu de noms conviviaux et de descriptions.

Cela se produit parce que l'interface de configuration et le CLI de configuration dépendent de métadonnées qui décrivent les propriétés de configuration. Lorsque le schéma est mis à niveau vers une version plus récente qui introduit de nouvelles propriétés de configuration, les anciennes versions de l'interface de configuration ou du CLI de configuration ne possèdent pas les métadonnées pour ces nouvelles propriétés. Par conséquent, elles reviennent à l'affichage des noms techniques des propriétés au lieu d'étiquettes conviviales et de descriptions.

Symptômes

• Les propriétés de configuration apparaissent avec des noms techniques comme cfg.server.mail.notification.delay au lieu de noms descriptifs
• Descriptions ou textes d'aide manquants pour les nouvelles options de configuration introduites
• L'interface de configuration ou les commandes CLI peuvent ne pas afficher les étiquettes appropriées pour les nouveaux paramètres

Solution

Une fois que le schéma a été mis à niveau vers une version plus récente, la version correspondante du CLI de configuration et de l'interface de configuration doit être utilisée. Cela garantit que :

1. Alignement des métadonnées : L'interface de configuration et le CLI possèdent les métadonnées appropriées (étiquettes, descriptions, règles de validation) pour toutes les propriétés de configuration dans le schéma mis à niveau
2. Expérience utilisateur : Les utilisateurs voient des noms conviviaux et descriptifs ainsi que des descriptions utiles au lieu de chemins de propriétés techniques
3. Fonctionnalité : Toutes les nouvelles options de configuration sont correctement accessibles et configurables via l'interface

Bonnes pratiques

• Toujours mettre à niveau l'interface de configuration et le CLI de configuration pour correspondre à la version du schéma
• Vérifier que les propriétés de configuration s'affichent correctement après une mise à niveau
• Maintenir tous les composants (schéma, CLI et interface) à des versions compatibles
• Tester les modifications de configuration dans un environnement non-production en premier

Sujets connexes

• Mise-à-jour à la version 4.20.0
• Guide d'installation et de configuration