JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Feature Request: Give an error hint if wrong attribute case is used

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

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

Choose one section below and delete the other:

Features:

If I set my attribute casing to be say camelCased, but the request comes in with attributes that are snake_cased or kebab-cased, when we throw a "param not allowed" can we instead check if the cases just mismatch and instead throw an error indicating that you may have been using the wrong case. This is something that happens occasionally especially with new engineers getting on a project, but would instantly save a bunch of frustration here and there when these bugs happen.

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 locating the handling for a "param not allowed" error and the configuration for attribute casing. Check how camelCased, snake_cased, and kebab-cased attributes are processed, then verify that a mismatched case produces a helpful hint without changing valid JSON:API behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
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.