Skip to content

Multi-line Descriptions Cannot Contain Nested Lists #748

Open
@PvtPuddles

Description

@PvtPuddles

Describe the bug
According to the GraphQL spec, the description field can be multi-line and contain markdown-formatted text. I was disappointed to find out that when I run the introspection query, the leading whitespace gets removed and my nested lists get flattened.

To Reproduce

I have the following argument defined using the Sangria scala package:

object Args {
  val MyArg: Argument[Int] = Argument(
    "myArg",
    IntType,
    description = """My argument description
        |
        |- List level one
        |  - List level two
        |""".stripMargin
  )
}

I have verified that when running schema introspection manually, the string is correctly formatted by the server:

"description": "My argument description\n\n- List level one\n  - List level two\n"

However, when I run schema introspection with the graphQL plugin, I get the following:

 someEndpoint(
        """

        My argument description

        - List level one
        - List level two
        """
        myArg: Int!
): ???

Expected behavior
When I mouse over my argument, I expect to see a nested list.

Screenshots

This is how the description currently renders on hover:
Image

Compared to Apollo's GraphQL Playground (notice the hollow bubble to indicate the second level of layering):

Image

Version and Environment Details
Operation system: MacOS 15.5 (Sequoia)
IDE name and version: IntelliJ IDEA 2025.1.1.1 (Ultimate Edition)
Plugin version: 251.23774.318

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions