Skip to content

Commit d6e55da

Browse files
committed
More upgrade doc fixes.
1 parent 57ad849 commit d6e55da

File tree

1 file changed

+52
-11
lines changed

1 file changed

+52
-11
lines changed

doc/upgrade/beta6.md

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ In a nutshell, if you were using this kind of query:
99

1010
```
1111
query {
12-
route(path: "/node/1") {
12+
route(path: "/node/1") {
1313
entity {
14-
entityLabel
14+
entityLabel
1515
}
1616
}
1717
}
@@ -20,10 +20,10 @@ query {
2020
It has to become this:
2121
```
2222
query {
23-
route(path: "/node/1") {
24-
... EntityCanonicalUrl {
23+
route(path: "/node/1") {
24+
... EntityCanonicalUrl {
2525
entity {
26-
entityLabel
26+
entityLabel
2727
}
2828
}
2929
}
@@ -153,17 +153,58 @@ Due to the way the new execution library handles results, `null` values in Strin
153153
## API changes
154154
These changes affect you if you’ve been developing custom schema plugins.
155155

156-
## API changes
157156
### Development flag
158157
The three settings for result cache, schema cache and field security have been replaced with one `development` flag, which turns the GraphQL module into development mode. This will also enable advanced error reporting in the underlying execution library.
159158

159+
Before:
160+
```yaml
161+
parameters:
162+
graphql.config:
163+
# GraphQL result cache:
164+
#
165+
# By default, the GraphQL results get cached. This can be disabled during development.
166+
#
167+
# @default true
168+
result_cache: true
169+
170+
# GraphQL schema cache:
171+
#
172+
# By default, the GraphQL schema gets cached. This can be disabled during development.
173+
#
174+
# @default true
175+
schema_cache: true
176+
177+
# Development mode:
178+
#
179+
# Disables field security. All fields can be resolved without restrictions.
180+
#
181+
# @default false
182+
development: false
183+
```
184+
185+
After:
186+
```yaml
187+
parameters:
188+
graphql.config:
189+
# Development mode:
190+
#
191+
# Enables debugging mode and disables field security and caching.
192+
#
193+
# When enabled, all fields can be resolved without restrictions
194+
# and the caching strategy of the schema and query results is
195+
# disabled entirely.
196+
#
197+
# @default false
198+
development: false
199+
```
200+
160201
### Enum definitions
161202
`buildEnumValues` has to return an array of the following structure:
162203

163204
```php
164205
[
165-
'VALUE_A' => [
166-
'value' => 'a',
206+
'VALUE_A' => [
207+
'value' => 'a',
167208
'description' => 'The letter a',
168209
],
169210
]
@@ -172,9 +213,9 @@ The three settings for result cache, schema cache and field security have been r
172213
Instead of:
173214
```php
174215
[
175-
[
176-
'value' => 'a',
177-
'name' => 'VALUE_A',
216+
[
217+
'value' => 'a',
218+
'name' => 'VALUE_A',
178219
'description' => 'The letter a',
179220
],
180221
]

0 commit comments

Comments
 (0)