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

Uniformiteit in __in query parameters #2438

Open
frank1230873 opened this issue Mar 26, 2024 · 3 comments
Open

Uniformiteit in __in query parameters #2438

frank1230873 opened this issue Mar 26, 2024 · 3 comments
Labels

Comments

@frank1230873
Copy link

Bug

https://github.com/VNG-Realisatie/gemma-zaken/blob/master/api-specificatie/zrc/current_version/openapi.yaml regel 6581 (query parameter archiefnominatie__in). Hier is het type van de __in parameter een array.

https://github.com/VNG-Realisatie/gemma-zaken/blob/master/api-specificatie/ztc/current_version/openapi.yaml regel 1251 (query parameter domein__in). Hier is het type van de __in parameter een string.

Graag zou ik hier uniformiteit in zien zodat we in beide situaties de afhandeling gelijk kunnen trekken. Mijn persoonlijke voorkeur gaat uit naar string, omdat dotnet (onze implementatie) niet goed met de array om kan gaan. Maar de uniformiteit is het belangrijkst :).

@frank1230873 frank1230873 added the bug Iets werkt niet zoals bedoeld label Mar 26, 2024
@frank1230873
Copy link
Author

Ik zie nu dat het ook voor de ordering query parameter geldt :). Ik denk dat die op dezelfde manier zou moeten werken als een __in filter

@HenriKorver
Copy link
Collaborator

HenriKorver commented Mar 27, 2024

Beide stijlen (als type string of array) om een comma seperated list van waarden te specificeren voor een query parameter zijn toegestaan. De laatste stijl (array) is volgens mij het beste en die is blijkbaar pas later in gebruik genomen waardoor er nu twee verschillende stijlen zijn die in de OAS gebruikt worden. Ik zie dit niet als een bug omdat deze inconsistentie van specificatie-stijl geen invloed heeft op de standaard. Al zouden we de stijlen willen rechttrekken in een volgende versie dan zou ik kiezen voor array.

Vreemd trouwens dat de dotnet tooling last heeft van array want dat is veel explicieter dan type string. In geval van type Array kan de codegenerator meteen weten dat ie comma sperated list moet genereren voor query parameters met meerdere waarden.

@HenriKorver HenriKorver removed the bug Iets werkt niet zoals bedoeld label Mar 27, 2024
@frank1230873
Copy link
Author

Het probleem met dotnet zit niet in de generatie, want die geeft wel mooi een array terug. Maar als er vervolgens een waarde "test1,test2" wordt meegegeven, dan komt het geheel in het eerste element terecht. Ik zal eens zoeken waar dat aan kan liggen.

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

No branches or pull requests

2 participants