Class: Grape::Util::ApiDescription

Inherits:
Object
  • Object
show all
Defined in:
lib/grape/util/api_description.rb

Constant Summary collapse

DSL_METHODS = 
%i[
  body_name
  consumes
  default
  deprecated
  detail
  entity
  headers
  hidden
  http_codes
  is_array
  named
  nickname
  params
  produces
  security
  summary
  tags
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(description, endpoint_configuration) ⇒ ApiDescription

Returns a new instance of ApiDescription.



26
27
28
29
30
 
# File 'lib/grape/util/api_description.rb', line 26

def initialize(description, endpoint_configuration, &)
  @endpoint_configuration = endpoint_configuration
  @attributes = { description: description }
  instance_eval(&)
end

Instance Method Details

#configuration ⇒ Object 



41
42
43
 
# File 'lib/grape/util/api_description.rb', line 41

def configuration
  @configuration ||= eval_endpoint_config(@endpoint_configuration)
end

#settings ⇒ Object 



45
46
47
 
# File 'lib/grape/util/api_description.rb', line 45

def settings
  @attributes
end