Class: Brainstem::ApiDocs::Formatters::OpenApiSpecification::Version2::FieldDefinitions::ResponseFieldFormatter

Inherits:
AbstractFormatter
  • Object
show all
Includes:
Helper
Defined in:
lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter.rb

Direct Known Subclasses

EndpointParamFormatter

Instance Method Summary collapse

Methods included from Helper

#format_http_method, #format_sentence, #format_tag_name, #presenter_title, #type_and_format, #uncapitalize

Methods inherited from AbstractFormatter

call

Methods included from Concerns::Optional

#valid_options

Constructor Details

#initialize(endpoint, param_name, param_tree) ⇒ ResponseFieldFormatter

Returns a new instance of ResponseFieldFormatter.



14
15
16
17
18
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter.rb', line 14

def initialize(endpoint, param_name, param_tree)
  @endpoint = endpoint
  @param_name = param_name
  @param_tree = param_tree
end

Instance Method Details

#format ⇒ Object Also known as: call 



20
21
22
23
24
25
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter.rb', line 20

def format
  field_config = @param_tree[:_config]
  field_properties = @param_tree.except(:_config)
  
  format_field(field_config, field_properties)
end