module Grape::DSL::Validations::ClassMethods

Public Instance Methods

document_attribute(names, opts) click to toggle source
# File lib/grape/dsl/validations.rb, line 26
def document_attribute(names, opts)
  setting = description_field(:params)
  setting ||= description_field(:params, {})
  Array(names).each do |name|
    setting[name[:full_name].to_s] ||= {}
    setting[name[:full_name].to_s].merge!(opts)

    namespace_stackable(:params, name[:full_name].to_s => opts)
  end
end
params(&block) click to toggle source

Opens a root-level ParamsScope, defining parameter coercions and validations for the endpoint. @yield instance context of the new scope

# File lib/grape/dsl/validations.rb, line 22
def params(&block)
  Grape::Validations::ParamsScope.new(api: self, type: Hash, &block)
end
reset_validations!() click to toggle source

Clears all defined parameters and validations.

# File lib/grape/dsl/validations.rb, line 12
def reset_validations!
  unset_namespace_stackable :declared_params
  unset_namespace_stackable :validations
  unset_namespace_stackable :params
  unset_description_field :params
end