Class Apipie::ParamDescription
In: lib/apipie/param_description.rb
Parent: Object

method parameter description

name - method name (show) desc - description required - boolean if required validator - Validator::BaseValidator subclass

Methods

action_aware?   action_awareness   as_action   concern_subst   from_concern?   from_dsl_data   full_name   is_required?   merge_with   new   normalized_value   parents_and_self   preformat_text   process_value   to_json   unify   validate  

Attributes

allow_blank  [R] 
allow_nil  [R] 
as  [R] 
desc  [R] 
metadata  [R] 
method_description  [R] 
name  [R] 
options  [R] 
parent  [RW] 
required  [RW] 
show  [R] 
validations  [R] 
validator  [R] 

Public Class methods

unify(params)

merge param descripsiont. Allows defining hash params on more places (e.g. in param_groups). For example: 

    def_param_group :user do
      param :user, Hash do
        param :name, String
      end
    end

    param_group :user
    param :user, Hash do
      param :password, String
    end

Public Instance methods

action_aware?()

action awareness is being inherited from ancestors (in terms of nested params)

action_awareness()

makes modification that are based on the action that the param is defined for. Typical for required and allow_nil variations in crate/update actions.

parents_and_self()

returns an array of all the parents: starting with the root parent ending with itself

[Validate]