Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

graphql_schema introspection doesn't output docstrings descriptions #1492

Open
thomas-at-perdoo opened this issue Jan 12, 2023 · 0 comments
Open
Labels

Comments

@thomas-at-perdoo
Copy link

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant