Als gebruiker wil ik de enumeratiewaarden in gebruikersvriendelijke teksten zien

[melsk-r]

Originally created by KayodeBakker (https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues/946):

...zodat er niet allerlei conversies hoeft plaats te vinden om dit mooi leesbaar te maken. Enumeraties met bijv. waarde 'artikel5_3b' waar het eigenlijk 'Zakelijk gerechtigde als bedoeld in artikel 5, lid 3, onder b, van de Belemmeringenwet Privaatrecht op gedeelte van perceel.' 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 issue 828 en bij de WOZ API bij issue 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.

thnx Kayo!