Skip to content

Commit f692b0e

Browse files
committed
Rework title anchors for actuator docs
Closes gh-26615
1 parent 2dbf39c commit f692b0e

27 files changed

+270
-126
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,18 @@ configurations {
1313
documentation
1414
}
1515

16+
repositories {
17+
maven {
18+
url "https://repo.spring.io/release"
19+
mavenContent {
20+
includeGroup "io.spring.asciidoctor"
21+
}
22+
}
23+
}
24+
1625
dependencies {
1726
asciidoctorExtensions("org.springframework.restdocs:spring-restdocs-asciidoctor")
27+
asciidoctorExtensions("io.spring.asciidoctor:spring-asciidoctor-extensions-section-ids")
1828

1929
api(project(":spring-boot-project:spring-boot-actuator"))
2030

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
overview=overview
2+
overview-endpoint-urls=overview.endpoint-urls
3+
overview-timestamps=overview.timestamps
4+
audit-events=audit-events
5+
audit-events-retrieving=audit-events.retrieving
6+
audit-events-retrieving-query-parameters=audit-events.retrieving.query-parameters
7+
audit-events-retrieving-response-structure=audit-events.retrieving.response-structure
8+
beans=beans
9+
beans-retrieving=beans.retrieving
10+
beans-retrieving-response-structure=beans.retrieving.response-structure
11+
caches=caches
12+
caches-all=caches.all
13+
caches-all-response-structure=caches.all.response-structure
14+
caches-named=caches.named
15+
caches-named-query-parameters=caches.named.query-parameters
16+
caches-named-response-structure=caches.named.response-structure
17+
caches-evict-all=caches.evict-all
18+
caches-evict-named=caches.evict-named
19+
caches-evict-named-request-structure=caches.evict-named.request-structure
20+
conditions=conditions
21+
conditions-retrieving=conditions.retrieving
22+
conditions-retrieving-response-structure=conditions.retrieving.response-structure
23+
configprops=configprops
24+
configprops-retrieving=configprops.retrieving
25+
configprops-retrieving-response-structure=configprops.retrieving.response-structure
26+
configprops-retrieving-by-prefix=configprops.retrieving-by-prefix
27+
configprops-retrieving-by-prefix-response-structure=configprops.retrieving-by-prefix.response-structure
28+
env=env
29+
env-entire=env.entire
30+
env-entire-response-structure=env.entire.response-structure
31+
env-single-property=env.single-property
32+
env-single-response-structure=env.single-property.response-structure
33+
flyway=flyway
34+
flyway-retrieving=flyway.retrieving
35+
flyway-retrieving-response-structure=flyway.retrieving.response-structure
36+
health=health
37+
health-retrieving=health.retrieving
38+
health-retrieving-response-structure=health.retrieving.response-structure
39+
health-retrieving-component=health.retrieving-component
40+
health-retrieving-component-response-structure=health.retrieving-component.response-structure
41+
health-retrieving-component-nested=health.retrieving-component-nested
42+
health-retrieving-component-instance-response-structure=health.retrieving-component-nested.response-structure
43+
heapdump=heapdump
44+
heapdump-retrieving=heapdump.retrieving
45+
http-trace=http-trace
46+
http-trace-retrieving=http-trace.retrieving
47+
http-trace-retrieving-response-structure=http-trace.retrieving.response-structure
48+
info=info
49+
info-retrieving=info.retrieving
50+
info-retrieving-response-structure=info.retrieving.response-structure
51+
info-retrieving-response-structure-build=info.retrieving.response-structure.build
52+
info-retrieving-response-structure-git=info.retrieving.response-structure.git
53+
integrationgraph=integrationgraph
54+
integrationgraph-retrieving=integrationgraph.retrieving
55+
integrationgraph-retrieving-response-structure=integrationgraph.retrieving.response-structure
56+
integrationgraph-rebuilding=integrationgraph.rebuilding
57+
liquibase=liquibase
58+
liquibase-retrieving=liquibase.retrieving
59+
liquibase-retrieving-response-structure=liquibase.retrieving.response-structure
60+
log-file=logfile
61+
logfile-retrieving=logfile.retrieving
62+
logfile-retrieving-part=logfile.retrieving-part
63+
loggers=loggers
64+
loggers-all=loggers.all
65+
loggers-all-response-structure=loggers.all.response-structure
66+
loggers-single=loggers.single
67+
loggers-single-response-structure=loggers.single.response-structure
68+
loggers-group=loggers.group
69+
loggers-group-response-structure=loggers.group.response-structure
70+
loggers-setting-level=loggers.setting-level
71+
loggers-setting-level-request-structure=loggers.setting-level.request-structure
72+
loggers-group-setting-level=loggers.group-setting-level
73+
loggers-group-setting-level-request-structure=loggers.group-setting-level.request-structure
74+
loggers-clearing-level=loggers.clearing-level
75+
mappings=mappings
76+
mappings-retrieving=mappings.retrieving
77+
mappings-retrieving-response-structure=mappings.retrieving.response-structure
78+
mappings-retrieving-response-structure-dispatcher-servlets=mappings.retrieving.response-structure-dispatcher-servlets
79+
mappings-retrieving-response-structure-servlets=mappings.retrieving.response-structure-servlets
80+
mappings-retrieving-response-structure-servlet-filters=mappings.retrieving.response-structure-servlet-filters
81+
mappings-retrieving-response-structure-dispatcher-handlers=mappings.retrieving.response-structure-dispatcher-handlers
82+
metrics=metrics
83+
metrics-retrieving-names=metrics.retrieving-names
84+
metrics-retrieving-names-response-structure=metrics.retrieving-names.response-structure
85+
metrics-retrieving-metric=metrics.retrieving-metric
86+
metrics-retrieving-metric-query-parameters=metrics.retrieving-metric.query-parameters
87+
metrics-retrieving-metric-response-structure=metrics.retrieving-metric.response-structure
88+
metrics-drilling-down=metrics.drilling-down
89+
prometheus=prometheus
90+
prometheus-retrieving=prometheus.retrieving
91+
prometheus-retrieving-query-parameters=prometheus.retrieving.query-parameters
92+
prometheus-retrieving-names=prometheus.retrieving-names
93+
quartz=quartz
94+
quartz-report=quartz.report
95+
quartz-report-response-structure=quartz.report.response-structure
96+
quartz-job-groups=quartz.job-groups
97+
quartz-job-groups-response-structure=quartz.job-groups.response-structure
98+
quartz-trigger-groups=quartz.trigger-groups
99+
quartz-trigger-groups-response-structure=quartz.trigger-groups.response-structure
100+
quartz-job-group=quartz.job-group
101+
quartz-job-group-response-structure=quartz.job-group.response-structure
102+
quartz-trigger-group=quartz.trigger-group
103+
quartz-trigger-group-response-structure=quartz.trigger-group.response-structure
104+
quartz-job=quartz.job
105+
quartz-job-response-structure=quartz.job.response-structure
106+
quartz-trigger=quartz.trigger
107+
quartz-trigger-common-response-structure=quartz.trigger.common-response-structure
108+
quartz-trigger-cron-response-structure=quartz.trigger.cron-response-structure
109+
quartz-trigger-simple-response-structure=quartz.trigger.simple-response-structure
110+
quartz-trigger-daily-time-interval-response-structure=quartz.trigger.daily-time-interval-response-structure
111+
quartz-trigger-calendar-interval-response-structure=quartz.trigger.calendar-interval-response-structure
112+
quartz-trigger-custom-response-structure=quartz.trigger.custom-response-structure
113+
scheduled-tasks=scheduled-tasks
114+
scheduled-tasks-retrieving=scheduled-tasks.retrieving
115+
scheduled-tasks-retrieving-response-structure=scheduled-tasks.retrieving.response-structure
116+
sessions=sessions
117+
sessions-retrieving=sessions.retrieving
118+
sessions-retrieving-query-parameters=sessions.retrieving.query-parameters
119+
sessions-retrieving-response-structure=sessions.retrieving.response-structure
120+
sessions-retrieving-id=sessions.retrieving-id
121+
sessions-retrieving-id-response-structure=sessions.retrieving-id.response-structure
122+
sessions-deleting=sessions.deleting
123+
shutdown=shutdown
124+
shutdown-shutting-down=shutdown.shutting-down
125+
shutdown-shutting-down-response-structure=shutdown.shutting-down.response-structure
126+
startup=startup
127+
startup-retrieving=startup.retrieving
128+
startup-retrieving-snapshot=startup.retrieving.snapshot
129+
startup-retrieving-drain=startup.retrieving.drain
130+
startup-retrieving-response-structure=startup.retrieving.response-structure
131+
threaddump=threaddump
132+
threaddump-retrieving-json=threaddump.retrieving-json
133+
threaddump-retrieving-json-response-structure=threaddump.retrieving-json.response-structure
134+
threaddump-retrieving-text=threaddump.retrieving-text

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/auditevents.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `auditevents` endpoint provides information about the application's audit ev
44

55

66

7-
[[audit-events-retrieving]]
7+
[[audit-events.retrieving]]
88
== Retrieving Audit Events
99
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown in the following curl-based example:
1010

@@ -17,7 +17,7 @@ include::{snippets}/auditevents/filtered/http-response.adoc[]
1717

1818

1919

20-
[[audit-events-retrieving-query-parameters]]
20+
[[audit-events.retrieving.query-parameters]]
2121
=== Query Parameters
2222
The endpoint uses query parameters to limit the events that it returns.
2323
The following table shows the supported query parameters:
@@ -27,7 +27,7 @@ include::{snippets}/auditevents/filtered/request-parameters.adoc[]
2727

2828

2929

30-
[[audit-events-retrieving-response-structure]]
30+
[[audit-events.retrieving.response-structure]]
3131
=== Response Structure
3232
The response contains details of all of the audit events that matched the query.
3333
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/beans.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `beans` endpoint provides information about the application's beans.
44

55

66

7-
[[beans-retrieving]]
7+
[[beans.retrieving]]
88
== Retrieving the Beans
99
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/beans/http-response.adoc[]
1616

1717

1818

19-
[[beans-retrieving-response-structure]]
19+
[[beans.retrieving.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's beans.
2222
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/caches.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `caches` endpoint provides access to the application's caches.
44

55

66

7-
[[caches-all]]
7+
[[caches.all]]
88
== Retrieving All Caches
99
To retrieve the application's caches, make a `GET` request to `/actuator/caches`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/caches/all/http-response.adoc[]
1616

1717

1818

19-
[[caches-all-response-structure]]
19+
[[caches.all.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's caches.
2222
The following table describes the structure of the response:
@@ -26,7 +26,7 @@ include::{snippets}/caches/all/response-fields.adoc[]
2626

2727

2828

29-
[[caches-named]]
29+
[[caches.named]]
3030
== Retrieving Caches by Name
3131
To retrieve a cache by name, make a `GET` request to `/actuator/caches/\{name}`, as shown in the following curl-based example:
3232

@@ -39,7 +39,7 @@ include::{snippets}/caches/named/http-response.adoc[]
3939

4040

4141

42-
[[caches-named-query-parameters]]
42+
[[caches.named.query-parameters]]
4343
=== Query Parameters
4444
If the requested name is specific enough to identify a single cache, no extra parameter is required.
4545
Otherwise, the `cacheManager` must be specified.
@@ -50,7 +50,7 @@ include::{snippets}/caches/named/request-parameters.adoc[]
5050

5151

5252

53-
[[caches-named-response-structure]]
53+
[[caches.named.response-structure]]
5454
=== Response Structure
5555
The response contains details of the requested cache.
5656
The following table describes the structure of the response:
@@ -60,15 +60,15 @@ include::{snippets}/caches/named/response-fields.adoc[]
6060

6161

6262

63-
[[caches-evict-all]]
63+
[[caches.evict-all]]
6464
== Evict All Caches
6565
To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in the following curl-based example:
6666

6767
include::{snippets}/caches/evict-all/curl-request.adoc[]
6868

6969

7070

71-
[[caches-evict-named]]
71+
[[caches.evict-named]]
7272
== Evict a Cache by Name
7373
To evict a particular cache, make a `DELETE` request to `/actuator/caches/\{name}` as shown in the following curl-based example:
7474

@@ -78,7 +78,7 @@ NOTE: As there are two caches named `countries`, the `cacheManager` has to be pr
7878

7979

8080

81-
[[caches-evict-named-request-structure]]
81+
[[caches.evict-named.request-structure]]
8282
=== Request Structure
8383
If the requested name is specific enough to identify a single cache, no extra parameter is required.
8484
Otherwise, the `cacheManager` must be specified.

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/conditions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `conditions` endpoint provides information about the evaluation of condition
44

55

66

7-
[[conditions-retrieving]]
7+
[[conditions.retrieving]]
88
== Retrieving the Report
99
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/conditions/http-response.adoc[]
1616

1717

1818

19-
[[conditions-retrieving-response-structure]]
19+
[[conditions.retrieving.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's condition evaluation.
2222
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/configprops.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `configprops` endpoint provides information about the application's `@Config
44

55

66

7-
[[configprops-retrieving]]
7+
[[configprops.retrieving]]
88
== Retrieving All @ConfigurationProperties Beans
99
To retrieve all of the `@ConfigurationProperties` beans, make a `GET` request to `/actuator/configprops`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/configprops/all/http-response.adoc[]
1616

1717

1818

19-
[[configprops-retrieving-response-structure]]
19+
[[configprops.retrieving.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's `@ConfigurationProperties` beans.
2222
The following table describes the structure of the response:
@@ -26,7 +26,7 @@ include::{snippets}/configprops/all/response-fields.adoc[]
2626

2727

2828

29-
[[configprops-retrieving-by-prefix]]
29+
[[configprops.retrieving-by-prefix]]
3030
== Retrieving @ConfigurationProperties Beans By Prefix
3131
To retrieve the `@ConfigurationProperties` beans mapped under a certain prefix, make a `GET` request to `/actuator/configprops/\{prefix}`, as shown in the following curl-based example:
3232

@@ -40,7 +40,7 @@ NOTE: The `\{prefix}` does not need to be exact, a more general prefix will retu
4040

4141

4242

43-
[[configprops-retrieving-by-prefix-response-structure]]
43+
[[configprops.retrieving-by-prefix.response-structure]]
4444
=== Response Structure
4545
The response contains details of the application's `@ConfigurationProperties` beans.
4646
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/env.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `env` endpoint provides information about the application's `Environment`.
44

55

66

7-
[[env-entire]]
7+
[[env.entire]]
88
== Retrieving the Entire Environment
99
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/env/all/http-response.adoc[]
1616

1717

1818

19-
[[env-entire-response-structure]]
19+
[[env.entire.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's `Environment`.
2222
The following table describes the structure of the response:
@@ -26,7 +26,7 @@ include::{snippets}/env/all/response-fields.adoc[]
2626

2727

2828

29-
[[env-single-property]]
29+
[[env.single-property]]
3030
== Retrieving a Single Property
3131
To retrieve a single property, make a `GET` request to `/actuator/env/{property.name}`, as shown in the following curl-based example:
3232

@@ -39,7 +39,7 @@ include::{snippets}/env/single/http-response.adoc[]
3939

4040

4141

42-
[[env-single-response-structure]]
42+
[[env.single-property.response-structure]]
4343
=== Response Structure
4444
The response contains details of the requested property.
4545
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/flyway.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `flyway` endpoint provides information about database migrations performed b
44

55

66

7-
[[flyway-retrieving]]
7+
[[flyway.retrieving]]
88
== Retrieving the Migrations
99
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the following curl-based example:
1010

@@ -16,7 +16,7 @@ include::{snippets}/flyway/http-response.adoc[]
1616

1717

1818

19-
[[flyway-retrieving-response-structure]]
19+
[[flyway.retrieving.response-structure]]
2020
=== Response Structure
2121
The response contains details of the application's Flyway migrations.
2222
The following table describes the structure of the response:

0 commit comments

Comments
 (0)