developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

/core/date-time/format

Alle datum-, datumtijd- en tijdvelden in requests en responses volgen RFC 9557 en ISO 8601-1. In de OpenAPI-beschrijving krijgt zo'n veld altijd "type": "string" en een format uit de tabel hieronder.

Soort veldISO 8601OpenAPI-format
Datumfull-date"format": "date"
Datumtijddate-time"format": "date-time"
Tijdpartial-time"format": "time-local"

Een integer met een epoch-waarde voldoet niet, ook niet als de omschrijving uitlegt wat het betekent. De format is wat een client laat weten hoe hij het veld moet lezen.

Uitdrukken in OAS​

/openapi.yaml
openapi: 3.1.0
components:
schemas:
Subsidieaanvraag:
type: object
properties:
ingediendOp: # goed
type: string
format: date-time
aanvraagdatum: # goed, tijd is niet relevant
type: string
format: date
zittingstijd: # goed, alleen een kloktijd
type: string
format: time-local
verwerktOp: # fout, een epoch-getal is geen string met format
type: integer