Skip to content

Commit 46f210b

Browse files
committed
Polish documentation
1 parent 050480f commit 46f210b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

spring-graphql-docs/src/docs/asciidoc/index.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Spring GraphQL Documentation
2+
Brian Clozel; Andreas Marek; Rossen Stoyanchev
23
:toc: left
34
:toclevels: 4
45
:tabsize: 4
@@ -116,7 +117,7 @@ public class PersonDataWiring implements RuntimeWiringCustomizer {
116117
----
117118

118119
You can now start your application!
119-
A GraphiQL web interface is available at `http://localhost:8080/graphql` and you can use GraphQL clients
120+
A GraphiQL web interface is available at `http://localhost:8080/graphiql` and you can use GraphQL clients
120121
to POST queries at the same location.
121122

122123

@@ -130,7 +131,7 @@ The Spring GraphQL project offers a few configuration properties to customize yo
130131
# web path to the graphql endpoint
131132
spring.graphql.path=/graphql
132133
# locations of the graphql schema files
133-
# scanning for files with well-known extensions: '*.graphqls', '*.gqls', '*.graphql', '*.gql'
134+
# scanning for files with well-known extensions: '.graphqls', '.gqls', '.graphql', '.gql'
134135
spring.graphql.schema.locations=classpath:graphql/
135136
# schema printer endpoint configuration
136137
# endpoint path is concatenated with the main path, so "/graphql/schema" by default
@@ -147,7 +148,7 @@ You can contribute `RuntimeWiringCustomizer` beans to the context in order to co
147148

148149
=== WebSocket support
149150

150-
This project also supports WebSocket as a transport for GraphQL requests - you can use it to build [`Subscription` queries](http://spec.graphql.org/draft/#sec-Subscription).
151+
This project also supports WebSocket as a transport for GraphQL requests - you can use it to build http://spec.graphql.org/draft/#sec-Subscription[`Subscription` queries].
151152
This use case is powered by Reactor `Flux`, check out the `samples/webflux-websocket` sample application for more.
152153

153154
To enable this support, you need to configure the `spring.graphql.websocket.path` property in your application
@@ -275,4 +276,6 @@ You can run them by cloning this repository and typing on the command line:
275276
----
276277
$ ./gradlew :samples:webmvc-http:bootRun
277278
$ ./gradlew :samples:webflux-websocket:bootRun
279+
$ ./gradlew :samples:webmvc-http-security:bootRun
280+
$ ./gradlew :samples:webflux-security:bootRun
278281
----

0 commit comments

Comments
 (0)