Contents

# frozen_string_literal: true

require 'active_support/concern'

module Grape
  module DSL
    module Validations
      extend ActiveSupport::Concern

      include Grape::DSL::Configuration

      module ClassMethods
        # Clears all defined parameters and validations.
        def reset_validations!
          unset_namespace_stackable :declared_params
          unset_namespace_stackable :validations
          unset_namespace_stackable :params
          unset_description_field :params
        end

        # Opens a root-level ParamsScope, defining parameter coercions and
        # validations for the endpoint.
        # @yield instance context of the new scope
        def params(&block)
          Grape::Validations::ParamsScope.new(api: self, type: Hash, &block)
        end

        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
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
grape-1.3.3	lib/grape/dsl/validations.rb
grape-1.3.2	lib/grape/dsl/validations.rb
grape-1.3.1	lib/grape/dsl/validations.rb
grape-1.3.0	lib/grape/dsl/validations.rb