Skip to content

Conversation

@fvarose
Copy link
Contributor

@fvarose fvarose commented Nov 14, 2017

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR adds support for optional parameters (those marked as required: false in a swagger spec) using boost::optional.
Users of the client code can now pass boost::none to API calls for any optional parameters they are not interested in using.

Notes:

  • in: path params are not covered because they cannot be optional (see OpenAPI spec).
  • in: body params are also not covered, as the implementation would be less trivial. The current behaviour for those params doesn't change, i.e. they are always required to make a call.
  • This doesn't add any new linking dependencies as boost::optional is header-only, and boost itself is already required to compile the generated client code.

@fvarose
Copy link
Contributor Author

fvarose commented Nov 14, 2017

cc @stkrwork @ravinikam

@wing328 wing328 added this to the v2.3.0 milestone Nov 14, 2017
@wing328
Copy link
Contributor

wing328 commented Nov 22, 2017

@fvarose thanks for the enhancemnet.

@ravinikam thanks for reviewing the change.

@wing328 wing328 merged commit d9cea0f into swagger-api:master Nov 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants