Skip to content

Commit 196e5f1

Browse files
committed
Allow desc or description to be used for parameter descriptions
1 parent 2302e26 commit 196e5f1

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

lib/grape/validations/params_scope.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def validates(attrs, validations)
9797
coerce_type = validations[:coerce]
9898
doc_attrs[:type] = coerce_type.to_s if coerce_type
9999

100-
desc = validations.delete(:desc)
100+
desc = validations.delete(:desc) || validations.delete(:description)
101101
doc_attrs[:desc] = desc if desc
102102

103103
default = validations[:default]
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
require 'spec_helper'
2+
require 'pry'
23

34
describe Grape::Validations::ParamsScope do
5+
subject do
6+
Class.new(Grape::API)
7+
end
8+
9+
def app
10+
subject
11+
end
12+
13+
context 'setting description' do
14+
[:desc, :description].each do |description_type|
15+
it "allows setting #{description_type}" do
16+
subject.params do
17+
requires :int, type: Integer, description_type => 'My very nice integer'
18+
end
19+
subject.get '/single' do
20+
'int works'
21+
end
22+
get '/single', int: 420
23+
expect(last_response.status).to eq(200)
24+
expect(last_response.body).to eq('int works')
25+
end
26+
end
27+
end
428
end

0 commit comments

Comments
 (0)