class RspecApiDocs::Resource::Parameter
Attributes
name[R]
parameter[R]
Public Class Methods
new(name, parameter)
click to toggle source
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 6 def initialize(name, parameter) @name = name @parameter = parameter end
Public Instance Methods
==(other)
click to toggle source
@return [true, false]
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 33 def ==(other) name == other.name && parameter == other.parameter end
description()
click to toggle source
The description of the parameter
@return [String]
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 28 def description parameter[:description] end
required()
click to toggle source
If the parameter is required
@return [String]
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 21 def required !!parameter[:required] end
scope()
click to toggle source
The scope of the parameter
@return [Array<String>]
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 14 def scope parameter[:scope] end
type()
click to toggle source
@return [String, nil]
# File lib/rspec_api_docs/formatter/resource/parameter.rb, line 39 def type parameter[:type] end