-
Notifications
You must be signed in to change notification settings - Fork 40.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Temporarily escape monospaced text that will not be linked
Escape elements that we know cannot be converted to a javadoc link. See gh-41614
- Loading branch information
Showing
37 changed files
with
94 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...docs/src/docs/antora/modules/appendix/pages/test-auto-configuration/slices.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[[appendix.test-auto-configuration.slices]] | ||
= Test Slices | ||
|
||
The following table lists the various `@...Test` annotations that can be used to test slices of your application and the auto-configuration that they import by default: | ||
The following table lists the various `+@...Test+` annotations that can be used to test slices of your application and the auto-configuration that they import by default: | ||
|
||
include::partial$slices/documented-slices.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -108,7 +108,7 @@ If your application is a web application (Spring MVC, Spring WebFlux, or Jersey) | |
|
||
| `logfile` | ||
| Returns the contents of the logfile (if the `logging.file.name` or the `logging.file.path` property has been set). | ||
Supports the use of the HTTP `Range` header to retrieve part of the log file's content. | ||
Supports the use of the HTTP `+Range+` header to retrieve part of the log file's content. | ||
|
||
| `prometheus` | ||
| Exposes metrics in a format that can be scraped by a Prometheus server. | ||
|
@@ -398,7 +398,7 @@ Operations on an endpoint receive input through their parameters. | |
When exposed over the web, the values for these parameters are taken from the URL's query parameters and from the JSON request body. | ||
When exposed over JMX, the parameters are mapped to the parameters of the MBean's operations. | ||
Parameters are required by default. | ||
They can be made optional by annotating them with either `@javax.annotation.Nullable` or `@org.springframework.lang.Nullable`. | ||
They can be made optional by annotating them with either `+@javax.annotation.Nullable+` or `@org.springframework.lang.Nullable`. | ||
|
||
You can map each root property in the JSON request body to a parameter of the endpoint. | ||
Consider the following JSON request body: | ||
|
@@ -531,7 +531,7 @@ NOTE: Range requests are not supported when using Jersey. | |
==== Web Endpoint Security | ||
|
||
An operation on a web endpoint or a web-specific endpoint extension can receive the current `java.security.Principal` or `org.springframework.boot.actuate.endpoint.SecurityContext` as a method parameter. | ||
The former is typically used in conjunction with `@Nullable` to provide different behavior for authenticated and unauthenticated users. | ||
The former is typically used in conjunction with either `[email protected]+` or `@org.springframework.lang.Nullable` to provide different behavior for authenticated and unauthenticated users. | ||
The latter is typically used to perform authorization checks by using its `isUserInRole(String)` method. | ||
|
||
|
||
|
@@ -989,7 +989,7 @@ Some external systems might not be shared by application instances, in which cas | |
Other external systems might not be essential to the application (the application could have circuit breakers and fallbacks), in which case they definitely should not be included. | ||
Unfortunately, an external system that is shared by all application instances is common, and you have to make a judgement call: Include it in the readiness probe and expect that the application is taken out of service when the external service is down or leave it out and deal with failures higher up the stack, perhaps by using a circuit breaker in the caller. | ||
|
||
NOTE: If all instances of an application are unready, a Kubernetes Service with `type=ClusterIP` or `NodePort` does not accept any incoming connections. | ||
NOTE: If all instances of an application are unready, a Kubernetes Service with `type=ClusterIP` or `+NodePort+` does not accept any incoming connections. | ||
There is no HTTP error response (503 and so on), since there is no connection. | ||
A service with `type=LoadBalancer` might or might not accept connections, depending on the provider. | ||
A service that has an explicit https://kubernetes.io/docs/concepts/services-networking/ingress/[ingress] also responds in a way that depends on the implementation -- the ingress service itself has to decide how to handle the "`connection refused`" from downstream. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.