search

europace / baufismart-kundenangaben-api

API zum Importieren von Kundenangaben in einen neuen Vorgang in BaufiSmart.
https://developer.europace.de
14 stars 4 forks source link

Types Uppercase #72

Closed paleise closed 3 years ago

paleise commented 3 years ago

Hallo, leider ist es scheinbar notwendig die Werte in den Feldern "@type" groß zu schreiben. Also z.B. ein "@type": "Verheiratet" funktioniert nicht, es ist "@type": "VERHEIRATET" nötig. Naja nicht wirklich ein Problem, aber evtl. könnte man das dokumentieren. Gruß Peter

s-gurevich commented 3 years ago

Hallo Peter,

die @type Angabe wird im Screaming Snake Case geschrieben abgeleitet vom Typnamen.

Die Information findet sich in der OpenApi YAML-Datei unter mapping:

image

In der daraus generierten HTML-Ansicht fehlt die Info tatsächlich. Wir kümmern uns darum, die Doku in der HTML-Version zu ergänzen.

Gruß, Serafima

paleise commented 3 years ago

Danke für die Klärung

s-gurevich commented 3 years ago

Hi Peter,

wir haben in der HTML Referenz einen Hinweis hinzugefügt: https://htmlpreview.github.io/?https://github.com/europace/baufismart-kundenangaben-api/blob/master/reference/index.html#_definitions