Skip to content

Commit

Permalink
README.md and UPGRADE.md update for ruby-grape#543, ruby-grape#545
Browse files Browse the repository at this point in the history
  • Loading branch information
bwalex committed Jan 2, 2014
1 parent 5b51c90 commit 88f5101
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,9 @@ end
```

Parameters can be nested using `group` or by calling `requires` or `optional` with a block.
With a block, `group`, `requires` and `optional` accept an additional option `type` which can
be either `Array` or `Hash`, and defaults to `Array`. Depending on the value, the nested
parameters will be treated either as values of a hash or as values of hashes in an array.
In the above example, this means `params[:media][:url]` is required along with `params[:id]`,
and `params[:audio][:format]` is required only if `params[:audio]` is present.

Expand Down
10 changes: 10 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Upgrading

## upgrading to 0.6.2

In grape <= 0.6.1, `group`, `optional` and `requires` with block accepted
either an Array or a Hash.

In grape 0.6.2, these have an additional `type` attribute which defaults
to `Array`. This means that without a `type` attribute, these nested parameters
will no longer accept a single hash, only an array (of hashes).

0 comments on commit 88f5101

Please sign in to comment.