Aanpassingen foutafhandeling.feature beschrijving

[melsk-r]

Originally created by strijm (https://github.com/VNG-Realisatie/Haal-Centraal-common/issues/57):

Graag zien we een uitbreiding van de foutafhandeling feature met een scenario, waarbij uit een set van meerdere parameters er altijd maar één opgegeven kan worden voor de situatie dat er geen queryparameter wordt opgegeven.

Bv. bij de BAG /adressen endpoint kan één van de volgende parameters worden opgegeven:

• zoekresultaatIdentificatie
• adresseerbaarObjectIdentificatie
• pandIdentificatie

Als geen van deze parameters wordt opgegeven, dan moet er een 400 fout worden gegeven, maar het scenario:

Scenario: geen enkele zoekparameter opgegeven in zoekvraag Als ingeschrevenpersonen worden gezocht zonder parameters Dan is de http status code van het antwoord 400 En is in het antwoord title=Minimale combinatie van parameters moet worden opgegeven. En is in het antwoord status=400 En eindigt attribuut instance met /ingeschrevenpersonen En is in het antwoord code=paramsRequired En is in het antwoord title=Ten minste één parameter moet worden opgegeven En komt attribuut invalidParams niet voor in het antwoord

volstaat hier niet. De eerste title is niet van toepassing omdat het niet gaat om een combinatie van parameters maar slechts om één parameter. De tweede title is niet van toepassing omdat er niet tenminste één parameter maar precies één parameter opgegeven moet worden.

Ook de andere scenario's volstaan niet voor deze situatie.

[melsk-r]

This comment originally might have been created by someone else.

Ons voorstel is om onderstaande response te retourneren in de beschreven situatie. Indien HC hiermee akkoord is, kan de feature beschrijving hier dan op worden aangepast?

{ "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "detail": "Precies 1 parameter van pandidentificatie, adresseerbaarobjectidentificatie of zoekresultaatidentificatie moet worden opgegeven", "instance": "/lvbag/api/huidigebevragingen/v1/adressen/zoek", "code": "paramsRequired" }

Wij zijn hier voorlopig vanuit gegaan in de implementatie, mocht dit niet het gewenste resultaat zijn, dan horen we graag hoe de response er uit zou moeten zien.

[melsk-r]

This comment originally might have been created by someone else.

Besloten dat Frank een voorstel maakt voor een nieuw sceanrio en dat deze gereviewd wordt door Mark, Johan en Melvin. Mocht in de toekomst blijken, dat clients met meerdere query parameters moeten kunnen zoeken, dan kan dit later worden geïmplementeerd.