Skip to content

Add documentation for settings #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ For more advanced use, check out the Relay tutorial.
filtering
authorization
debug
rest-framework
introspection
testing
settings
103 changes: 103 additions & 0 deletions docs/settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
Settings
========

Graphene-Django can be customised using settings. This page explains each setting and their defaults.

Usage
-----

Add settings to your Django project by creating a Dictonary with name ``GRAPHENE`` in the project's ``settings.py``:

.. code:: python

GRAPHENE = {
...
}


``SCHEMA``
----------

The location of the top-level ``Schema`` class.

Default: ``None``

.. code:: python

GRAPHENE = {
'SCHEMA': 'path.to.schema.schema',
}


``SCHEMA_OUTPUT``
----------

The name of the file where the GraphQL schema output will go.

Default: ``schema.json``

.. code:: python

GRAPHENE = {
'SCHEMA_OUTPUT': 'schema.json',
}


``SCHEMA_INDENT``
----------

The indentation level of the schema output.

Default: ``2``

.. code:: python

GRAPHENE = {
'SCHEMA_INDENT': 2,
}


``MIDDLEWARE``
----------

A tuple of middleware that will be executed for each GraphQL query.

See the `middleware documentation <https://docs.graphene-python.org/en/latest/execution/middleware/>`__ for more information.

Default: ``()``

.. code:: python

GRAPHENE = {
'MIDDLEWARE': (
'path.to.my.middleware.class',
),
}


``RELAY_CONNECTION_ENFORCE_FIRST_OR_LAST``
----------

Enforces relay queries to have the ``first`` or ``last`` argument.

Default: ``False``

.. code:: python

GRAPHENE = {
'RELAY_CONNECTION_ENFORCE_FIRST_OR_LAST': False,
}


``RELAY_CONNECTION_MAX_LIMIT``
----------

The maximum size of objects that can be requested through a relay connection.

Default: ``100``

.. code:: python

GRAPHENE = {
'RELAY_CONNECTION_MAX_LIMIT': 100,
}