Als gebruiker wil ik de enumeratiewaarden in gebruikersvriendelijke teksten zien

[melsk-r]

Originally created by KayodeBakker (kadaster/WOZ-bevragen#174):

...zodat er niet allerlei conversies hoeft plaats te vinden om dit mooi leesbaar te maken. Enumeraties met bijv. waarde 'bezwaar_veranderd' waar het eigenlijk '12: bezwaar afgehandeld, vastgestelde waarde veranderd.' had moeten zijn.

Nu wordt er verwacht van afnemers om dit voor eigen gebruikers recht te zetten terwijl dit idealiter in de API al recht wordt gezet.
Het meest ideale voorbeeld van een oplossing is dat enumeraties in een waardetabel formaat komen (code is enum, omschrijving is string), maar dat zou een breaking change zijn. Alternatief zou zijn dat op niveau vanwaar een enum staat een omschrijving string property wordt toegevoegd als vertaling. In de omschrijving van de enum kan hiernaar worden verwezen.

Dit is eerder ook besproken bij de BRP API bij BRP-API/Haal-Centraal-BRP-bevragen#828 en bij de BRK API bij kadaster/BRK-bevragen#946.

Acceptatiecriteria

Enumeratiewaarden krijgen een gebruikersvriendelijke tekst
Definition of done

functionele specificatie

Open API specificatie

gegenereerde code

testgevallen
Let op. Ditzelfde geldt eigenlijk ook voor andere registraties.

[melsk-r]

This comment originally might have been created by someone else.

@ CathyDingemanse @ JohanBoer
Ik kan geen assignments doen hier aangezien ik nog niet eerder bij de WOZ Github een issue heb aangemaakt.

[melsk-r]

This comment originally might have been created by someone else.

Done :-)

[melsk-r]

This comment originally might have been created by someone else.

Het wijzigen van enumeratiewaarden leidt tot een breaking change. Alleen voor deze wijziging willen we de huidige afnemers niet confronteren met een breaking change. Staat getagd voor de eerstvolgende major change.