Add custom message support for missing parameters #390
Conversation
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
|
@jcalvert Nice! I find that very useful. Could you also mention this in the readme? |
jcalvert
force-pushed
the
missing_message
branch
from
7b60a15 to
4d17840
Compare
…message as a supported option for parameters.
jcalvert
force-pushed
the
missing_message
branch
from
4d17840 to
13c4120
Compare
|
@Pajk Updated branch and added changes to README under the Parameter Description section. |
Pajk
added a commit
that referenced
this pull request
Dec 18, 2015
Add custom message support for missing parameters
|
v0.3.6 with this change has just been released. Thanks @jcalvert |
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.
ParamMissingcan take the entireParamDescriptionobject instead of just the name, allowing it to interrogate the object to produce a custom missing message instead of the boilerplate"Missing parameter #{@param.name}". Support is for a basic string or function.A primary use case for this is when an API is returning an error message that a client can then surface directly to a user without having to maintain a mapping of parameter names to human readable names IE
Missing parameter user_idtoA user must be supplied to complete this action.. An additional benefit in allowing aProcis that we can evaluate runtime conditions to create the message, thereby allowing internationalization and providing greater usefulness in the error message.This would also address the feature request in issue #360