module RopenPi::Param

Public Class Methods

bool_param(name, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 21
def self.bool_param(name, desc: 'tba', opts: {})
  param(name, :boolean, desc: desc, opts: opts)
end
Also aliased as: boolean_param
boolean_param(name, desc: 'tba', opts: {})
Alias for: bool_param
date_param(name, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 5
def self.date_param(name, desc: 'tba', opts: {})
  param(name, :string, fmt: 'date-time', desc: desc, opts: opts)
end
int_param(name, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 17
def self.int_param(name, desc: 'tba', opts: {})
  param(name, :integer, desc: desc, opts: opts)
end
Also aliased as: integer_param
integer_param(name, desc: 'tba', opts: {})
Alias for: int_param
param(name, schema_type, fmt: nil, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 38
def self.param(name, schema_type, fmt: nil, desc: 'tba', opts: {})
  {
    name: name.to_s,
    description: desc,
    in: 'query',
    schema: schema(schema_type, fmt: fmt)
  }.merge(opts)
end
param_in_path(name, schema_type, fmt: nil, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 29
def self.param_in_path(name, schema_type, fmt: nil, desc: 'tba', opts: {})
  param(name, schema_type, fmt: fmt, desc: desc, opts: opts)
    .merge(
      in: 'path',
      required: true
    )
    .merge(opts)
end
ref_param(name, ref, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 25
def self.ref_param(name, ref, desc: 'tba', opts: {})
  param(name, 'null', desc: desc, opts: opts).merge(schema: { '$ref': ref })
end
schema(type, fmt: nil) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 47
def self.schema(type, fmt: nil)
  {}.tap do |schema|
    schema[:type] = type.to_s
    schema[:format] = fmt.to_s if fmt.present?
  end
end
schema_enum(values, type: :string) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 54
def self.schema_enum(values, type: :string)
  {
    type: type.to_s,
    enum: values
  }
end
string_param(name, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 13
def self.string_param(name, desc: 'tba', opts: {})
  param(name, :string, desc: desc, opts: opts)
end
uuid_param(name, desc: 'tba', opts: {}) click to toggle source
# File lib/ropen_pi/config_helper.rb, line 9
def self.uuid_param(name, desc: 'tba', opts: {})
  param(name, :string, fmt: 'uuid', desc: desc, opts: opts)
end