Skip to content

Conversation

sanderke
Copy link
Member

Voorzet voor regel voor datum en tijd

closes #195

@sanderke sanderke requested a review from TimvdLippe July 24, 2025 14:54
Copy link

@TimvdLippe TimvdLippe added Scope: Groot Grote wijziging met grote impact Status: In bewerking Het voorstel is in bewerking bij de beheerorganisatie. Type: Wijziging Inhoudelijke wijziging op een standaard Overleg: TO-API Te agenderen voor het Technisch Overleg API labels Aug 13, 2025
Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ziet er goed uit! 2 kleine wijzigingen, de rest lijkt mij voldoende om te bespreken in het TO.

@TimvdLippe
Copy link
Contributor

Willen we misschien ook nog bepaalde namen van velden vastleggen? Dus als er een datum is, dan moet het veld "date", "datum", "_date" of "_datum" heetten. En als het een timestamp is, dan moet het veld "timestamp", "tijdstip", "_timestamp" of "*_tijdstip" heetten.

Co-authored-by: Tim van der Lippe <[email protected]>
Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nog wat kleine fixes. De andere vragen moeten we offline even bespreken wat we daar mee willen.

@TimvdLippe
Copy link
Contributor

https://swagger.io/docs/specification/v3_0/data-models/data-types/#strings geeft aan dat openapi een "format": "date" volgens RFC 9557 kan aangeven.

Tevens lijkt RFC 9557 een restrictie te zijn op ISO8601 waarbij er minder mogelijkheden te zijn. Deze RFC is relevant voor internet protocollen, dus lijkt het beter om deze RFC te gebruiken ipv de ISO standaard.

Wat betreft de veldnamen laten we dat voor nu buiten de regel. We gaan dit op het TO bespreken of hier alsnog een restrictie op moet plaatsvinden.

De linter check laten we nog even achterwege, omdat we niet goed weten hoe je dit geautomatiseerd kan testen als we enkel een "type": "string" hebben in de openapi specification.

@TimvdLippe TimvdLippe added this to the ADR 2.2 milestone Aug 15, 2025
Co-authored-by: Tim van der Lippe <[email protected]>
@BvanRaaij
Copy link

Hi Tim, in de concept ADR staat dat alle datetimes het ISO 8601 format YYYY-MM-DDTHH:mm:ssZ moeten hebben. Ik vraag me af of dit handig is. De Z betekent Zulu time, ofwel UTC+00:00. Met de keuze voor dit format verplicht je dus iedereen alle data-tijden om te zetten in timezone +:00:00 (wat in de wintertijd 1 uur en in de zomertijd 2 uur verschilt met onze tijd) en weer terug. Het is misschien logischer (zeker met toepassingen die vooral in de Nederlandse context gebruikt worden) om het format YYYY-MM-DDTHH:mm:ss**+/-hh:mi** ook toe te staan of zelfs voor te schrijven

Verder detail: volgens mij schrijf je de uren als hh, niet als HH (zie https://www.w3.org/TR/NOTE-datetime).

<dl>
<dt>Statement</dt>
<dd>
<p>All date and time fields in requests and responses MUST follow [[RFC9557]] and thus be in [[ISO8601]] format (e.g., <code>YYYY-MM-DD</code> for dates, <code>YYYY-MM-DDTHH:mm:ssZ</code> for timestamps). Fields in responses containing timestamps MUST be in UTC (e.g. <code>Z</code> as offset). APIs MUST accept fields with timestamps with any time offset in requests and servers SHOULD normalize to (and store in) UTC.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ik zou expliciet maken welke onderdelen van ISO 8601 / RFC 3339 hier worden bedoeld, concreet:

  • full-date voor datum
  • date-time voor datum/tijd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Overleg: TO-API Te agenderen voor het Technisch Overleg API Scope: Groot Grote wijziging met grote impact Status: In bewerking Het voorstel is in bewerking bij de beheerorganisatie. Type: Wijziging Inhoudelijke wijziging op een standaard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rules voor Date en DateTime attributen

4 participants