Skip to content

Conversation

@joostfarla
Copy link
Collaborator

@joostfarla joostfarla commented Oct 29, 2025

TBD:

  • Index vs multi-valued parameters vs collection styles
  • What is required / optional?
  • Can request and response encodings differ? JSON input, but XML output? (hopefully not)
  • Should API's evaluate the full request body, or may it stop after the first violation?

@TimvdLippe
Copy link
Contributor

FYI @joostfarla ik heb geforce-pusht naar zowel de base branch als jouw branch om de build te laten slagen. Helaas hebben we nog geen preview hiervan, want dat draait vooralsnog alleen op branches van Logius-standaarden repositories. Daar ga ik nog naar kijken.

@TimvdLippe
Copy link
Contributor

Nee helaas dat gaat niet werken, omdat de secrets.BEHEER niet mag worden gedeeld met pull requests van external contributors 😢

Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Goeie stap! Over de velden is nog wat onduidelijkheid, maar lijkt mij een goede richting dat dit op gaat.

<ul>
<li>For JSON request bodies: an object with a <code>pointer</code> property containing a JSON Pointer [[rfc6901]] expression pointing to the value.</li>
<li>For XML request bodies: an element with a <code>path</code> attribute containing an absolute XPath v3.1 [[xpath-31]] expression pointing to the value.</li>
<li>For query parameters: an object with a <code>name</code> property (the parameter name). When the same name appears multiple times, include an <code>index</code> property, containing a zero-based index position.</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ik zou de index altijd includen. Ook al is het er 1, dan is het in ieder geval duidelijk dat de index 0 is.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Multi-valued query parameters zijn zeldzaam in de praktijk. Vandaar was mijn voorstel om index alleen op te nemen voor de uitzonderingsgevallen (om bloating te voorkomen). Je zou kunnen stellen dat een index voor single-valued parameters niet van toepassing is.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Persoonlijk vind ik duidelijkheid belangrijker dan bloating bij errors. Zeker omdat errors niet zo vaak voorkomen, zie ik bloating minder als een factor. Daarom zou mijn voorkeur zijn om consistentie na te streven, ook in het kader van het checken of het schema wel voldoet. Mochten anderen daar toch anders over denken, dan kan dat natuurlijk ook. My 2 cents.

Copy link
Collaborator Author

@joostfarla joostfarla Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bij POST/PUT komen (meerdere) errors denk ik vaak genoeg voor. Waar we misschien nog wel iets over zouden moeten zeggen is of servers een request body volledig zouden moeten evalueren (alle properties valideren) ipv stoppen met valideren na de eerste fout. In het laatste geval krijg je ping-pong communicatie, wat niet heel effifiënt is. Of we besluiten dit open te laten, maar hoe dan ook goed om hier een statement over op te nemen. Heb het toegevoegd aan de TBD-punten in de description van dit PR.

@TimvdLippe
Copy link
Contributor

Is het goed om deze PR te mergen in de hoofd PR en daar de discussie verder te houden? Of wil je liever de TBD eerst nog oplossen? Mij maakt de volgorde minder uit, zolang de discussie maar op 1 plek plaats vindt.

@joostfarla
Copy link
Collaborator Author

Is het goed om deze PR te mergen in de hoofd PR en daar de discussie verder te houden? Of wil je liever de TBD eerst nog oplossen? Mij maakt de volgorde minder uit, zolang de discussie maar op 1 plek plaats vindt.

Merge maar, zolang je de TBDs ook mee overhevelt naar het andere issue 👍

@TimvdLippe TimvdLippe merged commit 8db1b25 into Logius-standaarden:rfc9457 Oct 30, 2025
14 checks passed
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

Successfully merging this pull request may close these issues.

2 participants