Skip to content

Commit

Permalink
Small fix to improve documentation of queryable_with.
Browse files Browse the repository at this point in the history
  • Loading branch information
bguthrie committed May 5, 2010
1 parent e397b7a commit 9678a89
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/resource_full/query.rb
Expand Up @@ -253,15 +253,18 @@ module ClassMethods
# Indicates that the resource should be queryable with the given parameters, which will be pulled from
# the params hash on an index or count call. Accepts the following options:
#
# * :scope => (scope) : Use a scope. The value of this parameter may be a symbol (named scope), lambda, or hash.
# Most other parameter options build scopes internally.
# * :fuzzy => true : Use a LIKE query instead of =.
# * :columns / :column => ... : Override the default column, or provide a list of columns to query for this value.
# * :from => :join_name : Indicate that this value should be queried by joining on another model. Should use
# a valid relationship from this controller's exposed model (e.g., :account if belongs_to :account is specified.)
# * :resource_identifier => true : Try to look up the resource controller for this value and honor its
# specified resource identifier. Useful for nesting relationships.
# * :allow_nils => true : Indicates that a nil value for a parameter should be taken to literally indicate
# * :allow_nil => true : Indicates that a nil value for a parameter should be taken to literally indicate
# that null values should be returned. This may be changed in the future to expect the literal string 'null'
# or some other reasonable standin.
# * :default => (value) : Default to this value if the parameter is not physically present in the request.
#
# Examples:
#
Expand Down

0 comments on commit 9678a89

Please sign in to comment.