param: Consider default_value: nil as valid config #894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When using `param` as: ```ruby param(:name, String, required: false, default_value: nil) ``` there would be a warning that `default_value` is missing. This fix changes from checking `options[key].blank?` to `options.key?(key)`.
davidwessman
commented
Jul 31, 2023
| @@ -71,7 +71,7 @@ def for_required | |||
| end | |||
|
|
|||
| def for_default | |||
| return {} if @param_description.options[:default_value].blank? | |||
There was a problem hiding this comment.
Should we combine this with the allow_nil and allow_blank to only allow
default: nilwhenallow_nil: trueanddefault: ""whenallow_blank: true?
There was a problem hiding this comment.
No, I don't think they should be combined.
PanosCodes
approved these changes
Jul 31, 2023
spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
Outdated
Show resolved
Hide resolved
spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
Outdated
Show resolved
Hide resolved
spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
Outdated
Show resolved
Hide resolved
PanosCodes
approved these changes
Aug 4, 2023
mathieujobin
approved these changes
Aug 9, 2023
|
@mathieujobin Could we get a release of this? 🙂 |
|
sure, sorry for the delay on this. will be in v1.2.3 shortly |
No worries, just a small fix. Thank you 👏🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using
paramas:there would be a warning that
default_valueis missing.This fix changes from checking
options[key].blank?tooptions.key?(key).