class Brainstem::ApiDocs::Formatters::OpenApiSpecification::Version2::ControllerFormatter
Attributes
controller[RW]
include_actions[RW]
include_actions?[RW]
output[RW]
Public Class Methods
new(controller, options = {})
click to toggle source
Calls superclass method
Brainstem::ApiDocs::Formatters::AbstractFormatter::new
# File lib/brainstem/api_docs/formatters/open_api_specification/version_2/controller_formatter.rb, line 26 def initialize(controller, options = {}) self.controller = controller self.output = {} self.include_actions = true super options end
Public Instance Methods
call()
click to toggle source
# File lib/brainstem/api_docs/formatters/open_api_specification/version_2/controller_formatter.rb, line 34 def call return {} if controller.nodoc? format_actions! end
valid_options()
click to toggle source
Declares the options that are permissable to set on this instance.
Calls superclass method
Brainstem::Concerns::Optional#valid_options
# File lib/brainstem/api_docs/formatters/open_api_specification/version_2/controller_formatter.rb, line 13 def valid_options super | [ :include_actions ] end
Private Instance Methods
format_actions!()
click to toggle source
# File lib/brainstem/api_docs/formatters/open_api_specification/version_2/controller_formatter.rb, line 44 def format_actions! return unless include_actions? controller.valid_sorted_endpoints.formatted_as(:oas_v2) end