You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The latest grape and grape-swagger gems would update our API to the OpenAPI spec version 2.0. We should double-check to make sure our API works as expected with the OpenAPI 2.0 specification and format.
Impact
Allows us to confidently use up-to-date grape and grape-swagger gems.
Whoops, it seems like this is actually not a problem.
#506 works just fine, and that pairs our current API code with the new and updated grape and grape-swagger Gems. If we can confirm this isn't a problem, it's fine to close this issue.
I updated this issue to more accurately reflect the situation. We can optionally go in and make sure this works 100% perfectly with the new gems. But it already works fine apparently in #506.
I think addressing this issue can only really affect the docs page. The results given by the API (actual json-formatted restroom entries) in PR #506 look the same as before, at least to my eyes.
DeeDeeG
changed the title
Update restrooms API for newer grape and grape-swagger (enables support for the OpenAPI 2.0 or 3.0 spec)
Update restrooms API for newer grape and grape-swagger (enables support for the OpenAPI 2.0 spec)
Oct 20, 2018
Our API code doesn't appear to need any changes after all. I suppose we weren't using any off-the-beaten-path features of the grape and grape-swagger gems.
Context
The latest
grape
andgrape-swagger
gems would update our API to the OpenAPI spec version 2.0. We should double-check to make sure our API works as expected with the OpenAPI 2.0 specification and format.Impact
Allows us to confidently use up-to-date
grape
andgrape-swagger
gems.How to actually do this
Change this file I think: https://github.com/RefugeRestrooms/refugerestrooms/blob/ee25f6af625d06269c77377a3ea594308a644de4/app/controllers/api/v1/restrooms.rb
For upgrading to match the new
grape
gem, see:https://github.com/ruby-grape/grape/blob/master/UPGRADING.md
For upgrading to match the new
grape-swagger
gem, see:https://github.com/ruby-grape/grape-swagger/blob/master/UPGRADING.md
The text was updated successfully, but these errors were encountered: