JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Location header fails to be set in v0.9.12

Open
#1,361 0 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

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

Description

When upgrading from jsonapi-resources v0.9.0 to v0.9.12 we've noticed a regression with the Location header being set when creating resources.

On further investigation, it appears this change introduced string keys for referencing self links but did not update the setting of the location header accordingly: https://github.com/cerebris/jsonapi-resources/commit/010f024758a41460ebe51f13b35e0b3136a95e79

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 by reviewing commit 010f024758a41460ebe51f13b35e0b3136a95e79 and the resource-creation path it changed. Reproduce creation under v0.9.12, compare the self-link key handling with v0.9.0, and verify that the response includes the expected Location header.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.