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

uri-templating feature maken #55

Open
melsk-r opened this issue Jan 21, 2025 · 5 comments
Open

uri-templating feature maken #55

melsk-r opened this issue Jan 21, 2025 · 5 comments

Comments

@melsk-r
Copy link
Collaborator

melsk-r commented Jan 21, 2025

Originally created by samwel (kadaster/WOZ-bevragen#56):

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

@melsk-r
Copy link
Collaborator Author

melsk-r commented Jan 21, 2025

This comment originally might have been created by someone else.

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.

@melsk-r
Copy link
Collaborator Author

melsk-r commented Jan 21, 2025

This comment originally might have been created by someone else.

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

@melsk-r
Copy link
Collaborator Author

melsk-r commented Jan 21, 2025

This comment originally might have been created by someone else.

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}

@melsk-r
Copy link
Collaborator Author

melsk-r commented Jan 21, 2025

This comment originally might have been created by someone else.

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 ?

@melsk-r
Copy link
Collaborator Author

melsk-r commented Jan 21, 2025

This comment originally might have been created by someone else.

@ JohanBoer ik kan er niks over terugvinden, sorry.

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

No branches or pull requests

1 participant