From ca115f53818f22fdcf399af006aa63854912a405 Mon Sep 17 00:00:00 2001 From: "radoslaw.kowalski" Date: Mon, 3 Aug 2020 09:26:29 +0200 Subject: [PATCH] Docs note on GraphiQL headers setting --- docs/settings.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index c2f8600..587e8b5 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -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, + }