Skip to content

Fix entity data type identification #1863

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix entity data type identification #1863

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
820f029
Fix entity data type identification
fotos Feb 12, 2019
2080870
Update CHANGELOG
fotos Feb 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix entity data type identification 
The gem `grape-swagger` uses the `type` documentation parameter in order
to identify the entity name. When the type (class) is stringified
`grape-swagger` cannot check for method existance and falls back to
taking the last module as the name.
  • Loading branch information
@fotos
fotos committed Feb 12, 2019
commit 820f029d9a005eca101616d7358c845eb459fe58
2 changes: 1 addition & 1 deletion lib/grape/dsl/inside_route.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def should_be_empty_array?(declared_param, passed_children_params)
end

def declared_param_is_array?(declared_param)
route_options_params[declared_param.to_s] && route_options_params[declared_param.to_s][:type] == 'Array'
route_options_params[declared_param.to_s] && route_options_params[declared_param.to_s][:type] <= Array
end

def route_options_params
Expand Down
2 changes: 1 addition & 1 deletion lib/grape/validations/params_scope.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ def validates(attrs, validations)

coerce_type = infer_coercion(validations)

doc_attrs[:type] = coerce_type.to_s if coerce_type
doc_attrs[:type] = coerce_type if coerce_type

desc = validations.delete(:desc) || validations.delete(:description)
doc_attrs[:desc] = desc if desc
Expand Down
6 changes: 3 additions & 3 deletions spec/grape/api_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2795,10 +2795,10 @@ def static
subject.get 'method'

expect(subject.routes.map(&:params)).to eq [{
'group1' => { required: true, type: 'Array' },
'group1' => { required: true, type: Array },
'group1[param1]' => { required: false, desc: 'group1 param1 desc' },
'group1[param2]' => { required: true, desc: 'group1 param2 desc' },
'group2' => { required: true, type: 'Array' },
'group2' => { required: true, type: Array },
'group2[param1]' => { required: false, desc: 'group2 param1 desc' },
'group2[param2]' => { required: true, desc: 'group2 param2 desc' }
}]
Expand All @@ -2818,7 +2818,7 @@ def static
{ description: 'nesting',
params: {
'root_param' => { required: true, desc: 'root param' },
'nested' => { required: true, type: 'Array' },
'nested' => { required: true, type: Array },
'nested[nested_param]' => { required: true, desc: 'nested param' }
} }
]
Expand Down