/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 veld | ISO 8601 | OpenAPI-format |
|---|---|---|
| Datum | full-date | "format": "date" |
| Datumtijd | date-time | "format": "date-time" |
| Tijd | partial-time | "format": "time-local" |
- Regel: https://gitdocumentatie.logius.nl/publicatie/api/adr/#/core/date-time/format
- Linterregels:
nlgov:specify-format-for-date-and-time
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
- YAML
- JSON
/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
/openapi.json
{
"openapi": "3.1.0",
"components": {
"schemas": {
"Subsidieaanvraag": {
"type": "object",
"properties": {
"ingediendOp": { "type": "string", "format": "date-time" },
"aanvraagdatum": { "type": "string", "format": "date" },
"zittingstijd": { "type": "string", "format": "time-local" }
}
}
}
}
}