diff --git a/docs/index.rst b/docs/index.rst index be6065c..373969e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,7 @@ For more advanced use, check out the Relay tutorial. fields extra-types mutations + subscriptions filtering authorization debug diff --git a/docs/settings.rst b/docs/settings.rst index d646641..c2f8600 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -104,7 +104,7 @@ Default: ``100`` ``CAMELCASE_ERRORS`` ------------------------------------- +-------------------- When set to ``True`` field names in the ``errors`` object will be camel case. By default they will be snake case. @@ -151,7 +151,7 @@ Default: ``False`` ``DJANGO_CHOICE_FIELD_ENUM_CUSTOM_NAME`` --------------------------------------- +---------------------------------------- Define the path of a function that takes the Django choice field and returns a string to completely customise the naming for the Enum type. @@ -173,7 +173,7 @@ Default: ``None`` ``SUBSCRIPTION_PATH`` --------------------------------------- +--------------------- Define an alternative URL path where subscription operations should be routed. @@ -182,6 +182,7 @@ The GraphiQL interface will use this setting to intelligently route subscription Default: ``None`` .. code:: python + GRAPHENE = { 'SUBSCRIPTION_PATH': "/ws/graphql" } diff --git a/docs/subscriptions.rst b/docs/subscriptions.rst index 734d625..b1631c3 100644 --- a/docs/subscriptions.rst +++ b/docs/subscriptions.rst @@ -1,9 +1,9 @@ -Subscription Support -==================== +Subscriptions +============= The ``graphene-django`` project does not currently support GraphQL subscriptions out of the box. However, there are -several community-driven modules for adding subscription support, and the GraphiQL interface provided by -``graphene-django`` supports subscriptions over websockets. +several community-driven modules for adding subscription support, and the provided GraphiQL interface supports +running subscription operations over a websocket. To implement websocket-based support for GraphQL subscriptions, you’ll need to do the following: