class Apiculture::ActionDefinition

Describes a single API action (route). Is used internally by Apiculture.

Attributes

description[RW]
http_verb[RW]
parameters[R]
path[RW]
responses[R]
route_parameters[R]

Public Class Methods

new() click to toggle source
# File lib/apiculture/action_definition.rb, line 27
def initialize
  @parameters, @route_parameters, @responses = [], [], []
end

Public Instance Methods

all_parameter_names_as_strings() click to toggle source
# File lib/apiculture/action_definition.rb, line 11
def all_parameter_names_as_strings
  @parameters.map(&:name_as_string) + @route_parameters.map(&:name_as_string)
end
defines_request_params?() click to toggle source
# File lib/apiculture/action_definition.rb, line 19
def defines_request_params?
  @parameters.any?
end
defines_responses?() click to toggle source
# File lib/apiculture/action_definition.rb, line 15
def defines_responses?
  @responses.any?
end
defines_route_params?() click to toggle source
# File lib/apiculture/action_definition.rb, line 23
def defines_route_params?
  @route_parameters.any?
end