git_brcal/misc/Readme_yaml.md

Bremen Calling Open API spec

Infos zur Generierung der CS Wrapper / Mapping Datei aus YAML

Verwendung von "OpenAPIGenerator" aus dem Rest API Client Code Generator 2022. Die automatisch generierte Datei muss leider noch nachgearbeitet werden:

1. #pragma warning disable CS8073 (direkt nach der NS declaration).
2. #pragma warning restore CS8073 // The result of the expression is always the same since a value of this type is never equal to 'null' (am Schluss vor der schließenden Klammer des NS)
3. Für readOnly Properties wird bei einem Enum kein korrekter Code emittiert. Daher muss aktuell folgende Funktion ergänzt werden, damit beim Speichern das "evaluation" Flag nicht mitgesendet wird:

public bool ShouldSerializeEvaluation()
{
    return false;
}

Witziger(!)weise funktioniert es für das Property EvaluationMessage korrekt.

Vacuum Yaml Linter

Example Usage:

vacuum lint -d .\misc\BreCalApi.yaml --fail-severity warn