JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

`AbstractController::Rendering#rendered_format` is never overwritten

Open
#1,146 0 comments 1 reaction 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

AbstractController::Rendering#rendered_format is never overwritten and thus will always return "text".

AbstractController::Rendering is included here: https://github.com/cerebris/jsonapi-resources/blob/e53a32daa4bde4c2e2120d1abf55644a9a060f23/lib/jsonapi/resource_controller_metal.rb#L4, but I don't see rendered_format ever overwritten.

This is causing the type to report incorrectly in Skylight: https://github.com/skylightio/skylight-ruby/issues/112.

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 with lib/jsonapi/resource_controller_metal.rb, where AbstractController::Rendering is included, and trace how rendered_format is determined for a response. Confirm the current behavior and identify the relevant existing tests or response path; done means the reported format reflects the actual rendered response instead of always being text.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.