Class: Brainstem::ApiDocs::Formatters::OpenApiSpecification::Version2::InfoFormatter

Inherits:
AbstractFormatter
  • Object
show all
Defined in:
lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractFormatter

call

Constructor Details

#initialize(options = {}) ⇒ InfoFormatter

Returns a new instance of InfoFormatter.



22
23
24
25
26
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb', line 22

def initialize(options = {})
  self.output = ActiveSupport::HashWithIndifferentAccess.new

  super options
end

Instance Attribute Details

#output ⇒ Object

Returns the value of attribute output.



19
20
21
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb', line 19

def output
  @output
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb', line 19

def version
  @version
end

Instance Method Details

#call ⇒ Object 



28
29
30
31
32
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb', line 28

def call
  format_swagger_object!
  format_info_object!
  output
end

#valid_options ⇒ Object

Declares the options that are permissable to set on this instance.



13
14
15
16
17
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb', line 13

def valid_options
  super | [
    :version
  ]
end