search

VNG-Realisatie / Haal-Centraal-WOZ-bevragen

Project repository tbv de ontwikkeling van de Haal Centraal WOZ Bevragen API
https://vng-realisatie.github.io/Haal-Centraal-WOZ-bevragen/
Other
0 stars 2 forks source link

uri-templating feature maken #85

Open fsamwel opened 3 years ago

fsamwel commented 3 years ago

De opbouw van templates voor links is in de WOZ API anders dan voor de andere Haal Centraal API's. Daarom kan hiervoor niet verwezen worden naar de feature in Haal-Centraal-Common.

Dus moet er een specifieke uri-templating.feature voor WOZ-bevragen worden gemaakt, waarin een underscore als prefix wordt gebruikt

JohanBoer commented 3 years ago

Zijn deze verschillen dan ook echt nodig ? Is er een goede reden waarom het in de WOZ anders wordt gedaan dan in de feature in Haal-Centraal-Common is beschreven. Ik weet niet of het toegevoegde waarde heeft om hier consistentie in aan te brengen en hoeveel moeite dat voor het WOZ_team kost.

fsamwel commented 3 years ago

zit in het framework dat ze gebruiken die de punt niet toestaat. @MelvLee gaf aan dat dit niet uitmaakt. als je twijfelt kan je het aan het WOZ team vragen (via Slack bijvoorbeeld).

MelvLee commented 3 years ago

Het zal vast wel kunnen dat je middels configuratie kan aangeven hoe je url templating wilt, maar ik vraag mij af of we het willen beperken. rfc6570 zegt dat zowel . als _ in je variabele namen mag worden gebruikt. Het lijstje van unreserved karakters is te vinden in: https://datatracker.ietf.org/doc/html/rfc6570#section-1.5. Op dit moment gebruiken we (nog) de meest simpele vorm van url templating, maar als we query string parameter willen templaten, dan lopen we spaak bij BRP bevragen. Dan kunnen we bijv. het volgende niet meer templaten: /ingeschrevenpersonen{?naam__geslachtsnaam}

JohanBoer commented 1 year ago

We hebben bij het controleren van deze issue geconstateerd dat er geen testgevallen zijn die templated links retourneren. We kunnen nergens een expliciete uitspraak in een issue vinden dat we voor de WOZ geen templated links toepassen, maar er is wel over de werking van templated links gediscussieerd.

We veronderstellen dat uiteindelijk de complexiteit rond de punt en underscore ertoe geleid heeft templated links niet te implementeren. Mocht uit de community voor het gebruik van deze API straks de behoefte aan templated links naar boven komen, dan gaan we de feature voor templated links binnen de WOZ-API beschrijven.

@CathyDingemanse @fsamwel @Melvlee : Kunnen jullie je nog herinneren of hier een expliciete keuze in is gemaakt ?

CathyDingemanse commented 1 year ago

@JohanBoer ik kan er niks over terugvinden, sorry.