Documentation of unused (directly in method) path variables #15
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
added 3 commits
July 3, 2013 20:32
…oller, true by default.
Sometimes there are path variables which are not used in method directly.
For instance, we have /user/pets/{petId}, but method doesn't have @PathVariable petId because
it's used for MethodArgumentResolver in upper level, but we still need this fields
Such fields are not documented by Swagger by default.
Minor changes:
1. Utility methods moved to DocumentationUtils
2. Default Java version(1.5) added to pom.xml
Default description added for such variables, for "ownerName" description would be "Owner name"
wkennedy
pushed a commit
that referenced
this pull request
Jul 11, 2013
Documentation of unused (directly in method) path variables
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.
No description provided.