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.

Sign up for GitHub

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

Jump to bottom

Support nullable parameters #197

Merged
merged 5 commits into from Mar 31, 2016
Merged

Support nullable parameters #197

merged 5 commits into from Mar 31, 2016

Conversation

rafaelcaricio
Copy link
Collaborator

Partially solves #182.

Add support to x-nullable vendor extension in Connexion. It is a ongoing discussion in OpenAPI spec, but requested by users of Connexion and acknowledged as a valid use case.

Changes proposed in this pull request:

  • Add support for attribute x-nullable flag in parameter definitions.
  • Add documentation for x-nullable flag usage.

@rafaelcaricio rafaelcaricio changed the title Accept nullable values Support nullable parameters Mar 25, 2016
@coveralls
Copy link

Coverage Status

Coverage increased (+0.009%) to 99.441% when pulling 795dc6e on rafaelcaricio:accept-nullable-values into 5e5d97e on zalando:master.

jmcs
jmcs reviewed Mar 27, 2016
View reviewed changes
docs/request.rst
Sometimes your API should explicitly accept _`nullable parameters`. However
OpenAPI specification currently does _`not support` officially a way to serve
this use case, Connexion adds the `x-nullable` vendor extension to parameter
definitions. It's usage would be:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a note saying than if/when a future version of OpenAPI defines an option for this, we will deprecate this extension.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I will add that.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.01%) to 99.443% when pulling 87111d3 on rafaelcaricio:accept-nullable-values into 5e5d97e on zalando:master.

@jmcs
Copy link
Contributor

jmcs commented Mar 30, 2016

👍

@rafaelcaricio
Copy link
Collaborator Author

Can we merge this PR?

@rafaelcaricio rafaelcaricio mentioned this pull request Mar 31, 2016
Closed
@jmcs jmcs merged commit ddcb4ce into spec-first:master Mar 31, 2016
@jmcs jmcs removed the in progress label Mar 31, 2016
@rafaelcaricio rafaelcaricio deleted the accept-nullable-values branch March 31, 2016 13:19
@allan-silva allan-silva mentioned this pull request Aug 2, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jmcs jmcs

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@rafaelcaricio @coveralls @jmcs