Enable schemaDescription for getIntrospectionQuery

graphql · Dec 4, 2021 · 1cc793a · 1cc793a
1 parent fe5bb0d
commit 1cc793a
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/.changeset/smooth-elephants-eat.md b/.changeset/smooth-elephants-eat.md
@@ -0,0 +1,5 @@
+---
+'graphiql': patch
+---
+
+Include schema description in DocExplorer for schema introspection requests. Enables the `schemaDescription` option for `getIntrospectionQuery()`.
diff --git a/packages/graphiql/src/components/__tests__/DocExplorer.spec.tsx b/packages/graphiql/src/components/__tests__/DocExplorer.spec.tsx
@@ -26,5 +26,8 @@ describe('DocExplorer', () => {
     const { container } = render(<DocExplorer schema={ExampleSchema} />);
     const error = container.querySelectorAll('.error-container');
     expect(error).toHaveLength(0);
+    expect(container.querySelector('.doc-type-description')).toHaveTextContent(
+      'GraphQL Schema for testing',
+    );
   });
 });
diff --git a/packages/graphiql/src/components/__tests__/ExampleSchema.ts b/packages/graphiql/src/components/__tests__/ExampleSchema.ts
@@ -93,4 +93,5 @@ export const ExampleQuery = new GraphQLObjectType({
 
 export const ExampleSchema = new GraphQLSchema({
   query: ExampleQuery,
+  description: 'GraphQL Schema for testing',
 });
diff --git a/packages/graphiql/src/utility/introspectionQueries.ts b/packages/graphiql/src/utility/introspectionQueries.ts
@@ -7,7 +7,9 @@
 
 import { getIntrospectionQuery } from 'graphql';
 
-export const introspectionQuery = getIntrospectionQuery();
+export const introspectionQuery = getIntrospectionQuery({
+  schemaDescription: true,
+});
 
 export const staticName = 'IntrospectionQuery';
 

diff --git a/packages/graphiql/test/schema.js b/packages/graphiql/test/schema.js
@@ -347,6 +347,7 @@ const myTestSchema = new GraphQLSchema({
   query: TestType,
   mutation: TestMutationType,
   subscription: TestSubscriptionType,
+  description: 'This is a test schema for GraphiQL',
 });
 
 module.exports = myTestSchema;