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

Als beheerder wil ik graag dat het zeer helder is voor ontwikkelaars welke versie van de API documentatie/RI deze bekijkt #1443

Open melsk-r opened 5 years ago

melsk-r commented 5 years ago

...zodat de kans dat er per ongeluk op een ongewenste versie wordt ontwikkeld verkleind wordt.

Op dit moment bevatten pagina's als https://zaken-api.vng.cloud/ en https://zaken-api.test.vng.cloud/ alleen onderin een subtiele indicatie van de versie. Dit moet prominenter in beeld zodat dit meteen opvalt. Het volgende voorbeeld is al veel beter: image

Nog betere ideeën zijn natuurlijk welkom.

melsk-r commented 5 years ago

Bij nader inzien ben ik van mening dat het onderscheid tussen het stable en testdomein nog nadrukkelijker tot uiting mag worden gebracht dan in het door mij aangedragen voorbeeld. Het zou wat overdreven zijn de achtergrond van het testdomein rood te maken aangezien dat niet meer werkbaar is maar het illustreert wel wat ik daarmee bedoel.

Daarnaast vind ik dat ook duidelijk moet zijn of in het testdomein al wijzigingen zijn opgenomen t.o.v. het stable domein. Een ontwikkelaar die graag met beta versies speelt kan daardoor direct opmaken of het nut heeft met een beta versie aan de gang te gaan.