Class: GrapeSwagger::Entity::AttributeParser

Inherits:
Object
  • Object
show all
Defined in:
lib/grape-swagger/entity/attribute_parser.rb

Constant Summary collapse

ADDITIONAL_PRIMITIVE_TYPES =

The list of that doesn’t handled by ‘GrapeSwagger::DocMethods::DataType.primitive?` method

%w[string array].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint) ⇒ AttributeParser

Returns a new instance of AttributeParser.



11
12
13
 
# File 'lib/grape-swagger/entity/attribute_parser.rb', line 11

def initialize(endpoint)
  @endpoint = endpoint
end

Instance Attribute Details

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



6
7
8
 
# File 'lib/grape-swagger/entity/attribute_parser.rb', line 6

def endpoint
  @endpoint
end

Instance Method Details

#call(entity_options) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/grape-swagger/entity/attribute_parser.rb', line 15

def call(entity_options)
  param = if (entity_model = model_from(entity_options))
            name = GrapeSwagger::Entity::Helper.model_name(entity_model, endpoint)
            entity_model_type(name, entity_options)
          else
            data_type_from(entity_options)
          end

  documentation = entity_options[:documentation]
  return param if documentation.nil?

  add_array_documentation(param, documentation) if documentation[:is_array]

  add_attribute_sample(param, documentation, :default)
  add_attribute_sample(param, documentation, :example)

  add_attribute_documentation(param, documentation)

  add_extension_documentation(param, documentation)
  add_discriminator_extension(param, documentation)
  param
end