graphql-python / graphql-python/graphene

`graphql_schema` introspection doesn't output docstrings descriptions

オープン
#1,492 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
🐛 bug
主要言語
Python
スター
8.2k
フォーク
818
PR マージ指標
30日以内にマージされた PR はありません

説明

**Note: for support questions, please use stackoverflow**. This repository's issues are reserved for feature requests and bug reports.

* **What is the current behavior?**

Running `manage graphql_schema` to export the `schema.graphql` doesn't output the description for types and fields. I've only tested it when the description is described via docstrings, e.g.:

```
class SomeType(graphene.ObjectType):
"""
Some description
"""

field = graphene.String()
```

but I suspect it also doesn't work when using `description=` or the `Meta` class as described here:

Screenshot 2023-01-12 at 11 37 23

* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** via
a github repo, https://repl.it or similar.

- Create a schema with at least one type with a description (and/or a field description)
- Run the `graphql_schema` introspection command to export a `schema.graphql` file

* **What is the expected behavior?**

The schema is outputted including field and type descriptions.

* **What is the motivation / use case for changing the behavior?**

No type or field descriptions are exported.

* **Please tell us about your environment:**

- Version: ^2.13.0
- Platform:

* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)

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

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

docstring による説明を持つ Graphene の型とフィールドを定義して問題を再現し、`manage graphql_schema` コマンドを実行して `schema.graphql` をエクスポートします。エクスポートされたスキーマを、型とフィールドに期待される説明と比較します。出力に両方の説明が含まれ、該当する場合は `description=` と `Meta` の動作も確認できれば完了です。

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

評価

技術スタック
graphql, python
領域
api
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

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

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