-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
+61
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
andtype: Hash
?