Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md and UPGRADE.md update for #543, #545 #547

Merged
merged 1 commit into from
Jan 2, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,23 @@ end
Parameters can be nested using `group` or by calling `requires` or `optional` with a block.
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.
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you maybe provide examples for type: Array and type: Hash?


```ruby
params do
optional :preferences, type: Array do
requires :key
requires :value
end

requires :name, type: Hash do
requires :first_name
requires :last_name
end
end
```

### Namespace Validation and Coercion

Expand Down
44 changes: 44 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good. Just add an example of how something that worked before no longer works.


```ruby
params do
requires :id, type: Integer
group :name do
requires :first_name
requires :last_name
end
end
```

Whereas in 0.6.1 this accepted the following json,

```json
{
"id": 1,
"name": {
"first_name": "John",
"last_name" : "Doe"
}
}
```

it no longer does in 0.6.2. The params block should now read:

```ruby
params do
requires :id, type: Integer
requires :name, type: Hash do
requires :first_name
requires :last_name
end
end
```