Schema documentation is requested but not shown even if received (v1.5.1)

[learnerEvermore]

I can see that the schema description is requested:

query IntrospectionQuery {
  __schema {
    description
    ...
}

but it isn't displayed even if received. Just the default "A GraphQL schema provides a root type for each kind of operation." shows up.

[acao]

I have tests that confirm that it works now!

If schema prop was provided it was already working, just had to specify schemaDescription: true in getIntrospectionQuery(), see #2077! if you want to try this before it's released, you can try the canary release mentioned in the PR comments :)

[acao]

released!

[sebastienbarre]

Unfortunately 1.5.9, 1.5.11, and 1.5.12 are broken at this point when using unpkg (1.5.10 does not exist).
Only 1.5.8 is functioning.
So for people landing here, replace https://unpkg.com/graphiql/graphiql.min.js with https://unpkg.com/graphiql@1.5.8/graphiql.min.js until it is fixed.

The latest error message is:

{
  "errors": [
    "{\n  \"errors\": [\n    {\n      \"message\": \"Cannot query field \\\"description\\\" on type \\\"__Schema\\\".\",\n      \"extensions\": {\n        \"category\": \"graphql\"\n      },\n      \"locations\": [\n        {\n          \"line\": 4,\n          \"column\": 9\n        }\n      ]\n    }\n  ]\n}"
  ]
}

[acao]

@sebastienbarre what version of graphql js are you using? Cypress tests are passing against graphql@16 and the latest graphql@15

[sebastienbarre]

I'm not entirely sure what you mean, but let me see if I can help.
I'm using webonyx/graphql-php: A PHP port of GraphQL reference implementation under the hood, and the latest version is v14.11.3. This is pretty much the one and only (or at least the most popular by far) GraphQL implementation for PHP.

Did GraphiQL become tied to the JavaScript reference implementation for GraphQL specifically?
I thought one could use it against any server implementation of the spec, seems it had been the case for a while now...

[acao]

@saihaj or @IvanGoncharov what do I do about this? do i feature flag based on the version when introspection schemaDescription was introduced? Or set the peer dependency at the version when graphql introduced this, add a note to the docs, and move on?

I could also make it an opt-in feature via a prop as I did with inputTypeDeprecation

[acao]

ohh right so @sebastienbarre this is a schema introspection issue. this means graphql-php doesn't support schema description in type introspection

[acao]

this is where graphql-php is missing the description field for Schema:

https://github.com/webonyx/graphql-php/blob/44ed079229b6e954ba4edd55e65d697a2df67211/src/Type/Introspection.php#L233

we use this at work, so maybe I'll add it :)

[acao]

@learnerEvermore this is now an opt-in feature via props, fyi! same with argument deprecations which is now supported by DocExplorer as well. It seems that a lot of GraphQL reference implementations need to add the __Schema.documentation field

[sebastienbarre]

Thanks @acao. I'm going to try to tag @spawnia here since they are very active on that graphqlphp repo and that feature might be in v15.

[spawnia]

Tracked in webonyx/graphql-php#1027, I will happily accept PRs.

[learnerEvermore]

I confirmed that this works now, with the freshest version from unpkg.

[learnerEvermore]

Thank you!