Class: Sinatra::SwaggerExposer::Configuration::SwaggerTypes

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

Overview

Contain all the declared types

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

Returns a new instance of SwaggerTypes.



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

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

Instance Attribute Details

#types ⇒ Object (readonly)

Returns the value of attribute types.



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

def types
  @types
end

Instance Method Details

#add_type(name, params) ⇒ Object

Add a new swagger type

Parameters:

  • name (String) —

    the type name

  • params (Hash) —

    the type params



23
24
25
26
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-types.rb', line 23

def add_type(name, params)
  check_duplicate(name, 'Type')
  @types[name] = SwaggerType.new(name, params, @types.keys)
end

#types_names ⇒ Object 



28
29
30
 
# File 'lib/sinatra/swagger-exposer/configuration/swagger-types.rb', line 28

def types_names
  @types.keys
end