Class: Sinatra::SwaggerExposer::Configuration::SwaggerResponseHeader

Inherits:
Object
  • Object
show all
Includes:
SwaggerConfigurationUtilities, SwaggerParameterValidationHelper
Defined in:
lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb

Constant Summary collapse

PRIMITIVE_HEADERS_TYPES = 
[
  TYPE_STRING,
  TYPE_NUMBER,
  TYPE_INTEGER,
  TYPE_BOOLEAN,
]

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 Attribute Summary collapse

Instance Method Summary collapse

Methods included from SwaggerParameterValidationHelper

#check_boolean, #validate_length_parameter, #validate_length_parameters, #validate_limit_parameter, #validate_limit_parameters, #validate_params

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(name, type, description) ⇒ SwaggerResponseHeader

Create a new instance

Parameters:

  • name (String) —

    the name

  • description (String) —

    the description

  • type (String) —

    the type name



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 31

def initialize(name, type, description)
  check_name(name)
  @name = name

  if description
    @description = description
  end

  get_type(type, PRIMITIVE_HEADERS_TYPES)
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



18
19
20
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 18

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



18
19
20
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 18

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



18
19
20
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 18

def type
  @type
end

Instance Method Details

#to_s ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 57

def to_s
  {
    :name => @name,
    :type => @type,
    :description => @description,
  }.to_json
end

#to_swagger ⇒ Hash

Return the swagger version

Returns:

  • (Hash) 


45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-header.rb', line 45

def to_swagger
  result = {
    :type => @type,
  }

  if @description
    result[:description] = @description
  end

  result
end