Added support for optional param documentation with using
#912
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
… it did only work with `requires`.
croeck
force-pushed
the
optional-param-documentation-with-using
branch
from
aedd249
to
b18f498
Compare
|
Odd that we only did it for |
dblock
added a commit
that referenced
this pull request
Jan 29, 2015
…-using Added support for `optional` param documentation with `using`
|
👍 |
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.
Without these changes the
usingdoes only work forrequiresand not withoptionalparameters. This restriction is currently not documented.The feature / fix is required to provide a more complete DRY approach when using
grape-swaggerandgrape-entity. With these changes, one can document the possible fields and values, e.g. when usingPATCHupdate, without requiring them to be present.