Skip to content

Commit 6e155c0

Browse files
committed
Update reference doc links to Spring Boot 3.3.x
Closes gh-1016
1 parent 096dcd3 commit 6e155c0

9 files changed

+22
-22
lines changed

build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ext {
44
moduleProjects = [project(":spring-graphql"), project(":spring-graphql-test")]
55
springFrameworkVersion = "6.1.9"
66
graphQlJavaVersion = "22.1"
7-
springBootVersion = "3.2.2"
7+
springBootVersion = "3.3.0"
88
}
99

1010
subprojects {

spring-graphql-docs/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@ asciidoc:
2929
javadoc: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/api
3030
# version attributes from main build.gradle
3131
spring-framework-ref-docs: https://docs.spring.io/spring-framework/reference
32-
spring-boot-ref-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/html
32+
spring-boot-ref-docs: https://docs.spring.io/spring-boot/{spring-boot-version}
3333
examples-repo: https://github.com/spring-projects/spring-graphql-examples

spring-graphql-docs/modules/ROOT/pages/boot-starter.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ https://github.com/spring-projects/spring-graphql/wiki/Spring-for-GraphQL-Versio
88
The easiest way to get started is via https://start.spring.io by selecting
99
"Spring for GraphQL" along with an underlying transport such as Spring MVC of WebFlux over
1010
HTTP or WebSocket, or over RSocket. Refer to the
11-
https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.graphql[Spring for GraphQL Starter]
11+
{spring-boot-ref-docs}/reference/web/spring-graphql.html[Spring for GraphQL Starter]
1212
section in the Spring Boot reference for details on supported transports, auto-configuration related
1313
features, and more. For testing support, see
14-
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.testing.spring-boot-applications.spring-graphql-tests[Auto-Configured GraphQL Tests].
14+
{spring-boot-ref-docs}/reference/testing/spring-boot-applications.html#testing.spring-boot-applications.spring-graphql-tests[Auto-Configured GraphQL Tests].
1515

1616
For further reference, check the following GraphQL related:
1717

18-
- https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.metrics.supported.spring-graphql[Metrics]
19-
- https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.web[Properties]
20-
- https://docs.spring.io/spring-boot/docs/current/reference/html/auto-configuration-classes.html#appendix.auto-configuration-classes.core[Auto-Configuration Classes]
18+
- {spring-boot-ref-docs}/appendix/application-properties/index.html#appendix.application-properties.web[Configuration Properties]
19+
- {spring-boot-ref-docs}/appendix/auto-configuration-classes/core.html[GraphQL Auto-Configuration Classes]
20+
- {spring-boot-ref-docs}/appendix/auto-configuration-classes/actuator.html[GraphQL Actuator Auto-Configuration Classes]
2121

spring-graphql-docs/modules/ROOT/pages/controllers.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ implementation of `RuntimeWiringConfigurer` which can be added to `GraphQlSource
3939
The xref:boot-starter.adoc[Boot Starter] automatically declares `AnnotatedControllerConfigurer` as a bean
4040
and adds all `RuntimeWiringConfigurer` beans to `GraphQlSource.Builder` and that enables
4141
support for annotated ``DataFetcher``s, see the
42-
{spring-boot-ref-docs}/web.html#web.graphql.runtimewiring[GraphQL RuntimeWiring] section
42+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.runtimewiring[GraphQL RuntimeWiring] section
4343
in the Boot starter documentation.
4444

4545

spring-graphql-docs/modules/ROOT/pages/graalvm-native.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44
Spring Framework 6.0 introduced the support infrastructure for compiling Spring applications to https://www.graalvm.org/22.3/reference-manual/native-image/[GraalVM Native images].
55
If you are not familiar with GraalVM in general, how this differs from applications deployed on the JVM and what it means for Spring application,
6-
please refer to the dedicated {spring-boot-ref-docs}/native-image.html#native-image[Spring Boot 3.0 GraalVM Native Image support documentation].
6+
please refer to the dedicated {spring-boot-ref-docs}/reference/native-image/introducing-graalvm-native-images.html[Spring Boot 3.x GraalVM Native Image support documentation].
77
Spring Boot also documents the https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-with-GraalVM[know limitations with the GraalVM support in Spring].
88

99

1010
[[graalvm.graphql-java]]
1111
== GraphQL Java metadata
1212

13-
Since the {spring-boot-ref-docs}/native-image.html#native-image.introducing-graalvm-native-images.key-differences-with-jvm-deployments[static analysis of your application is done at build time],
13+
Since the {spring-boot-ref-docs}/reference/native-image/introducing-graalvm-native-images.html#native-image.introducing-graalvm-native-images.key-differences-with-jvm-deployments[static analysis of your application is done at build time],
1414
GraalVM might need extra hints if your application is looking up static resources, performing reflection or creating JDK proxies at runtime.
1515

1616
GraphQL Java is performing three tasks at runtime that Native Images are sensible to:

spring-graphql-docs/modules/ROOT/pages/graphiql.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ During development, a stock GraphiQL integration is often enough to help develop
77
In production, applications can require a custom GraphiQL build, that ships with a company logo or specific authentication support.
88

99
Spring for GraphQL ships with https://github.com/spring-projects/spring-graphql/blob/main/spring-graphql/src/main/resources/graphiql/index.html[a stock GraphiQL `index.html` page] that uses static resources hosted on the unpkg.com CDN.
10-
Spring Boot applications can easily {spring-boot-ref-docs}/web.html#web.graphql.graphiql[enable this page with a configuration property].
10+
Spring Boot applications can easily {spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.graphiql[enable this page with a configuration property].
1111

1212
Your application may need a custom GraphiQL build if it requires a setup that doesn't rely on a CDN, or if you wish to customize the user interface.
1313
This can be done in two steps:
@@ -35,4 +35,4 @@ include-code::GraphiQlConfiguration[]
3535
<3> Finally, map the handler to a specific HTTP endpoint
3636
<4> Expose this new route through a `RouterFunction` bean
3737

38-
You might also need to configure your application to {spring-boot-ref-docs}/web.html#web.servlet.spring-mvc.static-content[serve the relevant static resources].
38+
You might also need to configure your application to {spring-boot-ref-docs}/reference/web/servlet.html#web.servlet.spring-mvc.static-content[serve the relevant static resources].

spring-graphql-docs/modules/ROOT/pages/observability.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[[observability]]
22
= Observability
33

4-
https://micrometer.io/docs/observation[Observability support with Micrometer] is directly instrumented in Spring for GraphQL.
4+
https://docs.micrometer.io/micrometer/reference/observation.html[Observability support with Micrometer] is directly instrumented in Spring for GraphQL.
55
This enables both metrics and traces for GraphQL requests and "non-trivial" data fetching operations.
66
Because the GraphQL engine operates on top of a transport layer, you should also {spring-framework-ref-docs}/integration/observability.html[expect observations from the transport], if supported in Spring Framework.
77

88
Observations are only published if an `ObservationRegistry` is configured in the application.
9-
You can learn more about {spring-boot-ref-docs}/actuator.html#actuator.metrics[configuring the observability infrastructure in Spring Boot].
9+
You can learn more about {spring-boot-ref-docs}/reference/actuator/metrics.html[configuring the observability infrastructure in Spring Boot].
1010
If you would like to customize the metadata produced with the GraphQL observations, you can {spring-framework-ref-docs}/integration/observability.html#observability.config.conventions[configure a custom convention on the instrumentation directly].
1111
If your application is using Spring Boot, contributing the custom convention as a bean is the preferred way.
1212

spring-graphql-docs/modules/ROOT/pages/request-execution.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ includes a builder API to build that instance. The default builder is available
1919

2020
The xref:boot-starter.adoc[Boot Starter] creates an instance of this builder and further initializes it
2121
to xref:request-execution.adoc#execution.graphqlsource.schema-resources[load schema files] from a configurable location,
22-
to {spring-boot-ref-docs}/application-properties.html#appendix.application-properties.web[expose properties]
22+
to {spring-boot-ref-docs}/appendix/application-properties/index.html#appendix.application-properties.web[expose properties]
2323
to apply to `GraphQlSource.Builder`, to detect
2424
xref:request-execution.adoc#execution.graphqlsource.runtimewiring-configurer[`RuntimeWiringConfigurer`] beans,
2525
https://www.graphql-java.com/documentation/instrumentation[Instrumentation] beans for
26-
{spring-boot-ref-docs}/actuator.html#actuator.metrics.supported.spring-graphql[GraphQL metrics],
26+
xref:observability.adoc#observability[GraphQL metrics],
2727
and `DataFetcherExceptionResolver` and `SubscriptionExceptionResolver` beans for
2828
xref:request-execution.adoc#execution.exceptions[exception resolution]. For further customizations, you can also
2929
declare a `GraphQlSourceBuilderCustomizer` bean, for example:
@@ -52,7 +52,7 @@ parsed and merged together. That means schema files can be loaded from just abou
5252
location.
5353

5454
By default, the Boot starter
55-
{spring-boot-ref-docs}/web.html#web.graphql.schema[looks for schema files] with extensions
55+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.schema[looks for schema files] with extensions
5656
".graphqls" or ".gqls" under the location `classpath:graphql/**`, which is typically
5757
`src/main/resources/graphql`. You can also use a file system location, or any location
5858
supported by the Spring `Resource` hierarchy, including a custom implementation that

spring-graphql-docs/modules/ROOT/pages/transports.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ is also supported, as described in the specification.
2525
`GraphQlHttpHandler` can be exposed as an HTTP endpoint by declaring a `RouterFunction`
2626
bean and using the `RouterFunctions` from Spring MVC or WebFlux to create the route. The
2727
xref:boot-starter.adoc[Boot Starter] does this, see the
28-
{spring-boot-ref-docs}/web.html#web.graphql.transports.http-websocket[Web Endpoints] section for
28+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.transports.http-websocket[Web Endpoints] section for
2929
details, or check `GraphQlWebMvcAutoConfiguration` or `GraphQlWebFluxAutoConfiguration`
3030
it contains, for the actual config.
3131

@@ -112,9 +112,9 @@ https://github.com/enisdenjo/graphql-ws#recipes[recipes] for client use.
112112
`SimpleUrlHandlerMapping` bean and using it to map the handler to a URL path. By default,
113113
the xref:boot-starter.adoc[Boot Starter] does not expose a GraphQL over WebSocket endpoint,
114114
but you can add a property for the endpoint path to enable it. Please, review
115-
{spring-boot-ref-docs}/web.html#web.graphql.transports.http-websocket[Web Endpoints]
115+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.transports.http-websocket[Web Endpoints]
116116
in the Boot reference documentation, and the list of supported `spring.graphql.websocket`
117-
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.web[properties].
117+
{spring-boot-ref-docs}/appendix/application-properties/index.html#appendix.application-properties.web[properties].
118118
You can also look at `GraphQlWebMvcAutoConfiguration` or`GraphQlWebFluxAutoConfiguration`
119119
for the actual Boot autoconfig details.
120120

@@ -182,7 +182,7 @@ include-code::RequestErrorInterceptor[]
182182

183183
Use `WebGraphQlHandler` to configure the `WebGraphQlInterceptor` chain. This is supported
184184
by the xref:boot-starter.adoc[Boot Starter], see
185-
{spring-boot-ref-docs}/web.html#web.graphql.transports.http-websocket[Web Endpoints].
185+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.transports.http-websocket[Web Endpoints].
186186

187187

188188
[[server.interception.websocket]]
@@ -195,7 +195,7 @@ WebSocket connection.
195195

196196
Use `WebGraphQlHandler` to configure the `WebGraphQlInterceptor` chain. This is supported
197197
by the xref:boot-starter.adoc[Boot Starter], see
198-
{spring-boot-ref-docs}/web.html#web.graphql.transports.http-websocket[Web Endpoints].
198+
{spring-boot-ref-docs}/reference/web/spring-graphql.html#web.graphql.transports.http-websocket[Web Endpoints].
199199
There can be at most one `WebSocketGraphQlInterceptor` in a chain of interceptors.
200200

201201
There are two built-in WebSocket interceptors called `AuthenticationWebSocketInterceptor`,

0 commit comments

Comments
 (0)