Better describe what `Coercing.valueToLiteral` is for

Aperta
#3,558 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia leggendo il JavaDoc dell’interfaccia Coercing e la documentazione sugli scalari personalizzati all’indirizzo graphql-java.com/documentation/scalars/. Chiarisci cosa accetta valueToLiteral, come si relaziona a parseValue e serialize, e documenta il metodo nella guida agli scalari personalizzati; il lavoro è completo quando entrambe le posizioni della documentazione ne spiegano in modo coerente lo scopo e la forma dell’argomento.

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

Descrizione

keep-open

While upgrading to GraphQL Java 21, I stumbled over the method valueToLiteral offered by the Coercing interface. So far, when implementing a custom scalar, I haven't bothered about implementing this method and have not encountered any problems so far although the default implementation throws an exception.

In the JavaDoc of the Coercing interface, it says that "every valid external input values for parseValue(Object) is also valid for valueToLiteral(Object) and vice versa" which suggest that the argument to valueToLiteral should be in serialized form. However, when looking at implementations of this method, I see that most often serialze is called first on the argument, which suggests otherwise.

Could you please improve the JavaDoc and also the documentation on custom scalars, which does not mention this method at all?

Lingua principale
Java
Stelle
6.2k
Fork
1.1k
Merge medio
22m
PR unite (30g)
14

Guida per i contributori

Apri la guida per i contributori

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.

Altre issue di graphql-java/graphql-java

Tutte le issue di graphql-java/graphql-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.