Skip to content

Commit fc2641b

Browse files
Merge pull request #274 from nicastelo/master
Documentation on how to disable introspection
2 parents 2cc15b7 + de3705f commit fc2641b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,8 @@ Here is a list of the available mutations and queries assuming your mounted mode
460460
#### Introspection query
461461
If you are using the schema plugin, you can require authentication before doing an introspection query by modifying the `public_introspection` option of the plugin. Check the [plugin config section](#mounting-operations-into-your-own-schema) for more information.
462462

463+
If you want to completely disable introspection queries, refer to [Disable Introspection](#disable-introspection)
464+
463465
#### Mutations
464466

465467
Operation | Description | Example
@@ -569,6 +571,12 @@ information you can check [this answer here](https://github.com/lynndylanhurley/
569571
This gem supports the same and should be easier to handle email templates due to the fact we don't override
570572
standard Devise templates.
571573

574+
### Disable Introspection
575+
`GraphqlDevise::Schema` extends from `GraphQL::Schema`, which allows it to utilize the `disable_introspection_entry_points` method. By calling this method, you can disable introspection entry points in your schema. You can read more about it
576+
[here](https://github.com/rmosolgo/graphql-ruby/blob/master/guides/schema/introspection.md#disabling-introspection).
577+
578+
If you are using the schema plugin and prefer to make introspection queries available only to authenticated users, you can do so by modifying the `public_introspection` option of the plugin. Check the [plugin config section](#mounting-operations-into-your-own-schema) for more information.
579+
572580
## Changelog
573581
Full list of changes in [CHANGELOG.md](CHANGELOG.md)
574582

0 commit comments

Comments
 (0)