Class: Sinatra::SwaggerExposer::Configuration::SwaggerResponseHeaders

Inherits:
SwaggerHashLike
  • Object
show all
Defined in:
lib/sinatra/swagger-exposer/configuration/swagger-response-headers.rb

Overview

Contain all the declared response headers

Constant Summary

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 inherited from SwaggerHashLike

#[], #check_duplicate, #key?, #to_swagger

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 ⇒ SwaggerResponseHeaders

Returns a new instance of SwaggerResponseHeaders.



15
16
17
18
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-headers.rb', line 15

def initialize
  @response_headers = {}
  super(@response_headers)
end

Instance Attribute Details

#response_headers ⇒ Object (readonly)

Returns the value of attribute response_headers.



13
14
15
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-headers.rb', line 13

def response_headers
  @response_headers
end

Instance Method Details

#add_response_header(name, type, description) ⇒ Object

Add a new swagger response header

Parameters:

  • name (String) —

    the type name

  • type (Object) —

    the type

  • description (String) —

    the description



24
25
26
27
28
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-response-headers.rb', line 24

def add_response_header(name, type, description)
  name = name.to_s
  check_duplicate(name, 'Response header')
  @response_headers[name] = SwaggerResponseHeader.new(name, type, description)
end