maykinmedia / open-klant

Registratiecomponent voor de opslag en ontsluiting van klantgegevens volgens de Klantinteracties API-specificatie.
Other
2 stars 3 forks source link

Filter parameters for GET `/partij-identificatoren` are incorrect in the `openapi.yaml` #257

Open anna-ritense opened 1 month ago

anna-ritense commented 1 month ago

Product versie / Product version

2.1.0+

Omschrijf het probleem / Describe the bug

The filter parameters described for the GET /pratij-identificatoren query are incorrect.

Actual filter parameters as seen in the code here are different.

There might be a serialization issue where snake_case is turned into camelCase when generating the openapi.yaml

Stappen om te reproduceren / Steps to reproduce

  1. Replace placeholders in following curl:
    curl -X GET --location "http://localhost:{{PORT}}/klantinteracties/api/v1/partij-identificatoren?partijIdentificatorCodeSoortObjectId={{BSN}}" \
    -H "Content-Type: application/json" \
    -H "Authorization: Token {{TOKEN}}"
  2. Run this curl command.
  3. Observe that documented filter doesn't work.

Verwacht gedrag / Expected behavior

It is really difficult and costly to implement an API spec that is wrong. This holds back adoption and causes frustration for those that do wish to use OpenKlant 2.X.X.