Skip to content
Prev Previous commit
Next Next commit
Docs note on GraphiQL headers setting
  • Loading branch information
radekwlsk committed Aug 3, 2020
commit ca115f53818f22fdcf399af006aa63854912a405
21 changes: 21 additions & 0 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,3 +186,24 @@ Default: ``None``
GRAPHENE = {
'SUBSCRIPTION_PATH': "/ws/graphql"
}


``GRAPHIQL_HEADER_EDITOR_ENABLED``
---------------------

GraphiQL starting from version 1.0.0 allows setting custom headers in similar fashion to query variables.

Set to ``True`` to enable GraphiQL headers editor tab.

This setting is passed to ``headerEditorEnabled`` GraphiQL options, for details refer to GraphiQLDocs_.

.. _GraphiQLDocs: https://github.com/graphql/graphiql/tree/main/packages/graphiql#options


Default: ``False``

.. code:: python

GRAPHENE = {
'GRAPHIQL_HEADER_EDITOR_ENABLED': True,
}