Issues rondom expand oplossen

[HenriKorver]

Scrumtaak

Als het goed is, is wordt het expand probleem nu structureel opgelost met PR #2377. Nu geeft de Zaken API OAS precies aan welke expands precies ondersteund worden, in het bijzonder de geneste expands van het zaaktype, zie

https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/catalogi-1_3_2/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml

Maar er zijn wellicht nog andere typen uit de Catalogi API die ik over het hoofd heb gezien: statustype, etc. Bovendien moet hetzelfde trucje herhaald worden voor de Documenten API.

Als laatst moet bovengenoemde oplossing nog gemerged worden met PR #2427.

Blijft nog het probleem dat expands op Arrays niet altijd goed gerenderd worden door Redoc.

[HenriKorver]

Let op: in branch catalogi-1_3_2 zijn zrc/1.5.x/1.5.2/openapi.yaml en zrc/current_version/openapi.yaml niet gelijk. De eerst genoemde is de goede versie maar omdat die niet goed werkt in de Redoc Viewer van Visual Studio Code (VSC) is de laatste versie verschillend gehouden zodat die wel werkt in VSC.

[HenriKorver]

Maar er zijn wellicht nog andere typen uit de Catalogi API die ik over het hoofd heb gezien: statustype, etc.

Ja klopt (roltype, eigenschap, statustype, etc), die heb ik nu ook aangepast in branch korver_develop.

Als laatst moet bovengenoemde oplossing nog gemerged worden met PR #2427.

Ook gedaan in branch korver_develop. Dit was een pittige klus vanwege vele merge conflicts. Uiteindelijk maar met het handje de twee PR's gecombineerd in korver_develop.

Bovendien moet hetzelfde trucje herhaald worden voor de Documenten API.

To do.

[HenriKorver]

Blijft nog het probleem dat expands op Arrays niet altijd goed gerenderd worden door Redoc.

Misschien valt het mee en is de manier waarop Redoc omgaat met de expansie van deelzaken en relevanteAndereZaken gewoon goed. Alleen jammer dat Redoc bij arrays niet expliciet het Recursive keyword laat zien zoals bij hoofdzaak als het een (oneindige) recursieve expand definitie betreft.

[HenriKorver]

Let op: in branch catalogi-1_3_2 zijn zrc/1.5.x/1.5.2/openapi.yaml en zrc/current_version/openapi.yaml niet gelijk. De eerst genoemde is de goede versie maar omdat die niet goed werkt in de Redoc Viewer van Visual Studio Code (VSC) is de laatste versie verschillend gehouden zodat die wel werkt in VSC.

In principe hebben we de current_version voor dit probleem niet meer nodig omdat de eerst genoemde versie wel te bekijken is met VSC Swagger Viewer. De vraag is waarom we current_version überhaupt nodig hebben omdat het heel moeilijk is om de current_version in sync te houden met de laatste versie. Dit gaat steeds mis en dan mislukt ook het goed bijhouden van de wijzigingsgeschiedenis van de current_version als we het daarvoor wilden gebruiken.

[HenriKorver]

Bovendien moet hetzelfde trucje herhaald worden voor de Documenten API.

Zie issue #2485.