Nederlandstalige API + Datamodel

[alextreme]

Gebruikersverhaal

Als gemeentelijke ontwikkelaar wil ik dat de Open Producten API en het bijbehorende datamodel volledig Nederlandstalig zijn, zodat ik gemakkelijk begrijpbare integraties kan realiseren en de gegevens optimaal kan benutten binnen onze bestaande systemen zonder vertalingsproblemen. Dit sluit aan bij de gebruiksvriendelijkheid voor Nederlandse gemeenten en overheidsinstanties die de API implementeren.

Acceptatiecriteria

Nederlandstalige endpoints en veldnamen

• Alle API endpoints zijn in het Nederlands geformuleerd.
• Datamodel-veldnamen zijn in het Nederlands consistent toegepast, zoals naam, beschrijving, status, producttype, etc.

Duidelijke documentatie in het Nederlands

• De API-documentatie, inclusief toelichting op de velden, datatypen en voorbeelden van API-aanvragen en -antwoorden, is volledig in het Nederlands beschikbaar.
• De documentatie bevat relevante use-cases voor Nederlandse overheidsinstanties.

Nederlandse foutmeldingen en response codes

• Alle foutmeldingen zijn vertaald naar het Nederlands met duidelijke en begrijpelijke uitleg.
• Response codes blijven conform de internationale standaarden (bijv. 200, 404, 500) maar met Nederlandse toelichting bij foutmeldingen.

Ondersteuning voor Nederlandstalige invoer

• Velden die teksten bevatten zoals titel, omschrijving, inhoud, en parameters ondersteunen zowel Nederlandse tekens als taalregels.
• API datum en datum+tijd notaties dienen conform ISO 8601 te zijn

Data terugkoppeling en validatie in het Nederlands

• Bij validatiefouten geeft de API duidelijke Nederlandstalige foutmeldingen terug (bijv. "Veld 'naam' is verplicht").

Definition of Done (DoD)

• De API en het datamodel zijn volledig Nederlandstalig geïmplementeerd.
• Unit tests en integratietests zijn uitgevoerd met Nederlandstalige invoer en output.
• Documentatie en voorbeelden zijn geschreven en gepubliceerd in het Nederlands.

[alextreme]

@Floris272 bij deze alvast de eerste user story, wat mij betreft hoef je niet door te bouwen op je Open Producten prototype en kunnen we met een schone 'default project' lei beginnen. Wel is het datamodel zoals we die hadden een goed uitgangspunt, mits we deze NL-talig opzetten

[joeribekker]

Refinement: Discussed that dates (and times) should adhere to ISO standards.