Allow desc or description to be used for parameter descriptions #819
Conversation
This file contains hidden or 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
mzikherman
force-pushed
the
allow_description
branch
2 times, most recently
from
196e5f1 to
6468f95
Compare
|
This is perfect. Please update CHANGELOG and README. Thanks. |
mzikherman
force-pushed
the
allow_description
branch
2 times, most recently
from
564d9ae to
eb62a9f
Compare
|
Updated the CHANGELOG. I'm not sure there's anything that requires an update in the README. |
|
Merged via 64d75b0, thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I was surprised that you had to use
descto describe parameters. Usingdescriptionwould throw anunknown validatorerror as Grape interpreted it as a custom validation (ie-regexp, etc.).I added a spec that setting either
descordescriptionworks (returns a 200, currently this will crash if you usedescription).Let me know if that's an odd spec or if you'd like something in addition. Was a bit unsure where such a seemingly-simple spec should go. Thanks! great gem btw 😄