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

Naamgeving van parameters niet consistent #414

Open
melsk-r opened this issue Jul 5, 2021 · 2 comments
Open

Naamgeving van parameters niet consistent #414

melsk-r opened this issue Jul 5, 2021 · 2 comments

Comments

@melsk-r
Copy link
Contributor

melsk-r commented Jul 5, 2021

De manier van naamgeving van de parameters in de diverse endpoints is niet consistent. Soms wordt lowerCamelCase toegepast en soms alleen lowercase. Zo wordt er in het endpoint '/adressen' voor gekozen om parameters zoals 'pandIdentificatie' in lowerCamelCase te definiëren. Aangezien inmiddels besloten is de Design Decision 1.5 te verwijderen is er geen reden meer om parameters juist in lowercase te specificeren. Dit speelt in de volgende endpoints:

  • /adressen/{nummeraanduidingidentificatie}'
  • /adresseerbareobjecten/{adresseerbaarobjectidentificatie}
  • /woonplaatsen/{woonplaatsidentificatie}
  • /openbareruimten/{openbareruimteidentificatie}
  • /nummeraanduidingen/{nummeraanduidingidentificatie}
  • /panden/{pandidentificatie}
@melsk-r melsk-r added the bug Something isn't working label Jul 5, 2021
@melsk-r melsk-r mentioned this issue Jul 5, 2021
@strijm
Copy link
Collaborator

strijm commented Oct 28, 2021

@melsk-r
Ik begrijp niet wat nu de bedoeling is van dit ticket. Moet er iets worden gewijzigd? Zo ja, wat en welke specificatie moet er worden gevolgd?

@fsamwel fsamwel removed the bug Something isn't working label Nov 5, 2021
@fsamwel
Copy link
Collaborator

fsamwel commented Nov 5, 2021

@strijm het gaat erom dat de pad-parameters in lower case en de query parameters in lowerCamelCase zijn gedefinieerd. Eigenlijk zouden de pad-parameters ook in lowerCamelCase moeten, zodat alle parameters volgens dezelfde conventie zijn opgesteld. Dit is een breaking change, dus kan pas mee als we een major release doen. Dit issue zelf is onvoldoende belangrijk om een major release voor te maken.
Dit is dus ook geen software bug, maar een "fout" in de specificaties. Ik heb het label Bug daarom verwijderd.

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

No branches or pull requests

3 participants