graphql-python / graphql-python/graphene

`graphql_schema` introspection doesn't output docstrings descriptions

Đang mở
#1,492 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
🐛 bug
Ngôn ngữ chính
Python
Star
8.2k
Fork
818
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

**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)

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Tái hiện vấn đề bằng cách định nghĩa một kiểu và một trường Graphene có mô tả trong docstring, sau đó chạy lệnh `manage graphql_schema` để xuất `schema.graphql`. So sánh schema đã xuất với các mô tả kiểu và trường dự kiến; được xem là hoàn tất khi cả hai mô tả đều được đưa vào đầu ra, đồng thời hành vi của `description=` và `Meta` cũng được kiểm tra nếu áp dụng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
graphql, python
Lĩnh vực
api
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.