Add response examples #675
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
lib/grape-swagger/endpoint.rb:7:3: C: Metrics/ClassLength: Class has too many lines. [289/287]
class Endpoint ...
^^^^^^^^^^^^^^
lib/grape-swagger/endpoint.rb:196:5: C: Metrics/CyclomaticComplexity: Cyclomatic complexity for response_object is too high. [14/13]
def response_object(route) ...
^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/grape-swagger/endpoint.rb:196:5: C: Metrics/PerceivedComplexity: Perceived complexity for response_object is too high. [15/14]
def response_object(route) ...
^^^^^^^^^^^^^^^^^^^^^^^^^^
gamartin
commented
May 14, 2018
| @@ -264,6 +261,12 @@ def tag_object(route, path) | |||
|
|
|||
| private | |||
|
|
|||
| def build_reference(route, value, response_model) | |||
There was a problem hiding this comment.
Extracted this to a method to avoid lint:
lib/grape-swagger/endpoint.rb:196:5: C: Metrics/PerceivedComplexity: Perceived complexity for response_object is too high. [15/14]
gamartin
commented
May 14, 2018
| @@ -294,9 +297,8 @@ def merge_params(route) | |||
| end | |||
|
|
|||
| def default_type(params) | |||
There was a problem hiding this comment.
Changed to inline block to avoid lint:
Class has too many lines
|
This PR is very welcome, but can review it, if I can access my machine again … was damaged 😞 – it isn’t so nice via phone 😉 … hope tomorrow |
LeFnord
reviewed
May 18, 2018
|
|
||
| desc 'This returns examples' do | ||
| success model: Entities::UseResponse, examples: { 'application/json' => { description: 'Names list', items: [{ id: '123', name: 'John' }] } } | ||
| failure [[404, 'NotFound', Entities::ApiError, { 'application/json' => { code: 404, message: 'Not found' } }]] |
There was a problem hiding this comment.
question: is it also possible to use the explicit notation as hash, mean …
failure: [
{
code: 400,
message: 'NotFound',
model: Entities::ApiError,
examples: { 'application/json' => { code: 404, message: 'Not found' }
}
]There was a problem hiding this comment.
Yes, added examples and docs for that notation
LeFnord
approved these changes
May 22, 2018
|
many thanks @gamartin :) |
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
* first try
* tests
* n test
* Update README.md
* Update README.md
* add response examples
* tests
* n test
* Update README.md
* Update README.md
* Addressed lint issues:
lib/grape-swagger/endpoint.rb:7:3: C: Metrics/ClassLength: Class has too many lines. [289/287]
class Endpoint ...
^^^^^^^^^^^^^^
lib/grape-swagger/endpoint.rb:196:5: C: Metrics/CyclomaticComplexity: Cyclomatic complexity for response_object is too high. [14/13]
def response_object(route) ...
^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/grape-swagger/endpoint.rb:196:5: C: Metrics/PerceivedComplexity: Perceived complexity for response_object is too high. [15/14]
def response_object(route) ...
^^^^^^^^^^^^^^^^^^^^^^^^^^
* added examples for explicit hash notation in failure
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.
Added support to expose response examples
descDSL block syntax.