Better describe what `Coercing.valueToLiteral` is for
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- java
調査の方向性
まず Coercing インターフェースの JavaDoc と、graphql-java.com/documentation/scalars/ にあるカスタムスカラーのドキュメントを読みます。valueToLiteral が何を受け取るのか、parseValue および serialize とどのような関係にあるのかを明確にし、カスタムスカラーのガイドにこのメソッドを記載します。両方のドキュメント箇所で、その目的と引数の形式が一貫して説明されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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?
- 主要言語
- Java
- スター
- 6.2k
- フォーク
- 1.1k
- 平均マージ
- 2日 4時間
- マージ済み PR（30日）
- 27
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
graphql-java/graphql-java のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
graphql-java/graphql-java#4530 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 半日 初心者へのやさしさ 42/100
graphql-java/graphql-java#4536 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 12/100
graphql-java/graphql-java#4497 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
graphql-java/graphql-java#4479 ·
メンテナーはふだん 1 日以内に返信
-
Subscription event DataFetcherResult.extensions are missing from emitted ExecutionResult対応中かも @kalayciburak が 46 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
graphql-java/graphql-java#4475 ·
メンテナーはふだん 1 日以内に返信
graphql-java/graphql-java の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Dans-Plugins/Medieval-Roleplay-Engine#396 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 6 日以内に返信
-
type: dependency-upgrade
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
spring-projects/spring-session#4156 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
quarkiverse/quarkus-langchain4j#3127 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
HotswapProjects/HotswapAgent#688 ·