JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Read only (immutable) relationships

Open
#1,365 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.
  • [ x ] 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

Features:

As an engineer I would like to add has_many or has_one relations which are read only. To accomplish this on the current implementation the following code is used in the resource file.

has_many :cars

def cars=(_cars); end

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 the resource implementation that handles has_many and has_one declarations, using the example resource definition as the entry point. Trace how relationship writers are generated or invoked, then add declarative support for read-only relationships and locate the relevant relationship tests to verify that the custom setter workaround is no longer needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.