Class: Brainstem::ApiDocs::Formatters::OpenApiSpecification::Version2::Endpoint::ParamDefinitionsFormatter

Inherits:
AbstractFormatter
  • Object
show all
Includes:
Markdown::Helper, Helper
Defined in:
lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Markdown::Helper

#md_a, #md_code, #md_h1, #md_h2, #md_h3, #md_h4, #md_h5, #md_hr, #md_inline_code, #md_inline_type, #md_li, #md_p, #md_strong, #md_ul

Methods included from Helper

#format_description, #format_http_method, #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) ⇒ ParamDefinitionsFormatter

Returns a new instance of ParamDefinitionsFormatter.



23
24
25
26
27
28
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter.rb', line 23

def initialize(endpoint)
  @endpoint    = endpoint
  @http_method = format_http_method(endpoint)
  @presenter   = endpoint.presenter
  @output      = []
end

Instance Attribute Details

#output ⇒ Object (readonly)

Returns the value of attribute output.



21
22
23
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter.rb', line 21

def output
  @output
end

Instance Method Details

#call ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter.rb', line 30

def call
  format_path_params!

  if endpoint.action == 'index'
    format_pagination_params!
    format_search_param!
    format_only_param!
    format_sort_order_params!
    format_filter_params!
  end

  if http_method != 'delete'
    format_optional_params!
    format_include_params!
  end

  format_query_params!
  format_body_params!

  output
end