forked from ruby-grape/grape
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md and UPGRADE.md update for ruby-grape#543, ruby-grape#545
- Loading branch information
Showing
2 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
|
||
```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 | ||
``` |