search

VNG-Realisatie / API-Kennisbank

Afspraken, werkinstructies, tutorials, enz. voor de co-creatie en het beheer van API standaarden
https://vng-realisatie.github.io/API-Kennisbank/
6 stars 8 forks source link

Toevoegen van Parameters in een OAS3 #113

Open JohanBoer opened 3 years ago

JohanBoer commented 3 years ago

Als er parameters toegevoegd worden vanuti de doorontwikkeling van een API dan doen we dat door deze parameters na de laatste parameter van het betreffende endpoint toe te voegen. er worden geen parameters tussen bestaatnde parameters ingevoegd.

Ratio: Het tussenvoegen van deze parameters levert compileer- of genereer problemen op voor consumerdevelopers.

JohanBoer commented 3 years ago

JBo: Overnemen HK: RM: Overnemen. N.m.m. behoeft de ratio nog wel een betere uitleg. MV: GJ: JBi:

michielverhoef commented 3 years ago

JBo: Overnemen HK: RM: Overnemen. N.m.m. behoeft de ratio nog wel een betere uitleg. MV: Overnemen. GJ: JBi:

michielverhoef commented 3 years ago

NB. Een andere uitleg waarom we dit voorstel naar mijn mening moeten overnemen is denk ik dat wanneer je parameters tussen bestaande gaat plaatsen de aanroep verandert en je API dus breaking changes bevat. Dan is je API niet meer backwards compatible.

PS Ik heb nog wel een vraag. In veel programmeertalen kun je gebruik maken van named parameters. Vroeger deden we dat veel met Perl, ook met PHP en het kan ook in Python https://treyhunner.com/2018/04/keyword-arguments-in-python/

Dat zou het allermooiste zijn, dan maakt de volgorde niet meer uit maar kun je exact aangeven welke parameter(s) je meegeeft. Kan zoiets ook in een OAS? Dan is dit probleem uit de wereld.