Skip to content

Commit ca115f5

Browse files
committed
Docs note on GraphiQL headers setting
1 parent 29f28bc commit ca115f5

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/settings.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,24 @@ Default: ``None``
186186
GRAPHENE = {
187187
'SUBSCRIPTION_PATH': "/ws/graphql"
188188
}
189+
190+
191+
``GRAPHIQL_HEADER_EDITOR_ENABLED``
192+
---------------------
193+
194+
GraphiQL starting from version 1.0.0 allows setting custom headers in similar fashion to query variables.
195+
196+
Set to ``True`` to enable GraphiQL headers editor tab.
197+
198+
This setting is passed to ``headerEditorEnabled`` GraphiQL options, for details refer to GraphiQLDocs_.
199+
200+
.. _GraphiQLDocs: https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
201+
202+
203+
Default: ``False``
204+
205+
.. code:: python
206+
207+
GRAPHENE = {
208+
'GRAPHIQL_HEADER_EDITOR_ENABLED': True,
209+
}

0 commit comments

Comments
 (0)