Support namespace description in swagger doc #94
Closed
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.
Grape does not support attaching a description to a Namespace. It always flows to the next Route. So when Grape-Swagger rolls the routes up and groups them per path (i.e. namespace), there is no description to attach to the overall namespace.
This pull request allows you to say:
namespace
is an alias for other methods likeresource
andgroup
in Grape.The generated swagger doc json will then contain the namespace description, and the swagger-ui will naturally add it to the api heading.