Fix Grape 3.1.0 and grape-swagger-entity 0.7.1 compatibility#972
Merged
Fix Grape 3.1.0 and grape-swagger-entity 0.7.1 compatibility#972
Conversation
4 tasks
numbata
force-pushed
the
fix/grape-3.1.0-compatibility
branch
from
d18b5ec to
59fe9c1
Compare
Danger ReportNo issues found. |
…ccess Grape 3.1.0 removed the `attributes` alias from BaseRoute. Use direct method calls (route.success, route.produces) which work in all versions via delegate_missing_to. Fixes #971
Grape 3.1.0 changed the Route constructor signature from (method, origin, path, options) to (endpoint, method, pattern, options) and Pattern now uses keyword arguments.
Align with grape-swagger-entity#87 which correctly excludes hidden attributes from the required fields list in Swagger documentation.
Runs weekly (Sundays at midnight UTC) to detect compatibility issues with upcoming Grape releases early.
numbata
force-pushed
the
fix/grape-3.1.0-compatibility
branch
from
59fe9c1 to
6cc8961
Compare
grape-swagger-entity 0.7.1 now wraps $ref in allOf when description is present, which is the correct OpenAPI format. See: ruby-grape/grape-swagger-entity#90
numbata
changed the title
There was a problem hiding this comment.
Pull request overview
This PR fixes compatibility issues with Grape 3.1.0, which introduced breaking changes by removing the route.attributes method and changing constructor signatures for Route and Pattern classes.
Changes:
- Fixed
route.attributesremoval by usingroute.optionshash directly - Updated test helper to support new Grape 3.1.0 Route/Pattern constructor signatures with backward compatibility
- Aligned tests with grape-swagger-entity#87 changes regarding hidden attributes and reference formatting
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| lib/grape-swagger/endpoint.rb | Replaced deprecated route.attributes.success and route.attributes.produces with route.options[:success] and route.options[:produces] |
| spec/support/route_helper.rb | Added Grape 3.1.0+ support with new Route/Pattern constructor signatures using keyword arguments |
| spec/swagger_v2/reference_entity_spec.rb | Updated test expectation to reflect grape-swagger-entity's new behavior of wrapping $ref in allOf |
| spec/issues/962_polymorphic_entity_with_custom_documentation_spec.rb | Removed required array from hidden entity definition test to align with grape-swagger-entity#87 |
| .github/workflows/edge.yml | Added weekly scheduled workflow to test against Grape HEAD to catch future compatibility issues early |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dblock
approved these changes
Jan 29, 2026
|
@dblock, apologies for bugging, is this going to be released (as 2.1.4?) any time soon? |
Contributor
Author
Contributor
Author
|
@totus thanks for your patience! The new gem version has been released: https://rubygems.org/gems/grape-swagger/versions/2.1.4 |
|
@numbata, thanks a lot, extremely appreciated! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Grape 3.1.0 refactored
BaseRouteto remove theattributesalias, causingNoMethodErrorwhen generating swagger documentation. This PR fixes the compatibility issue by accessing route options directly viaroute.options[:success]androute.options[:produces], which works consistently across all Grape versions.Additionally, this PR updates test expectations to align with grape-swagger-entity 0.7.1, which introduced two behavioral changes:
requiredarray (Remove hidden attributes from required params grape-swagger-entity#87)allOfwrapper, which is the correct OpenAPI format since$refcannot have sibling properties (Fix #44: description not rendered for non-array entity references grape-swagger-entity#90)A weekly scheduled workflow has been added to catch future compatibility issues with Grape HEAD early.
Test plan
All tests pass across the full matrix: Ruby 3.1-3.4 + head, Grape 1.8.0-HEAD, with and without grape-swagger-entity parser.
Fixes #971