JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

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

Aperta
#1,278 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Type: Enhancement
Lingua principale
Ruby
Stelle
2.3k
Fork
546
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando la gestione di un errore "param not allowed" e la configurazione per la capitalizzazione degli attributi. Controlla come vengono elaborati gli attributi camelCased, snake_cased e kebab-cased, quindi verifica che una capitalizzazione non corrispondente produca un suggerimento utile senza modificare il comportamento valido di JSON:API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.