graphql / graphql/graphql.github.io

`StarWarsSchema` type descriptions are `null` in Introspection docs

オープン
#1,496 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
TypeScript
スター
889
フォーク
1.5k
平均マージ
4日 12時間
マージ済み PR(30日)
21

説明

We're currently specifying descriptions in the `StarWarsSchema` using comments:

https://github.com/graphql/graphql.github.io/blob/51db38b9c3c32b7c0cb50640853ecace27aabc68/src/components/Marked/swapiSchema.tsx#L112-L113

...which is causing them to resolve as `null` when we run introspection queries, like in this example on the Introspection docs page:

> introspectionDocs1

The [newer versions of the spec](https://spec.graphql.org/October2021/#sec-Descriptions) outline that descriptions should use a `BlockString` like this:

```
"""
An autonomous mechanical character in the Star Wars universe
"""
type Droid implements Character {}
```

Here's with a `BlockString` description for `Droid` instead:

> introspectionDocs2

Looks like, alternatively, we could specify `commentDescriptions` in our invocation of `makeExecutableSchema`, but we might as well make our schema consistent with the current way of specifying descriptions in the spec.

I can open a PR for this change if it sounds good.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

src/components/Marked/swapiSchema.tsx から始め、特に 112–113 行付近の説明コメントを確認し、GraphQL 仕様の BlockString の例と比較します。null の説明を再現するには、Introspection のドキュメントページを確認してください。StarWarsSchema の説明が null ではなく introspection 結果に表示されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
documentation
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。