JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

JSON API document parsing maybe could be extracted to its own gem?

Open
#556 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It seems there is a lot of re-doing of parsing a full JSON API document going around.

It would be cool to have a common interface between all the gems that need to work with json api documents.

I was looking at the Request object, and thought that would be a good one to abstract out to its own gem. maybe give it a lightweight interface for accessing the id and the attributes, maybe relationships and their ids and attributes.

thoughts?

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

Begin with the Request object mentioned in the issue and compare how full JSON API documents are parsed across the affected gems. Define the shared interface and extraction boundary, then confirm the proposed gem can expose ids, attributes, relationships, and relationship ids or attributes.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.