class RspecApiDocumentation::OpenApi::Parameter

Attributes

value[RW]

Required to write example values to description of parameter when option `with_example: true` is provided

with_example[RW]

Public Instance Methods

description()
Also aliased as: description_without_example
description_with_example() click to toggle source
# File lib/rspec_api_documentation/open_api/parameter.rb, line 20
def description_with_example
  str = description_without_example.dup || ''
  if with_example && value
    str << "\n" unless str.empty?
    str << "Eg, `#{value}`"
  end
  str
end
Also aliased as: description
description_without_example()
Alias for: description