Module: Grape::DSL::Validations::ClassMethods
- Defined in:
- lib/grape/dsl/validations.rb
Instance Method Summary collapse
- #document_attribute(names, opts) ⇒ Object
-
#params { ... } ⇒ Object
Opens a root-level ParamsScope, defining parameter coercions and validations for the endpoint.
-
#reset_validations! ⇒ Object
Clears all defined parameters and validations.
Instance Method Details
#document_attribute(names, opts) ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 |
# File 'lib/grape/dsl/validations.rb', line 28 def document_attribute(names, opts) setting = description_field(:params) setting ||= description_field(:params, {}) Array(names).each do |name| full_name = name[:full_name].to_s setting[full_name] ||= {} setting[full_name].merge!(opts) namespace_stackable(:params, full_name => opts) end end |
#params { ... } ⇒ Object
Opens a root-level ParamsScope, defining parameter coercions and validations for the endpoint.
24 25 26 |
# File 'lib/grape/dsl/validations.rb', line 24 def params(&block) Grape::Validations::ParamsScope.new(api: self, type: Hash, &block) end |
#reset_validations! ⇒ Object
Clears all defined parameters and validations.
14 15 16 17 18 19 |
# File 'lib/grape/dsl/validations.rb', line 14 def reset_validations! unset_namespace_stackable :declared_params unset_namespace_stackable :validations unset_namespace_stackable :params unset_description_field :params end |