Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit f3464ec

Browse files
authored
docs: Adding graphql prefix to altair, voyager, playground property examples
1 parent 1f9b3cd commit f3464ec

File tree

1 file changed

+82
-79
lines changed

1 file changed

+82
-79
lines changed

README.md

Lines changed: 82 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -239,30 +239,31 @@ Available Spring Boot configuration parameters (either `application.yml`
239239
or `application.properties`):
240240

241241
```yaml
242-
altair:
243-
enabled: true
244-
mapping: /altair
245-
subscriptions:
246-
timeout: 30
247-
reconnect: false
248-
static:
249-
base-path: /
250-
page-title: Altair
251-
cdn:
252-
enabled: false
253-
version: 4.0.2
254-
options:
255-
endpoint-url: /graphql
256-
subscriptions-endpoint: /subscriptions
257-
initial-settings:
258-
theme: dracula
259-
initial-headers:
260-
Authorization: "Bearer <your-token>"
261-
resources:
262-
initial-query: defaultQuery.graphql
263-
initial-variables: variables.graphql
264-
initial-pre-request-script: pre-request.graphql
265-
initial-post-request-script: post-request.graphql
242+
graphql:
243+
altair:
244+
enabled: true
245+
mapping: /altair
246+
subscriptions:
247+
timeout: 30
248+
reconnect: false
249+
static:
250+
base-path: /
251+
page-title: Altair
252+
cdn:
253+
enabled: false
254+
version: 4.0.2
255+
options:
256+
endpoint-url: /graphql
257+
subscriptions-endpoint: /subscriptions
258+
initial-settings:
259+
theme: dracula
260+
initial-headers:
261+
Authorization: "Bearer <your-token>"
262+
resources:
263+
initial-query: defaultQuery.graphql
264+
initial-variables: variables.graphql
265+
initial-pre-request-script: pre-request.graphql
266+
initial-post-request-script: post-request.graphql
266267
```
267268

268269
By default Altair is served from within the package. This can be configured to be served from CDN
@@ -286,43 +287,44 @@ Available Spring Boot configuration parameters (either `application.yml`
286287
or `application.properties`):
287288

288289
```yaml
289-
graphql.playground:
290-
mapping: /playground
291-
endpoint: /graphql
292-
subscriptionEndpoint: /subscriptions
293-
staticPath.base: my-playground-resources-folder
294-
enabled: true
295-
pageTitle: Playground
296-
cdn:
297-
enabled: false
298-
version: latest
299-
settings:
300-
editor.cursorShape: line
301-
editor.fontFamily: "'Source Code Pro', 'Consolas', 'Inconsolata', 'Droid Sans Mono', 'Monaco', monospace"
302-
editor.fontSize: 14
303-
editor.reuseHeaders: true
304-
editor.theme: dark
305-
general.betaUpdates: false
306-
prettier.printWidth: 80
307-
prettier.tabWidth: 2
308-
prettier.useTabs: false
309-
request.credentials: omit
310-
schema.polling.enable: true
311-
schema.polling.endpointFilter: "*localhost*"
312-
schema.polling.interval: 2000
313-
schema.disableComments: true
314-
tracing.hideTracingResponse: true
315-
headers:
316-
headerFor: AllTabs
317-
tabs:
318-
- name: Example Tab
319-
query: classpath:exampleQuery.graphql
320-
headers:
321-
SomeHeader: Some value
322-
variables: classpath:variables.json
323-
responses:
324-
- classpath:exampleResponse1.json
325-
- classpath:exampleResponse2.json
290+
graphql:
291+
playground:
292+
mapping: /playground
293+
endpoint: /graphql
294+
subscriptionEndpoint: /subscriptions
295+
staticPath.base: my-playground-resources-folder
296+
enabled: true
297+
pageTitle: Playground
298+
cdn:
299+
enabled: false
300+
version: latest
301+
settings:
302+
editor.cursorShape: line
303+
editor.fontFamily: "'Source Code Pro', 'Consolas', 'Inconsolata', 'Droid Sans Mono', 'Monaco', monospace"
304+
editor.fontSize: 14
305+
editor.reuseHeaders: true
306+
editor.theme: dark
307+
general.betaUpdates: false
308+
prettier.printWidth: 80
309+
prettier.tabWidth: 2
310+
prettier.useTabs: false
311+
request.credentials: omit
312+
schema.polling.enable: true
313+
schema.polling.endpointFilter: "*localhost*"
314+
schema.polling.interval: 2000
315+
schema.disableComments: true
316+
tracing.hideTracingResponse: true
317+
headers:
318+
headerFor: AllTabs
319+
tabs:
320+
- name: Example Tab
321+
query: classpath:exampleQuery.graphql
322+
headers:
323+
SomeHeader: Some value
324+
variables: classpath:variables.json
325+
responses:
326+
- classpath:exampleResponse1.json
327+
- classpath:exampleResponse2.json
326328
```
327329

328330
## Basic settings
@@ -388,24 +390,25 @@ Available Spring Boot configuration parameters (either `application.yml`
388390
or `application.properties`):
389391

390392
```yaml
391-
voyager:
392-
enabled: true
393-
basePath: /
394-
mapping: /voyager
395-
endpoint: /graphql
396-
cdn:
397-
enabled: false
398-
version: latest
399-
pageTitle: Voyager
400-
displayOptions:
401-
skipRelay: true
402-
skipDeprecated: true
403-
rootType: Query
404-
sortByAlphabet: false
405-
showLeafFields: true
406-
hideRoot: false
407-
hideDocs: false
408-
hideSettings: false
393+
graphql:
394+
voyager:
395+
enabled: true
396+
basePath: /
397+
mapping: /voyager
398+
endpoint: /graphql
399+
cdn:
400+
enabled: false
401+
version: latest
402+
pageTitle: Voyager
403+
displayOptions:
404+
skipRelay: true
405+
skipDeprecated: true
406+
rootType: Query
407+
sortByAlphabet: false
408+
showLeafFields: true
409+
hideRoot: false
410+
hideDocs: false
411+
hideSettings: false
409412
```
410413

411414
## GraphQL Voyager Basic settings

0 commit comments

Comments
 (0)