Use link names instead of paths to index docs
Fixes gh-3570
This commit is contained in:
parent
9b84465edc
commit
38d80bb8c0
|
@ -1,4 +1,4 @@
|
||||||
=== /autoconfig
|
=== Link: autoconfig
|
||||||
This endpoint is a report on the Spring Boot auto-configuration process that happened when
|
This endpoint is a report on the Spring Boot auto-configuration process that happened when
|
||||||
your application started up. It lists all the `@Conditional` annotations that were
|
your application started up. It lists all the `@Conditional` annotations that were
|
||||||
evaluated as the context started and in each case it gives an indication of if (and why)
|
evaluated as the context started and in each case it gives an indication of if (and why)
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /beans
|
=== Link: beans
|
||||||
This endpoint is a report on the Spring Boot `ApplicationContext`. It lists the beans in
|
This endpoint is a report on the Spring Boot `ApplicationContext`. It lists the beans in
|
||||||
the context and their dependencies, detailing the names and concrete classes of each bean.
|
the context and their dependencies, detailing the names and concrete classes of each bean.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /configprops
|
=== Link: configprops
|
||||||
This endpoint is a report on the Spring Boot `@ConfigurationProperties` beans. Beans with
|
This endpoint is a report on the Spring Boot `@ConfigurationProperties` beans. Beans with
|
||||||
this annotation are bound to the `Environment` on startup, so they reflect the
|
this annotation are bound to the `Environment` on startup, so they reflect the
|
||||||
externalised configuration of the application. Beans are listed by name. A bean that is
|
externalised configuration of the application. Beans are listed by name. A bean that is
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /dump
|
=== Link: dump
|
||||||
This endpoint is a thread dump: the result is a list of threads each with their name,
|
This endpoint is a thread dump: the result is a list of threads each with their name,
|
||||||
monitor state and stack. It is the same information as you would get from `kill -3` of a
|
monitor state and stack. It is the same information as you would get from `kill -3` of a
|
||||||
running Java process. Can be very useful for detecting issues at runtime, especially
|
running Java process. Can be very useful for detecting issues at runtime, especially
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /env
|
=== Link: env
|
||||||
This endpoint is a dump of the Spring `Environment`. It lists the active profiles and all
|
This endpoint is a dump of the Spring `Environment`. It lists the active profiles and all
|
||||||
the `PropertySources` in the `Environment` (the ones that are listed first take precedence
|
the `PropertySources` in the `Environment` (the ones that are listed first take precedence
|
||||||
when binding to `@ConfigurationProperties` or `@Value`). Normally you will see the Java
|
when binding to `@ConfigurationProperties` or `@Value`). Normally you will see the Java
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /health
|
=== Link: health
|
||||||
This endpoint is an indication of the health of the application. It has an overall status
|
This endpoint is an indication of the health of the application. It has an overall status
|
||||||
("UP", "DOWN" etc.), which is the only thing you see unless either you are authenticated
|
("UP", "DOWN" etc.), which is the only thing you see unless either you are authenticated
|
||||||
or the endpoint is marked as `sensitive=false` (`endpoints.health.sensitive=false`).
|
or the endpoint is marked as `sensitive=false` (`endpoints.health.sensitive=false`).
|
||||||
|
|
|
@ -17,7 +17,7 @@ include::{generated}/endpoints.adoc[]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
=== /logfile
|
=== Link: logfile
|
||||||
This endpoint (if available) contains the plain text logfile configured by the user
|
This endpoint (if available) contains the plain text logfile configured by the user
|
||||||
using `logging.file` or `logging.path` (by default logs are only emitted on stdout
|
using `logging.file` or `logging.path` (by default logs are only emitted on stdout
|
||||||
so one of these properties has to be set for this endpoint to be active).
|
so one of these properties has to be set for this endpoint to be active).
|
||||||
|
@ -33,7 +33,7 @@ include::{generated}/logfile/http-response.adoc[]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
=== /docs
|
=== Link: docs
|
||||||
This endpoint (if available) contains HTML documemtation for the other endpoints. Its path
|
This endpoint (if available) contains HTML documemtation for the other endpoints. Its path
|
||||||
can be "/docs" (if there is an existing home page) or "/" (otherwise, including if the
|
can be "/docs" (if there is an existing home page) or "/" (otherwise, including if the
|
||||||
HAL browser is not active).
|
HAL browser is not active).
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /info
|
=== Link: info
|
||||||
This endpoint is empty and marked as `sensitive=false` by default (so it is
|
This endpoint is empty and marked as `sensitive=false` by default (so it is
|
||||||
unauthenticated by default if Spring Security is in use). It reflects the content of the
|
unauthenticated by default if Spring Security is in use). It reflects the content of the
|
||||||
`info.*` properties in the `Environment`, as well as the properties in `git.properties`
|
`info.*` properties in the `Environment`, as well as the properties in `git.properties`
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /mappings
|
=== Link: mappings
|
||||||
This endpoint lists the Spring MVC request mappings, so users can see the handlers
|
This endpoint lists the Spring MVC request mappings, so users can see the handlers
|
||||||
registered for requests by path, method, media type, etc.
|
registered for requests by path, method, media type, etc.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /metrics
|
=== Link: metrics
|
||||||
This endpoint lists the public metrics exposed by the application. By default this
|
This endpoint lists the public metrics exposed by the application. By default this
|
||||||
includes all the counters in the `CounterService` and all the gauges in the
|
includes all the counters in the `CounterService` and all the gauges in the
|
||||||
`GaugeService`, plus a few JVM metrics about memory and uptime. Users can register
|
`GaugeService`, plus a few JVM metrics about memory and uptime. Users can register
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
=== /trace
|
=== Link: trace
|
||||||
This endpoint lists contents of the `TraceRepository` (which users can override by
|
This endpoint lists contents of the `TraceRepository` (which users can override by
|
||||||
providing a bean of that type, or by injecting that bean and adding stuff to it). By
|
providing a bean of that type, or by injecting that bean and adding stuff to it). By
|
||||||
default it is the last 100 HTTP requests, including all headers in the request and
|
default it is the last 100 HTTP requests, including all headers in the request and
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
if (endpoint.custom) { %>
|
if (endpoint.custom) { %>
|
||||||
include::{docs}/${endpoint.custom}[]
|
include::{docs}/${endpoint.custom}[]
|
||||||
<% } else { %>
|
<% } else { %>
|
||||||
=== ${endpoint.title}
|
=== Link: ${endpoint.title}
|
||||||
|
|
||||||
Example curl request:
|
Example curl request:
|
||||||
include::{generated}${endpoint.path}/curl-request.adoc[]
|
include::{generated}${endpoint.path}/curl-request.adoc[]
|
||||||
|
|
Loading…
Reference in New Issue