search

VNG-Realisatie / gemma-zaken

Samen ontwikkelen van API's voor Zaakgericht werken
https://vng-realisatie.github.io/gemma-zaken/
Other
41 stars 27 forks source link

Gegenereerde OAS mag niet publiekelijk zichtbaar zijn #2424

Open HenriKorver opened 8 months ago

HenriKorver commented 8 months ago

Bug

Via de veelgebruikte openbare link https://zaken-api.vng.cloud is de genereerde versie van de OAS van de Zaken API te zien (klik hier). Deze OAS is gegenereerd vanuit de code van de referentie-implementatie voor technische doeleinden. Echter deze OAS is niet normatief, incompleet en bevat zelfs fouten. Dit kan tot misverstanden leiden als de bezoeker hiervan niet op de hoogte is.

De normatieve en goede OAS van de Zaken API is hier te vinden: https://vng-realisatie.github.io/gemma-zaken/standaard/zaken.

Zelfde probleem geldt ook voor de andere ZGW API's: Documenten API, Besluiten API, etc.

michielverhoef commented 7 months ago

Waarom niet? De RI is een implementatie van de standaard en moet, volgende landelijke api strategie, de bijbehorende OAS ontsluiten.

Voordeel van de OAS wel zichtbaar maken/laten is dat eventuele verschillen tussen de standaard en de RI beter inzichtelijk te maken zijn, verwacht ik. Overigens zouden er geen verschillen mogen zijn, maar als ze er zijn wil je dat wel kunnen aantonen.