Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Checkliste

  • Schema aktualisieren

    • JSON Schema

    • XSD Schema

      • Converters

  • DatabaseConfigurationMigrationService erweitern

  • Dokumentation anpassen

  • Template Projekt aktualisieren

Schema

JSON Schema

Kann die geänderte Konfiguration über das appsettings.json konfiguriert werden, so muss auch das Schema dementsprechend aktualisiert werden. (Siehe Validierung der appsettings & Schema referenz)

XSD Schema

Kann die geänderte Konfiguration über XML Layouts angepasst werden, so muss auch das XSD Schema aktualisiert werden. Sobald sich das XML Schema verändert müssen auch die Converter aktualisiert werden. Von XML zu Layout gibt es das Overlay. Von Layout zu XML gibt es den XmlModelSerializer.

Dokumentation

Die Konfiguration ist an mehreren Orten dokumentiert. Die wichtigsten dabei wären:

Titel

Beschreibung

Konfigurationsschlüssel

Dokumentation aller verwendeten Konfigurationsschlüssel und deren mögliche Werte sowie Standartwert

Migrations guide

Guide der helfen soll Konfigurationen zu migrieren

DatabaseConfigurationMigrationService

Dieser service wurde geschrieben um die konfigurationen die in die Datenbank geschreiben werden automatisch zu migrieren. In diesem Service sind drei Listen mit migrationsaktionen, diese sind folgendermassen aufgeteilt:

Name

Beschreibung

_renamedKeys

Konfigurationsschlüssel die nur umbenannt wurden

_removedKeys

Konfigurationsschlüssel die nicht mehr existieren

_transformations

komplexe changes der Konfiguration die aber ein definitives Resultat haben

Die Konfigurationsschlüssel sollten immer in lower-case sein, wobei der neue Name bei _renamedKeys im korrekten casing sein sollte.