Created by: zippolyte
Implement builder pattern to construct requests and pass all parameters. Similar construct as #4666
The motivation for this is to keep a client that will stay backward compatible in case some required parameters become optional which is not a breaking change in itself, but with the current implementation, it would change the method signature, thus introducing a breaking change in the client upon new generation.
Only path parameters are always required and any change would break the API itself, which is why I left them in the function signature. cf https://swagger.io/specification/#parameterObject:
Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true.
Additionally, this removes the use of the antihax/optional
module for query parameters, as we don't need the explicit null functionality here.
cf https://github.com/OpenAPITools/openapi-generator/issues/522#issuecomment-523896869
Any feedback/suggestion would be much appreciated.
PR checklist
-
Read the contribution guidelines. -
If contributing template-only or documentation-only changes which will change sample output, build the project before. -
Run the shell script(s) under ./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc). -
File the PR against the correct branch: master
,4.3.x
,5.0.x
. Default:master
. -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
cc @antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) @kemokemo (2018/09) @bkabrda (2019/07)