Beste Locatieserver gebruiker(s),
Zonder goede afspraken omtrent versionering is het momenteel niet mogelijk om nieuwe versies van de Locatieserver uit te brengen, zonder dat bestaande applicaties hiervan last zullen krijgen. Om die reden willen wij versionering introduceren. Hieronder meer informatie. We waarderen uw input dus willen de gelegenheid geven voor opmerkingen of aanvullingen. We willen het voorstel graag op donderdag 30 maart aanstaande bekrachtigen dus horen graag voor die tijd van u. Alvast bedankt!
Huidige situatie:
In december van afgelopen jaar heeft PDOK die nieuwe Locatieserver beschikbaar gesteld aan het publiek. De nieuwe Locatieserver wordt in de loop van de tijd aangevuld met nieuwe datasets (databronnen) en waar nodig worden er verbeteringen doorgevoerd. Dit leidt het uitbrengen van nieuwe versies van de Locatieserver. Het uitbrengen van nieuwe versies kan leiden tot implicaties bij bestaande applicaties of software die gebruik maken van de Locatieserver van PDOK. Zonder afspraken omtrent versionering is het momenteel niet mogelijk om nieuwe versies van de Locatieserver uit te brengen, zonder dat bestaande applicaties hiervan last zullen krijgen.
Nieuwe situatie:
Gewenst is om versionering aan te gaan brengen indien nieuwe versies leiden tot aanpassingen bij gebruikers. De Locatieserver heeft drie type services die men kan bevragen (suggestservice, lookupservice en freeservice). Al deze services hebben een eigen URL en kennen de volgende opbouw:
http(s)://geodata.nationaalgeoregister.nl/locatieserver/servicetype/
Het voorstel is om bij het uitbrengen van nieuwe versies van de Locatieserver nieuwe URL’s beschikbaar te stellen (per type service) waarin een versienummer is opgenomen die bij elke release opgehoogd wordt. Door gebruik te maken van het bestaande locatieserver-endpoint, hoeven afnemers niet bij iedere release nieuwe wijzigingen door te voeren binnen hun infrastructuur (firewall, proxy, e.d.). Dit zal dan leiden tot de volgende URL opbouw:
http(s)://geodata.nationaalgeoregister.nl/locatieserver/versienummer/servicetype/
Een voorgaande URL (voorgaand versienummer) blijft in zo’n geval bestaan, zodat afnemers de tijd krijgen om over te gaan naar de nieuwe URL. Op de nieuwe URL vindt men de gewijzigde situatie. Deze nieuwe URL is waar naar men over dient te gaan, maar doordat de oude beschikbaar blijft, kan men dit inplannen. PDOK stelt nooit meer dan 2 versies beschikbaar maar zorgt wel dat er voldoende tijd zit tussen het uitbrengen van nieuwe versies zodat oude versies niet heel snel verdwijnen. Daarnaast worden beide versies geupdate indien mogelijk.