From 672281c2148668ce0f16edb74671e33c298e97bc Mon Sep 17 00:00:00 2001 From: izeye Date: Mon, 20 Jul 2015 21:51:25 +0900 Subject: [PATCH] Polish docs Closes gh-3561 --- .../src/main/asciidoc/appendix-application-properties.adoc | 6 ++++++ .../src/main/asciidoc/production-ready-features.adoc | 6 +++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index e1416f92dd..84dcf91aa5 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -680,6 +680,12 @@ content into your application; rather pick only the properties that you need. endpoints.trace.id=trace endpoints.trace.sensitive=true endpoints.trace.enabled=true + + # HYPERMEDIA ENDPOINTS + endpoints.docs.enabled=false + endpoints.docs.curies.enabled=false + endpoints.hal.enabled=true + endpoints.links.enable=true # ENDPOINTS CORS CONFIGURATION ({sc-spring-boot-actuator}/autoconfigure/MvcEndpointCorsProperties.{sc-ext}[MvcEndpointCorsProperties]) endpoints.cors.allow-credentials= # set whether user credentials are support. When not set, credentials are not supported. diff --git a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index 0a3b6df493..bae135bd3d 100644 --- a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -173,15 +173,15 @@ with links to all the endpoints. The "`discovery page`" is actually an endpoint 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 endpoint renders a JSON object with a link for each other endpoint, and the default -path is the same as the `management.content-path` (so "`/`" by default). +path is the same as the `management.context-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 to determine which content is shown to a client that requests the home page (the links will show only if the client accepts `application/json`). If the https://github.com/mikekelly/hal-browser[HAL Browser] is on the classpath -via its webjar (`org.webjars:hal-browser`), or via the `spring-data-hal-browser` then +via its webjar (`org.webjars:hal-browser`), or via the `spring-data-rest-hal-browser` then the default home page for HTML clients will be the HAL Browser. This is also exposed via an endpoint ("`hal`") so it can be disabled and have its path explicitly configured like the other endpoints.