Don't overwrite model description with the route description. #804
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
* [###](https://github.com/ruby-grape/grape-swagger/pull): Don't overwrite model definition with the route description. - [@Bhacaz](https://github.com/Bhacaz)Generated by 🚫 danger |
3 similar comments
* [###](https://github.com/ruby-grape/grape-swagger/pull): Don't overwrite model definition with the route description. - [@Bhacaz](https://github.com/Bhacaz)Generated by 🚫 danger |
* [###](https://github.com/ruby-grape/grape-swagger/pull): Don't overwrite model definition with the route description. - [@Bhacaz](https://github.com/Bhacaz)Generated by 🚫 danger |
* [###](https://github.com/ruby-grape/grape-swagger/pull): Don't overwrite model definition with the route description. - [@Bhacaz](https://github.com/Bhacaz)Generated by 🚫 danger |
* [#804](https://github.com/ruby-grape/grape-swagger/pull/804): Don't overwrite model description with the route description. - [@Bhacaz](https://github.com/Bhacaz)Generated by 🚫 danger |
Bhacaz
force-pushed
the
rework_on_response_object
branch
2 times, most recently
from
b200802 to
a828ce0
Compare
2 similar comments
|
yeap that does it 😄 … thanks @Bhacaz please can you add an entry in UPGRADING.md with title: |
LeFnord
approved these changes
Sep 2, 2020
Sure! |
Bhacaz
force-pushed
the
rework_on_response_object
branch
3 times, most recently
from
c6cef6a to
fc7b5b1
Compare
Bhacaz
force-pushed
the
rework_on_response_object
branch
from
fc7b5b1 to
338513f
Compare
|
I needed to refactor lib/grape-swagger/doc_methods.rb to satisfy Rubocop (0.90.0) |
LeFnord
reviewed
Sep 3, 2020
| next if value[:code] == 204 | ||
| next unless !response_model.start_with?('Swagger_doc') && (@definitions[response_model] || value[:model]) | ||
| # Explicitly request no model with { model: '' } | ||
| next if value[:model] == '' |
There was a problem hiding this comment.
mmh … ok … will have a look on it later, maybe it can be get together with no model key given
There was a problem hiding this comment.
@LeFnord I did like that because by default if no model key is provided (line 219) the model use for the response will be the one returned by GrapeSwagger::DocMethods::PathString#build called here
grape-swagger/lib/grape-swagger/endpoint.rb
Line 100 in 08b8c2f
LeFnord
approved these changes
Sep 3, 2020
|
very good job, many thanks @Bhacaz |
This was referenced Sep 3, 2020
aka-momo
pushed a commit
to aka-momo/grape-swagger
that referenced
this pull request
Feb 8, 2023
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.
This PR have 3 features around the API response documentation.
1. Removing the assignation of the model description from route description.
I face the same problem explain in:
And I try to continued to resolved it.
Following the PR comments and the bug suggestion, the change in this PR will set a description to the model only if it doesn't have one and with a generic sentence.
2. Generate models documentation before the routes.
When I was generating my documentation I observe that sometimes
Grape::Endpoint#response_objecttry to find the model definition without succeed withGrape::Endpoint#expose_params_from_modelsimply because the route documentation was generated before the model definition.3. Add the ability to specified no model (or empty body).
The last thing I add was the ability explicitly set no model (or an empty body) in the response, for example in the failures. The problem was that when none is explicitly passed,
Grape::Endpoint#response_objectis really good to found a model from the path and add it to the documentation.I hope it will be satisfying.