Module: RailsApiDoc::Controller::Parameter

Defined in:
lib/rails_api_doc/controller/parameter.rb

Overview

author: Vadim Shaveiko <@vshaveyko>

Defined Under Namespace

Classes: Repository

Constant Summary collapse

VALID_KEYS =

:nodoc:

[:type, :required, :enum, :model].freeze

Instance Method Summary collapse

Instance Method Details

#parameter(name, options, &block) ⇒ Object

Use parameter in controller to defined REQUEST parameter. Adds it to repository: RailsApiDoc::Controller::Parameter::Repository

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
 
# File 'lib/rails_api_doc/controller/parameter.rb', line 9

def parameter(name, options, &block)
  raise ArgumentError, 'Parameter already defined.' if repo.key?(name)

  validate_options(options, block_given?)

  define_parameter(name, options, &block)
end