Fehler in openapi.json definition: Optigem int | null

skipy

Hallo Leute,

ich habe in der API mit Swagger das Problem, dass ich immer eine Fehlermeldung bekomme. Laut openapi.json ist das Feld optigemId so definiert:

"optigemId": {
            "type": "integer",
            "nullable": true
          },

Sprich int oder null. Via Json wird bei mir bei einem Abruf der Personen-Daten das Feld OptigemId aber mir einem leeren String zugegegeben. Das Führt zu einer Fehlermeldung.
Ich habe bereits ausprobiert in Church-Tools das Feld "OptigemId" mit einem Wert zu setzen, zu seichern und anschließend das Feld wieder zu löschen und zu speichern. Ich bekomme aber weiterhin leere String-Werte zurück.

Könnt ihr sicherstellen, dass das Feld immer NULL oder INT ist?

Andy

@skipy also ich bin nun wirklich kein API-Fachmann ... im Gegenteil. Aber in unserer DB heißt das Feld "optigem_nr" und ist ein Textfeld. Aber vielleicht hat das ja auch gar nichts mit der API und deinem Problem zu tun ... dann vergiss meinen Beitrag.

hbuerger

Danke @skipy für die Fehlermeldung. Ich schreib es mir auf und werde es nächste Woche überprüfen und die Doku entsprechend anpassen

skipy

@Andy Ja, bei mir ist es auch ein Textfeld in den Church-Tools Stammdaten. Allerdings wird sie in der API-Spezifikation als Integer aufgeführt. Wenn dann trotzdem ein Textfeld geliefert wird, kommt es bei der Validierung zu einer Fehlermeldung :-).

skipy

@hbuerger Danke

skipy

@hbuerger
Ich dachte ich hake mal nach :-). Ist ein Update der openapi.json in Sicht oder wird sich der API-Output ändern?

davidschilling

Mit der nächsten Version ist die Api-Doku dann richtig

hbuerger

Wir @davidschilling richtig sagt, es kommt mit der neuen Version. Wir haben es in der Dokumentation so angepasst:

    optigemId:
      type: string
      description: String with Optigem ID or empty string if no ID is set.

skipy

Perfekt! Danke

hbuerger

Die Änderung ist mit v3.56 nun online. Somit schließe ich den Thread.