melsk-r / HC-BAG-bevragen-issues

0 stars 0 forks source link

Naamgeving van parameters niet consistent #260

Open melsk-r opened 4 months ago

melsk-r commented 4 months ago

Originally created by melsk-r (https://github.com/VNG-Realisatie/BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen/issues/414):

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:

melsk-r commented 4 months ago

This comment originally might have been created by someone else.

@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?

melsk-r commented 4 months ago

This comment originally might have been created by someone else.

@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.