class SwaggerDocsGenerator::Actions::Header

Write parameter type :header

Constants

FIELDS

Public Instance Methods

to_hash() click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 12
def to_hash
  {
    in:               :header,
    name:             @name,
    required:         @required.nil? ? true : @required,
    type:             @type
  }.merge(no_mandatory_field)
end

Private Instance Methods

default(text) click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 27
def default(text)
  @default = text
end
enum(array) click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 31
def enum(array)
  @enum = array
end
format(text) click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 35
def format(text)
  @format = text
end
no_mandatory_field() click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 39
def no_mandatory_field
  hash = {}
  FIELDS.each do |parameter|
    value = instance_variable_get("@#{parameter}")
    hash.merge!(parameter.to_sym => value) if value.present?
  end
  hash
end
type(text) click to toggle source
# File lib/swagger_docs_generator/parser/actions/parameters/header.rb, line 23
def type(text)
  @type = text
end