Class: Sinatra::SwaggerExposer::Configuration::SwaggerInfo
- Inherits:
-
Object
- Object
- Sinatra::SwaggerExposer::Configuration::SwaggerInfo
- Includes:
- SwaggerConfigurationUtilities
- Defined in:
- lib/sinatra/swagger-exposer/configuration/swagger-info.rb
Overview
The info declaration
Constant Summary collapse
- INFO_FIELDS =
Known fields for the info field
{ :version => String, :title => String, :description => String, :termsOfService => String, :contact => {:name => String, :email => String, :url => String}, :license => {:name => String, :url => String}, }
Constants included from SwaggerParameterHelper
SwaggerParameterHelper::HOW_TO_PASS, SwaggerParameterHelper::HOW_TO_PASS_BODY, SwaggerParameterHelper::HOW_TO_PASS_HEADER, SwaggerParameterHelper::HOW_TO_PASS_PATH, SwaggerParameterHelper::HOW_TO_PASS_QUERY, SwaggerParameterHelper::PARAMS_DEFAULT, SwaggerParameterHelper::PARAMS_EXAMPLE, SwaggerParameterHelper::PARAMS_EXCLUSIVE_MAXIMUM, SwaggerParameterHelper::PARAMS_EXCLUSIVE_MINIMUM, SwaggerParameterHelper::PARAMS_FORMAT, SwaggerParameterHelper::PARAMS_LIST, SwaggerParameterHelper::PARAMS_MAXIMUM, SwaggerParameterHelper::PARAMS_MAX_LENGTH, SwaggerParameterHelper::PARAMS_MINIMUM, SwaggerParameterHelper::PARAMS_MIN_LENGTH, SwaggerParameterHelper::PRIMITIVE_TYPES, SwaggerParameterHelper::PRIMITIVE_TYPES_FOR_NON_BODY, SwaggerParameterHelper::TYPE_ARRAY, SwaggerParameterHelper::TYPE_BOOLEAN, SwaggerParameterHelper::TYPE_BYTE, SwaggerParameterHelper::TYPE_DATE, SwaggerParameterHelper::TYPE_DATE_TIME, SwaggerParameterHelper::TYPE_DOUBLE, SwaggerParameterHelper::TYPE_FILE, SwaggerParameterHelper::TYPE_FLOAT, SwaggerParameterHelper::TYPE_INTEGER, SwaggerParameterHelper::TYPE_LONG, SwaggerParameterHelper::TYPE_NUMBER, SwaggerParameterHelper::TYPE_PASSWORD, SwaggerParameterHelper::TYPE_STRING
Instance Method Summary collapse
-
#initialize(values) ⇒ SwaggerInfo
constructor
A new instance of SwaggerInfo.
-
#process(current_hash, current_field_name, current_fields, top_level_hash) ⇒ Object
Recursive function.
- #to_s ⇒ Object
- #to_swagger ⇒ Object
Methods included from SwaggerConfigurationUtilities
#check_name, #get_type, #hash_to_swagger, #list_or_none, #ref_to_type, #type_to_s, #white_list_params
Constructor Details
#initialize(values) ⇒ SwaggerInfo
Returns a new instance of SwaggerInfo.
16 17 18 |
# File 'lib/sinatra/swagger-exposer/configuration/swagger-info.rb', line 16 def initialize(values) @values = process(values, 'info', INFO_FIELDS, values) end |
Instance Method Details
#process(current_hash, current_field_name, current_fields, top_level_hash) ⇒ Object
Recursive function
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/sinatra/swagger-exposer/configuration/swagger-info.rb', line 31 def process(current_hash, current_field_name, current_fields, top_level_hash) result = {} current_hash.each_pair do |current_key, current_value| key_sym = current_key.to_sym if current_fields.key? key_sym field_content = current_fields[key_sym] if field_content == String if current_value.is_a? String result[key_sym] = current_value else raise SwaggerInvalidException.new("Property [#{current_key}] value [#{current_value}] should be a String for #{current_field_name}: #{top_level_hash}") end else if current_value.is_a? Hash sub_params = process(current_value, current_field_name, field_content, top_level_hash) if sub_params result[key_sym] = sub_params end else raise SwaggerInvalidException.new("Property [#{current_key}] value [#{current_value}] should be a Hash for #{current_field_name}: #{top_level_hash}") end end else raise SwaggerInvalidException.new("Unknown property [#{current_key}] for #{current_field_name}#{list_or_none(current_fields.keys, 'values')}") end end result.empty? ? nil : result end |
#to_s ⇒ Object
66 67 68 |
# File 'lib/sinatra/swagger-exposer/configuration/swagger-info.rb', line 66 def to_s @values.to_json end |
#to_swagger ⇒ Object
62 63 64 |
# File 'lib/sinatra/swagger-exposer/configuration/swagger-info.rb', line 62 def to_swagger @values end |