module Grape::DSL::Configuration::ClassMethods
Public Instance Methods
api_desc(description, options = {}, &block)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 9 def api_desc(description, options = {}, &block) default_api_options!(options) block.call if block_given? desc description, @api_options end
api_name(name_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 21 def api_name(name_value) raise ArgumentError.new("Grape::api_name - unrecognized value #{name_value} - allowed: String") unless name_value.is_a?(String) @api_options[:api_name] = name_value end
default_api_options!(options)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 135 def default_api_options!(options) @api_options = { headers: @@headers, deprecated: @@deprecated, hidden: @@hidden, scopes: @@scopes, tags: @@tags, response: { entity: @@response_entity, root: @@response_root, headers: @@response_headers, isArray: false }, errors: @@errors, api_name: nil, detail: '' }.merge(options) @description = '' end
default_deprecated(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 91 def default_deprecated(new_value) @@deprecated = new_value end
default_errors(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 116 def default_errors(new_value) @@errors = new_value end
default_headers(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 86 def default_headers(new_value) @@headers = new_value end
default_response_entity(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 131 def default_response_entity(new_value) @@response_entity = new_value end
default_response_headers(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 121 def default_response_headers(new_value) @@response_headers = new_value end
default_response_root(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 126 def default_response_root(new_value) @@response_root = new_value end
default_result(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 111 def default_result(new_value) @@result = new_value end
default_scopes(new_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 101 def default_scopes(new_value) @@scopes = new_value end
deprecated(deprecation_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 27 def deprecated(deprecation_value) raise ArgumentError.new("Grape::deprecated - unrecognized value #{deprecation_value} - allowed: true|false") unless deprecation_value == true || deprecation_value == false @api_options[:deprecated] = deprecation_value end
detail(detail_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 39 def detail(detail_value) raise ArgumentError.new("Grape::detail - unrecognized value #{detail_value} - allowed: String") unless detail_value.is_a?(String) @api_options[:detail] = detail_value end
errors(errors_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 80 def errors(errors_value) raise ArgumentError.new("Grape::errors - unrecognized value #{errors_value} - errors root must be a hash of errors") unless errors_value.is_a?(Hash) @api_options[:errors] = errors_value end
headers(headers_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 15 def headers(headers_value) raise ArgumentError.new("Grape::headers - unrecognized value #{headers_value} - allowed: Hash") unless headers_value.is_a?(Hash) @api_options[:headers] = headers_value end
response(new_result, options = {})
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 69 def response(new_result, options = {}) raise ArgumentError.new("Grape::response - response can't be nil") unless new_result response_obj = { entity: new_result } response_obj[:root] = options[:root] || options['root'] response_obj[:headers] = options[:headers] || options['headers'] response_obj[:isArray] = options[:isArray] || options['isArray'] @api_options[:response] = response_obj end
scopes(scopes_value)
click to toggle source
# File lib/ruby-swagger/grape/grape_config.rb, line 45 def scopes(scopes_value) return if scopes_value.nil? if scopes_value.is_a?(Array) scopes_value.each do |scope| raise ArgumentError.new("Grape::scopes - unrecognized scope #{scope_value}") unless scope.is_a?(String) end @api_options[:scopes] = scopes_value elsif scopes_value.is_a?(String) @api_options[:scopes] = [scopes_value] else raise ArgumentError.new("Grape::scopes - unrecognized value #{scopes_value} - scopes can either be a string or an array of strings") end end