Module Apipie::DSL::Param
In: lib/apipie/dsl_definition.rb

this describes the params, it‘s in separate module because it‘s used in Validators as well

Methods

Public Instance methods

where the group definition should be looked up when no scope given. This is expected to return a controller.

Describe method‘s parameter

Example:

  param :greeting, String, :desc => "arbitrary text", :required => true
  def hello_world(greeting)
    puts greeting
  end

Reuses param group for this method. The definition is looked up in scope of this controller. If the group was defined in different controller, the second param can be used to specify it. when using action_aware parmas, you can specify :as => :create or :update to explicitly say how it should behave

[Validate]