Module: Rapidoc::ParamErrors

Included in:
Rapidoc
Defined in:
lib/rapidoc/param_errors.rb

Instance Method Summary collapse

Instance Method Details

#get_default_error_info(object, type) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/rapidoc/param_errors.rb', line 36

def get_default_error_info( object, type )
  { 'object' => object,
    'message' => default_errors[type]['message'],  # config function
    'description' => default_errors[type]['description']
  }
end

#get_error_info(object, type) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/rapidoc/param_errors.rb', line 5

def get_error_info( object, type )
  case type
  when 'required'
    get_required_error_info object
  when 'inclusion'
    get_inclusion_error_info object
  else
    nil
  end
end

#get_inclusion_error_info(object) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/rapidoc/param_errors.rb', line 26

def get_inclusion_error_info( object )
  if default_errors and default_errors.include? "inclusion"
    get_default_error_info( object, "inclusion" )
  else
    { "object" => object, 
      "message" => "inclusion",
      "description" => "This parameter is not in the collection" }
  end
end

#get_required_error_info(object) ⇒ Object 



16
17
18
19
20
21
22
23
24
 
# File 'lib/rapidoc/param_errors.rb', line 16

def get_required_error_info( object )
  if default_errors and default_errors.include? "required"
    get_default_error_info( object, "required" )
  else
    {  "object" => object,
       "message" => "blank", 
       "description" => "This parameter is mandatory" }
  end
end