developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

/core/error-handling/invalid-input

Een request met ongeldige invoer moet een 400 Bad Request opleveren. Daaronder vallen syntaxfouten en ontbrekende of ongeldige query parameters.

Alle fouten tegelijk​

Een aanverwante regel, /core/error-handling/all-errors, zegt dat een 400 bij voorkeur alle schemavalidatiefouten bevat en niet alleen de eerste. De linter controleert dit niet: of een API bij drie fouten drie meldingen teruggeeft, is niet uit de OAS te lezen.

Voor wie het invult: een afnemer die per ronde één fout terugkrijgt, heeft drie rondes nodig om een formulier goed te krijgen. Dat is precies de reden voor deze regel.

Uitdrukken in OAS​

Een 400 is geen response die je weg kunt laten omdat hij vanzelfsprekend is. Zet hem expliciet in de OAS, met application/problem+json conform /core/error-handling/problem-details.

/openapi.yaml
openapi: 3.1.0
paths:
/subsidieaanvragen:
post:
responses:
"201":
description: Aanvraag aangemaakt
"400":
description: Ongeldige aanvraag
content:
application/problem+json:
schema:
$ref: "https://static.developer.overheid.nl/schemas/adr/2.2/ProblemDetails.schema.json"