Commit eeb947b3 authored by Phillip Webb's avatar Phillip Webb

Polish docs

parent e3b59774
...@@ -161,16 +161,16 @@ For example, the following will disable _all_ endpoints except for `info`: ...@@ -161,16 +161,16 @@ For example, the following will disable _all_ endpoints except for `info`:
[[production-ready-endpoint-hypermedia]] [[production-ready-endpoint-hypermedia]]
=== Hypermedia for MVC Endpoints === Hypermedia for actuator MVC endpoints
If http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath (e.g. If http://projects.spring.io/spring-hateoas[Spring HATEOAS] is on the classpath (e.g.
through the `spring-boot-starter-hateoas` or if you are using through the `spring-boot-starter-hateoas` or if you are using
http://projects.spring.io/spring-data-rest[Spring Data REST]) then the HTTP endpoints http://projects.spring.io/spring-data-rest[Spring Data REST]) then the HTTP endpoints
from the Actuator are enhanced with hypermedia links, and a "discovery page" is added from the Actuator are enhanced with hypermedia links, and a "`discovery page`" is added
with links to all the endpoints. The "discovery page" is actually an endpoint itself, with links to all the endpoints. The "`discovery page`" is actually an endpoint itself,
so it can be disabled along with the rest of the hypermedia by setting so it can be disabled along with the rest of the hypermedia by setting
`endpoints.links.enabled=false`. If it is not explicitly disabled the links `endpoints.links.enabled=false`. If it is not explicitly disabled the links
endpoint renders a JSON object with a link for each other endpoint, and the default endpoint renders a JSON object with a link for each other endpoint, and the default
path is the same as the `management.contentPath` (so "`/`" by default). path is the same as the `management.content-path` (so "`/`" by default).
NOTE: if there is a static home page ("`index.html`") in your application and the links NOTE: if there is a static home page ("`index.html`") in your application and the links
endpoint is registered with its default path ("`/`") then content negotiation will kick in endpoint is registered with its default path ("`/`") then content negotiation will kick in
...@@ -186,7 +186,7 @@ the other endpoints. ...@@ -186,7 +186,7 @@ the other endpoints.
[[production-ready-customizing-endpoints-programmatically]] [[production-ready-customizing-endpoints-programmatically]]
=== Adding Custom Endpoints === Adding custom endpoints
If you add a `@Bean` of type `Endpoint` then it will automatically be exposed over JMX and If you add a `@Bean` of type `Endpoint` then it will automatically be exposed over JMX and
HTTP (if there is an server available). An HTTP endpoints can be customized further by HTTP (if there is an server available). An HTTP endpoints can be customized further by
creating a bean of type `MvcEndpoint`. Your `MvcEndpoint` is not a `@Controller` but it creating a bean of type `MvcEndpoint`. Your `MvcEndpoint` is not a `@Controller` but it
......
...@@ -73,7 +73,7 @@ display (surrounded with brackets and prefixed with `v`). For example `(v1.0)`. ...@@ -73,7 +73,7 @@ display (surrounded with brackets and prefixed with `v`). For example `(v1.0)`.
|The Spring Boot version that you are using formatted for display (surrounded with |The Spring Boot version that you are using formatted for display (surrounded with
brackets and prefixed with `v`). For example `(v{spring-boot-version})`. brackets and prefixed with `v`). For example `(v{spring-boot-version})`.
|`${Ansi.NAME}`, |`${Ansi.NAME}` (or `${AnsiColor.NAME}`, `${AnsiBackground.NAME}`, `${AnsiStyle.NAME}`)
|Where `NAME` is the name of an ANSI escape code. See |Where `NAME` is the name of an ANSI escape code. See
{sc-spring-boot}/ansi/AnsiPropertySource.{sc-ext}[`AnsiPropertySource`] for details. {sc-spring-boot}/ansi/AnsiPropertySource.{sc-ext}[`AnsiPropertySource`] for details.
|=== |===
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment