Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Als gebruiker wil ik de enumeratiewaarden in gebruikersvriendelijke teksten zien #174

Open
4 tasks
KayodeBakker opened this issue Jun 20, 2022 · 3 comments
Open
4 tasks
Assignees
Labels

Comments

@KayodeBakker
Copy link

...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 issue 828 en bij de BRK 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.

@KayodeBakker KayodeBakker added the enhancement New feature or request label Jun 20, 2022
@KayodeBakker
Copy link
Author

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

@CathyDingemanse
Copy link
Contributor

Done :-)

@JohanBoer
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants