Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Toevoegen van Parameters in een OAS3 #113

Open
JohanBoer opened this issue Jun 10, 2021 · 3 comments
Open

Toevoegen van Parameters in een OAS3 #113

JohanBoer opened this issue Jun 10, 2021 · 3 comments
Labels
Design Rule Bespreekpunten om al dan niet op te nemen in de VNG-Design Rules

Comments

@JohanBoer
Copy link
Collaborator

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 JohanBoer added the Design Rule Bespreekpunten om al dan niet op te nemen in de VNG-Design Rules label Jun 10, 2021
@JohanBoer
Copy link
Collaborator Author

JohanBoer commented Jun 10, 2021

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

@michielverhoef
Copy link
Contributor

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

@michielverhoef
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design Rule Bespreekpunten om al dan niet op te nemen in de VNG-Design Rules
Projects
None yet
Development

No branches or pull requests

2 participants