module Apipie::Params::DSL
Public Instance Methods
_apipie_params_dsl_data()
click to toggle source
# File lib/apipie/params/dsl.rb, line 4 def _apipie_params_dsl_data @_apipie_params_dsl_data ||= _apipie_params_dsl_data_init end
_apipie_params_dsl_data_init()
click to toggle source
# File lib/apipie/params/dsl.rb, line 8 def _apipie_params_dsl_data_init @_apipie_params_dsl_data = [] end
array_of(descriptor)
click to toggle source
descriptor
might be instance of Descriptor::Base
or something that has it in :descriptor method
# File lib/apipie/params/dsl.rb, line 29 def array_of(descriptor) descriptor = if descriptor.is_a? Descriptor::Base descriptor elsif descriptor.respond_to?(:descriptor) descriptor.descriptor else raise ArgumentError, "descriptor is not a Descriptor::Base or an Object with #descriptor method" end Descriptor::Array.new(descriptor, {}) end
param(param_name, descriptor_arg = nil, desc_or_options = nil, options = {}, &block)
click to toggle source
Describe method's parameter
Example:
param :greeting, String, :desc => "arbitrary text", :required => true
# File lib/apipie/params/dsl.rb, line 17 def param(param_name, descriptor_arg = nil, desc_or_options = nil, options = {}, &block) #:doc: if desc_or_options.is_a? String options = options.merge(:desc => desc_or_options) end _apipie_params_dsl_data << [param_name, descriptor_arg, options, block] end