Zoek op adres restful (zonder zoekresultaat als tussenstap) #386
Conversation
| @@ -499,11 +501,12 @@ components: | |||
| description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." | |||
| name: zoek | |||
| in: query | |||
| required: true | |||
| required: false | |||
There was a problem hiding this comment.
zie mijn opmerking in het issue VNG-Realisatie/Haal-Centraal#74 (comment)
- op deze plek wil je het wel required houden
- de nieuwe zoek-parameter moet ook minLength: 0 en maxLength: 255 krijgen
There was a problem hiding this comment.
De zoek parameter kan hier niet verplicht zijn, omdat er bij dit /adressen endpoint meerdere mogelijkheden zijn om te zoeken:
- met een query parameter pand identificatie OF
- met een query parameter adresseerbaar object identificatie OF
- met 'fuzzy search' / zoek query parameter
Als zoek verplicht zou worden dan zou bij het zoeken met pand identificatie of adresseerbaar object identificatie ook altijd een zoek parameter opgegeven moeten worden en dat lijkt me niet de bedoeling.
Als zoek een verplichte query parameter moet worden, dan is er maar één mogelijkheid: een apart (nieuwe) endpoint specificeren.
JohanBoer
changed the base branch from
develop
to
features/restfull-fuzzy-adres
| @@ -499,11 +501,12 @@ components: | |||
| description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." | |||
| name: zoek | |||
| in: query | |||
| required: true | |||
| required: false | |||
There was a problem hiding this comment.
De zoek parameter kan hier niet verplicht zijn, omdat er bij dit /adressen endpoint meerdere mogelijkheden zijn om te zoeken:
- met een query parameter pand identificatie OF
- met een query parameter adresseerbaar object identificatie OF
- met 'fuzzy search' / zoek query parameter
Als zoek verplicht zou worden dan zou bij het zoeken met pand identificatie of adresseerbaar object identificatie ook altijd een zoek parameter opgegeven moeten worden en dat lijkt me niet de bedoeling.
Als zoek een verplichte query parameter moet worden, dan is er maar één mogelijkheid: een apart (nieuwe) endpoint specificeren.
specificatie/openapi.yaml
Outdated
| @@ -82,6 +83,7 @@ paths: | |||
| - $ref: '#/components/parameters/pandIdentificatie-query' | |||
| - $ref: '#/components/parameters/adresseerbaarObjectIdentificatie-query' | |||
| - $ref: '#/components/parameters/zoekresultaatIdentificatie' | |||
| - $ref: '#/components/parameters/zoek' | |||
There was a problem hiding this comment.
De beschrijving voor de zoek functionaliteit uit de description bij /adressen/zoek, moet hier worden opgenomen.
There was a problem hiding this comment.
@JohanBoer deze zijn we vergeten over te nemen!
Ik zou er zoiets van maken:
"Vind een actueel adres met:
- een pand identificatie of
- een adresseerbaar object identificatie of
- een zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging.
Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie functionele specificaties fields-parameter. Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats en openbare ruimte, zie functionele specificaties expand-parameter."
|
Sinds deze wijziging is opgesteld zijn er 153 wijzigingen op de master doorgevoerd. De wijzigingen die we hier beogen gaan we op een "verse" branch van de master doorvoeren met een nieuw pull request. |
EERST BESPREKEN VOORDAT DEZE PULL REQUEST WORDT GEMERGED
Parameter "zoek" wordt toegevoegd aan endpoint "/adressen"
Parameter "zoekresultaatIdentificatie" wordt deprecated bij endpoint "/adressen"
Endpoint "/adressen/zoek" wordt deprecated
Parameter-component "zoek" wordt required: false (Heeft non-breaking impact op deprecated endpoint "/adressen/zoek")
Schema-component "ZoekResultaat" wordt deprecated
Schema-component "ZoekResultaatHal" wordt deprecated
Schema-component "ZoekResultaat_links" wordt deprecated
Schema-component "ZoekResultaatHalCollectie" wordt deprecated