Make route summary optional #667
Merged
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
* [#667](https://github.com/ruby-grape/grape-swagger/pull/667): Make route summary optional - [@obduk](https://github.com/obduk).Generated by 🚫 danger |
Resolves #661 Currently if no summary is provided, grape-swagger uses the description. This creates needless duplicate fields. As summary is an optional field this changes functionality so summary is only populated if specifically needed. Reference https://swagger.io/specification/
|
thanks @obduk … it would be nice, to have some specs with summary, to document the behaviour, |
|
@LeFnord thanks for looking at this. There are already tests for this in spec/swagger_v2/namespaced_api_spec.rb as it is not new functionality. |
|
ok, then I'm fine with it and mörge it, thanks again |
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
Resolves ruby-grape#661 Currently if no summary is provided, grape-swagger uses the description. This creates needless duplicate fields. As summary is an optional field this changes functionality so summary is only populated if specifically needed. Reference https://swagger.io/specification/
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.
Resolves #661
Currently if no summary is provided, grape-swagger uses the description.
This creates needless duplicate fields. As summary is an optional field
this changes functionality so summary is only populated if specifically
needed.
Reference https://swagger.io/specification/