JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Rails 8.1: jsonapi_resources DSL fails to generate relationship routes due to Resource#initialize signature change

Open
#1,479 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

After upgrading to Rails 8.1.1, JSONAPI‑Resources fails to generate relationship routes.
Requests like:

raise:

RoutingError (No route matches ...)

even though the resource is declared with:

jsonapi_resources :deal_individuals

Cause
Rails 8.1 changed ActionDispatch::Routing::Mapper::Resources::Resource#initialize to require keyword args (only:, except:, **options). The JSONAPI‑Resources DSL still passes a positional options hash, so jsonapi_relationships never runs and relationship routes are missing.

Patch Location
lib/action_dispatch/routing/mapper/resources.rb (or an initializer monkey‑patch if overriding locally).

Suggested Fix
Splat options:

resources @resource_type, **options

Call Resource.new with keyword args:

Resource.new(@resource_type, api_only?, @scope[:shallow], only: options[:only], except: options[:except], **options)

Use configured route formatter for path:

options[:path] = JSONAPI.configuration.route_formatter.format(@resource_type)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in lib/action_dispatch/routing/mapper/resources.rb and trace the jsonapi_resources DSL with Rails 8.1.1, focusing on how options reach Resource.new and whether jsonapi_relationships runs. Reproduce the deal_individuals declaration and verify that the expected relationship routes are generated instead of raising RoutingError.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.