Formaat foutafhandeling - input validatie (API-50)

Organisaties Digitaal Stelsel Omgevingswet
#1

Er was mij verteld dat @dvh de kenner is op dit gebied :slight_smile:

Twee vragen i.v.m. input validatie-fouten (HTTP 400)

BInnen de invalid-params key worden fouten aangeduid met een object met de keys type, name en reason.

  1. Wat als er meerdere fouten zijn op hetzelfde veld, bijvoorbeeld ‘voornaam’ - komt name: voornaam dan meerdere keren voor, met telkens een verschillende reason?

  2. Hoe moet de type key gebruikt worden? In het voorbeeld is er een link naar validatie/Voornaam, maar wat bevat dit dan precies? Dit lijkt me te generiek omdat je als client-applicatie geen beslissingen kan maken op basis van dit type, en als het puur om het veld gaat, dan kan je uit name ook al afleiden om welk veld het gaat.

#2

Kenner is een groot woord, we proberen de RFC 7807 standaard te handhaven. Daar staat momenteel niks over meerdere validatiefouten op één veld, maar gezien de structuur kan dit wel meerdere keren voorkomen met dezelfde name. Wel een goede om hier iets over af te spreken!

Wat betreft type, dit moet een URI zijn naar een pagina met meer informatie. ZIe ook: RFC 7807 - Problem Details for HTTP APIs. Zoals ik het hier lees is dit niet bedoeld voor de client maar voor de developer van de client.

#3

Dankje! Ik ga voor nu dan uit van meerdere keren dezelfde name die voorkomt, dat maakt het makkelijkst voor client-applicaties om individuele fouten van elkaar te onderscheiden.

Dank voor de RFC link, ik had het al een keer eerder gezien, maar nu is het inderdaad opgefrist. Deze pagina’s kunnen we wel uit onze mouw schudden.

1 like