Skip to content

Commit dff7ced

Browse files
committed
Add docs for execution_context_class
1 parent 28e1585 commit dff7ced

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

docs/aiohttp.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,12 @@ gql_view(request) # <-- the instance is callable and expects a `aiohttp.web.Req
5555
* `graphiql_version`: The graphiql version to load. Defaults to **"1.0.3"**.
5656
* `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
5757
* `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
58-
* `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses
58+
* `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses
5959
`Template.render_async` instead of `Template.render`. If environment is not set, fallbacks to simple regex-based renderer.
6060
* `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
6161
* `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
6262
* `validation_rules`: A list of graphql validation rules.
63+
* `execution_context_class`: Specifies a custom execution context class.
6364
* `max_age`: Sets the response header Access-Control-Max-Age for preflight requests.
6465
* `encode`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`).
6566
* `format_error`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`.

docs/flask.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ More info at [Graphene v3 release notes](https://github.com/graphql-python/graph
5858
* `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
5959
* `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
6060
* `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
61-
* `validation_rules`: A list of graphql validation rules.
61+
* `validation_rules`: A list of graphql validation rules.
62+
* `execution_context_class`: Specifies a custom execution context class.
6263
* `encode`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`).
6364
* `format_error`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`.
6465
* `subscriptions`: The GraphiQL socket endpoint for using subscriptions in graphql-ws.
@@ -79,4 +80,4 @@ class UserRootValue(GraphQLView):
7980
```
8081

8182
## Contributing
82-
See [CONTRIBUTING.md](../CONTRIBUTING.md)
83+
See [CONTRIBUTING.md](../CONTRIBUTING.md)

docs/sanic.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,12 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
4747
* `graphiql_version`: The graphiql version to load. Defaults to **"1.0.3"**.
4848
* `graphiql_template`: Inject a Jinja template string to customize GraphiQL.
4949
* `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
50-
* `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses
50+
* `jinja_env`: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by `enable_async=True`), uses
5151
`Template.render_async` instead of `Template.render`. If environment is not set, fallbacks to simple regex-based renderer.
5252
* `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
5353
* `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
54-
* `validation_rules`: A list of graphql validation rules.
54+
* `validation_rules`: A list of graphql validation rules.
55+
* `execution_context_class`: Specifies a custom execution context class.
5556
* `max_age`: Sets the response header Access-Control-Max-Age for preflight requests.
5657
* `encode`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`).
5758
* `format_error`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`.
@@ -72,4 +73,4 @@ class UserRootValue(GraphQLView):
7273
```
7374

7475
## Contributing
75-
See [CONTRIBUTING.md](../CONTRIBUTING.md)
76+
See [CONTRIBUTING.md](../CONTRIBUTING.md)

docs/webob.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
4848
* `graphiql_html_title`: The graphiql title to display. Defaults to **"GraphiQL"**.
4949
* `batch`: Set the GraphQL view as batch (for using in [Apollo-Client](http://dev.apollodata.com/core/network.html#query-batching) or [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer))
5050
* `middleware`: A list of graphql [middlewares](http://docs.graphene-python.org/en/latest/execution/middleware/).
51-
* `validation_rules`: A list of graphql validation rules.
51+
* `validation_rules`: A list of graphql validation rules.
52+
* `execution_context_class`: Specifies a custom execution context class.
5253
* `encode`: the encoder to use for responses (sensibly defaults to `graphql_server.json_encode`).
5354
* `format_error`: the error formatter to use for responses (sensibly defaults to `graphql_server.default_format_error`.
5455
* `enable_async`: whether `async` mode will be enabled.
@@ -59,4 +60,4 @@ This will add `/graphql` endpoint to your app and enable the GraphiQL IDE.
5960
* `should_persist_headers`: An optional boolean which enables to persist headers to storage when true. Defaults to **false**.
6061

6162
## Contributing
62-
See [CONTRIBUTING.md](../CONTRIBUTING.md)
63+
See [CONTRIBUTING.md](../CONTRIBUTING.md)

0 commit comments

Comments
 (0)