class Raddocs::Parameters

An example's parameters, requires a class because the table can display unknown columns

Constants

SPECIAL_KEYS

Attributes

extra_keys[R]
params[R]

Public Class Methods

new(params) click to toggle source

Collection object for parameters to pull out unknown keys so they can be displayed on the example page.

@example

params = Parameters.new([
  {"name" => "page", "description" => "Page number", "Type" => "Integer"}
])
params.extra_keys
# => ["Type"]

@param params [Array] array of {Raddocs::Parameter Parameters}

# File lib/raddocs/models.rb, line 107
def initialize(params)
  @params = params.map { |param| Parameter.new(param) }
  @extra_keys = params.flat_map(&:keys).uniq - SPECIAL_KEYS
end

Public Instance Methods

present?() click to toggle source

@return [Boolean] true if params contains elements

# File lib/raddocs/models.rb, line 113
def present?
  @params.count > 0
end