graphql-python/graphene-django
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene-django.git synced 2025-07-12 17:22:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Docs note on GraphiQL headers setting

Browse Source
This commit is contained in:
radoslaw.kowalski 2020-08-03 09:26:29 +02:00
parent 29f28bc91b
commit ca115f5381
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/settings.rst
View File

@ -186,3 +186,24 @@ Default: ``None``
GRAPHENE = { GRAPHENE = {
'SUBSCRIPTION_PATH': "/ws/graphql" '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,
}