Skip to content

Commit 86b367b

Browse files
authored
Fix documentation of false/nil default parameter values (#839)
* Fix documentation of false/nil default values * Update CHANGELOG
1 parent 52ba15f commit 86b367b

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
#### Fixes
88

9+
* #[#839](https://github.com/ruby-grape/grape-swagger/pull/839): Fixes documentation of `false` or `nil` default parameter values - [@magni-](https://github.com/magni-)
910
* Your contribution here.
1011

1112

lib/grape-swagger/doc_methods/parse_params.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def document_range_values(settings)
5151
end
5252

5353
def document_default_value(settings)
54-
@parsed_param[:default] = settings[:default] if settings[:default].present?
54+
@parsed_param[:default] = settings[:default] if settings.key?(:default)
5555
end
5656

5757
def document_type_and_format(settings, data_type)

spec/swagger_v2/boolean_params_spec.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ def app
99

1010
params do
1111
requires :a_boolean, type: Grape::API::Boolean
12+
optional :another_boolean, type: Grape::API::Boolean, default: false
1213
end
1314
post :splines do
1415
{ message: 'hi' }
@@ -27,7 +28,8 @@ def app
2728

2829
it 'converts boolean types' do
2930
expect(subject).to eq [
30-
{ 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true }
31+
{ 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true },
32+
{ 'in' => 'formData', 'name' => 'another_boolean', 'type' => 'boolean', 'required' => false, 'default' => false }
3133
]
3234
end
3335
end

0 commit comments

Comments
 (0)