From 1fffdbae2afce8c29e2e3e95648fba3e11867abd Mon Sep 17 00:00:00 2001 From: Anthony Vanelverdinghe Date: Fri, 10 Jun 2022 11:17:53 +0200 Subject: [PATCH] Fix typos in the reference documentation See gh-31328 --- .../spring-boot-docs/src/docs/asciidoc/data/sql.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/web/servlet.adoc | 2 +- .../src/docs/asciidoc/web/spring-security.adoc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc index 69619c935023..b6a1d0bd4e9d 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc @@ -251,7 +251,7 @@ For complete details, see the {spring-data-jpa-docs}[Spring Data JPA reference d ==== Spring Data Envers Repositories If {spring-data-envers}[Spring Data Envers] is available, JPA repositories are auto-configured to support typical Envers queries. -To use Spring Data Envers, make sure your repository extends from `RevisionRepository` as show in the following example: +To use Spring Data Envers, make sure your repository extends from `RevisionRepository` as shown in the following example: [source,java,indent=0,subs="verbatim"] ---- diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc index 02c6139afd3f..1921c4c06d44 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc @@ -369,7 +369,7 @@ You can also define a class annotated with `@ControllerAdvice` to customize the include::{docs-java}/web/servlet/springmvc/errorhandling/MyControllerAdvice.java[] ---- -In the preceding example, if `YourException` is thrown by a controller defined in the same package as `SomeController`, a JSON representation of the `CustomErrorType` POJO is used instead of the `ErrorAttributes` representation. +In the preceding example, if `MyException` is thrown by a controller defined in the same package as `SomeController`, a JSON representation of the `MyErrorBody` POJO is used instead of the `ErrorAttributes` representation. In some cases, errors handled at the controller level are not recorded by the <>. Applications can ensure that such exceptions are recorded with the request metrics by setting the handled exception as a request attribute: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc index 86113c87f75f..83af9974caf4 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc @@ -77,7 +77,7 @@ https://oauth.net/2/[OAuth2] is a widely used authorization framework that is su [[web.security.oauth2.client]] ==== Client -If you have `spring-security-oauth2-client` on your classpath, you can take advantage of some auto-configuration to set up an OAuth2/Open ID Connect clients. +If you have `spring-security-oauth2-client` on your classpath, you can take advantage of some auto-configuration to set up OAuth2/Open ID Connect clients. This configuration makes use of the properties under `OAuth2ClientProperties`. The same properties are applicable to both servlet and reactive applications. @@ -121,7 +121,7 @@ You can register multiple OAuth2 clients and providers under the `spring.securit ---- For OpenID Connect providers that support https://openid.net/specs/openid-connect-discovery-1_0.html[OpenID Connect discovery], the configuration can be further simplified. -The provider needs to be configured with an `issuer-uri` which is the URI that the it asserts as its Issuer Identifier. +The provider needs to be configured with an `issuer-uri` which is the URI that it asserts as its Issuer Identifier. For example, if the `issuer-uri` provided is "https://example.com", then an `OpenID Provider Configuration Request` will be made to "https://example.com/.well-known/openid-configuration". The result is expected to be an `OpenID Provider Configuration Response`. The following example shows how an OpenID Connect Provider can be configured with the `issuer-uri`: