Skip to content

Commit 7b1e10e

Browse files
committed
Use one sentence per line in Actuator and Gradle plugin doc source
Closes spring-projectsgh-18185
1 parent 795c2f2 commit 7b1e10e

30 files changed

+274
-427
lines changed

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

+7-9
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ The `auditevents` endpoint provides information about the application's audit ev
88
[[audit-events-retrieving]]
99
== Retrieving Audit Events
1010

11-
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown
12-
in the following curl-based example:
11+
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown in the following curl-based example:
1312

1413
include::{snippets}auditevents/filtered/curl-request.adoc[]
1514

16-
The preceding example retrieves `logout` events for the principal, `alice`, that occurred
17-
after 09:37 on 7 November 2017 in the UTC timezone. The resulting response is similar to
18-
the following:
15+
The preceding example retrieves `logout` events for the principal, `alice`, that occurred after 09:37 on 7 November 2017 in the UTC timezone.
16+
The resulting response is similar to the following:
1917

2018
include::{snippets}auditevents/filtered/http-response.adoc[]
2119

@@ -24,8 +22,8 @@ include::{snippets}auditevents/filtered/http-response.adoc[]
2422
[[audit-events-retrieving-query-parameters]]
2523
=== Query Parameters
2624

27-
The endpoint uses query parameters to limit the events that it returns. The following
28-
table shows the supported query parameters:
25+
The endpoint uses query parameters to limit the events that it returns.
26+
The following table shows the supported query parameters:
2927

3028
[cols="2,4"]
3129
include::{snippets}auditevents/filtered/request-parameters.adoc[]
@@ -35,8 +33,8 @@ include::{snippets}auditevents/filtered/request-parameters.adoc[]
3533
[[audit-events-retrieving-response-structure]]
3634
=== Response Structure
3735

38-
The response contains details of all of the audit events that matched the query. The
39-
following table describes the structure of the response:
36+
The response contains details of all of the audit events that matched the query.
37+
The following table describes the structure of the response:
4038

4139
[cols="2,1,3"]
4240
include::{snippets}auditevents/all/response-fields.adoc[]

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ The `beans` endpoint provides information about the application's beans.
88
[[beans-retrieving]]
99
== Retrieving the Beans
1010

11-
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the
12-
following curl-based example:
11+
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
1312

1413
include::{snippets}beans/curl-request.adoc[]
1514

@@ -22,8 +21,8 @@ include::{snippets}beans/http-response.adoc[]
2221
[[beans-retrieving-response-structure]]
2322
=== Response Structure
2423

25-
The response contains details of the application's beans. The following table describes
26-
the structure of the response:
24+
The response contains details of the application's beans.
25+
The following table describes the structure of the response:
2726

2827
[cols="2,1,3"]
2928
include::{snippets}beans/response-fields.adoc[]

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

+17-22
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ The `caches` endpoint provides access to the application's caches.
77

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

1312
include::{snippets}caches/all/curl-request.adoc[]
1413

@@ -20,8 +19,8 @@ include::{snippets}caches/all/http-response.adoc[]
2019

2120
[[caches-all-response-structure]]
2221
=== Response Structure
23-
The response contains details of the application's caches. The following table describes
24-
the structure of the response:
22+
The response contains details of the application's caches.
23+
The following table describes the structure of the response:
2524

2625
[cols="3,1,3"]
2726
include::{snippets}caches/all/response-fields.adoc[]
@@ -30,23 +29,22 @@ include::{snippets}caches/all/response-fields.adoc[]
3029

3130
[[caches-named]]
3231
== Retrieving Caches by Name
33-
To retrieve a cache by name, make a `GET` request to `/actuator/caches/\{name}`,
34-
as shown in the following curl-based example:
32+
To retrieve a cache by name, make a `GET` request to `/actuator/caches/\{name}`, as shown in the following curl-based example:
3533

3634
include::{snippets}caches/named/curl-request.adoc[]
3735

38-
The preceding example retrieves information about the cache named `cities`. The
39-
resulting response is similar to the following:
36+
The preceding example retrieves information about the cache named `cities`.
37+
The resulting response is similar to the following:
4038

4139
include::{snippets}caches/named/http-response.adoc[]
4240

4341

4442

4543
[[caches-named-query-parameters]]
4644
=== Query Parameters
47-
If the requested name is specific enough to identify a single cache, no extra parameter is
48-
required. Otherwise, the `cacheManager` must be specified. The following table shows the
49-
supported query parameters:
45+
If the requested name is specific enough to identify a single cache, no extra parameter is required.
46+
Otherwise, the `cacheManager` must be specified.
47+
The following table shows the supported query parameters:
5048

5149
[cols="2,4"]
5250
include::{snippets}caches/named/request-parameters.adoc[]
@@ -55,8 +53,8 @@ include::{snippets}caches/named/request-parameters.adoc[]
5553

5654
[[caches-named-response-structure]]
5755
=== Response Structure
58-
The response contains details of the requested cache. The following table describes the
59-
structure of the response:
56+
The response contains details of the requested cache.
57+
The following table describes the structure of the response:
6058

6159
[cols="3,1,3"]
6260
include::{snippets}caches/named/response-fields.adoc[]
@@ -65,30 +63,27 @@ include::{snippets}caches/named/response-fields.adoc[]
6563

6664
[[caches-evict-all]]
6765
== Evict All Caches
68-
To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in
69-
the following curl-based example:
66+
To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in the following curl-based example:
7067

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

7370

7471

7572
[[caches-evict-named]]
7673
== Evict a Cache by Name
77-
To evict a particular cache, make a `DELETE` request to `/actuator/caches/\{name}` as shown
78-
in the following curl-based example:
74+
To evict a particular cache, make a `DELETE` request to `/actuator/caches/\{name}` as shown in the following curl-based example:
7975

8076
include::{snippets}caches/evict-named/curl-request.adoc[]
8177

82-
NOTE: As there are two caches named `countries`, the `cacheManager` has to be provided to
83-
specify which `Cache` should be cleared.
78+
NOTE: As there are two caches named `countries`, the `cacheManager` has to be provided to specify which `Cache` should be cleared.
8479

8580

8681

8782
[[caches-evict-named-request-structure]]
8883
=== Request Structure
89-
If the requested name is specific enough to identify a single cache, no extra parameter is
90-
required. Otherwise, the `cacheManager` must be specified. The following table shows the
91-
supported query parameters:
84+
If the requested name is specific enough to identify a single cache, no extra parameter is required.
85+
Otherwise, the `cacheManager` must be specified.
86+
The following table shows the supported query parameters:
9287

9388
[cols="2,4"]
9489
include::{snippets}caches/evict-named/request-parameters.adoc[]
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
[[conditions]]
22
= Conditions Evaluation Report (`conditions`)
33

4-
The `conditions` endpoint provides information about the evaluation of conditions on
5-
configuration and auto-configuration classes.
4+
The `conditions` endpoint provides information about the evaluation of conditions on configuration and auto-configuration classes.
65

76

87

98
[[conditions-retrieving]]
109
== Retrieving the Report
1110

12-
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in
13-
the following curl-based example:
11+
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
1412

1513
include::{snippets}conditions/curl-request.adoc[]
1614

@@ -23,8 +21,8 @@ include::{snippets}conditions/http-response.adoc[]
2321
[[conditions-retrieving-response-structure]]
2422
=== Response Structure
2523

26-
The response contains details of the application's condition evaluation. The following
27-
table describes the structure of the response:
24+
The response contains details of the application's condition evaluation.
25+
The following table describes the structure of the response:
2826

2927
[cols="3,1,3"]
3028
include::{snippets}conditions/response-fields.adoc[]
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
[[configprops]]
22
= Configuration Properties (`configprops`)
33

4-
The `configprops` endpoint provides information about the application's
5-
`@ConfigurationProperties` beans.
4+
The `configprops` endpoint provides information about the application's `@ConfigurationProperties` beans.
65

76

87

98
[[configprops-retrieving]]
109
== Retrieving the `@ConfigurationProperties` Bean
1110

12-
To retrieve the `@ConfigurationProperties` beans, make a `GET` request to
13-
`/actuator/configprops`, as shown in the following curl-based example:
11+
To retrieve the `@ConfigurationProperties` beans, make a `GET` request to `/actuator/configprops`, as shown in the following curl-based example:
1412

1513
include::{snippets}configprops/curl-request.adoc[]
1614

@@ -23,8 +21,8 @@ include::{snippets}configprops/http-response.adoc[]
2321
[[configprops-retrieving-response-structure]]
2422
=== Response Structure
2523

26-
The response contains details of the application's `@ConfigurationProperties` beans. The
27-
following table describes the structure of the response:
24+
The response contains details of the application's `@ConfigurationProperties` beans.
25+
The following table describes the structure of the response:
2826

2927
[cols="2,1,3"]
3028
include::{snippets}configprops/response-fields.adoc[]

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

+8-10
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ The `env` endpoint provides information about the application's `Environment`.
88
[[env-entire]]
99
== Retrieving the Entire Environment
1010

11-
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in
12-
the following curl-based example:
11+
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in the following curl-based example:
1312

1413
include::{snippets}env/all/curl-request.adoc[]
1514

@@ -22,8 +21,8 @@ include::{snippets}env/all/http-response.adoc[]
2221
[[env-entire-response-structure]]
2322
=== Response Structure
2423

25-
The response contains details of the application's `Environment`. The following table
26-
describes the structure of the response:
24+
The response contains details of the application's `Environment`.
25+
The following table describes the structure of the response:
2726

2827
[cols="3,1,3"]
2928
include::{snippets}env/all/response-fields.adoc[]
@@ -33,13 +32,12 @@ include::{snippets}env/all/response-fields.adoc[]
3332
[[env-single-property]]
3433
== Retrieving a Single Property
3534

36-
To retrieve a single property, make a `GET` request to `/actuator/env/{property.name}`,
37-
as shown in the following curl-based example:
35+
To retrieve a single property, make a `GET` request to `/actuator/env/{property.name}`, as shown in the following curl-based example:
3836

3937
include::{snippets}env/single/curl-request.adoc[]
4038

41-
The preceding example retrieves information about the property named
42-
`com.example.cache.max-size`. The resulting response is similar to the following:
39+
The preceding example retrieves information about the property named `com.example.cache.max-size`.
40+
The resulting response is similar to the following:
4341

4442
include::{snippets}env/single/http-response.adoc[]
4543

@@ -48,8 +46,8 @@ include::{snippets}env/single/http-response.adoc[]
4846
[[env-single-response-structure]]
4947
=== Response Structure
5048

51-
The response contains details of the requested property. The following table describes the
52-
structure of the response:
49+
The response contains details of the requested property.
50+
The following table describes the structure of the response:
5351

5452
[cols="3,1,3"]
5553
include::{snippets}env/single/response-fields.adoc[]

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ The `flyway` endpoint provides information about database migrations performed b
88
[[flyway-retrieving]]
99
== Retrieving the Migrations
1010

11-
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the
12-
following curl-based example:
11+
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the following curl-based example:
1312

1413
include::{snippets}flyway/curl-request.adoc[]
1514

@@ -22,8 +21,8 @@ include::{snippets}flyway/http-response.adoc[]
2221
[[flyway-retrieving-response-structure]]
2322
=== Response Structure
2423

25-
The response contains details of the application's Flyway migrations. The following table
26-
describes the structure of the response:
24+
The response contains details of the application's Flyway migrations.
25+
The following table describes the structure of the response:
2726

2827
[cols="2,1,3"]
2928
include::{snippets}flyway/response-fields.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/health.adoc

+7-12
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ The `health` endpoint provides detailed information about the health of the appl
66

77
[[health-retrieving]]
88
== Retrieving the Health of the application
9-
To retrieve the health of the application, make a `GET` request to `/actuator/health`,
10-
as shown in the following curl-based example:
9+
To retrieve the health of the application, make a `GET` request to `/actuator/health`, as shown in the following curl-based example:
1110

1211
include::{snippets}health/curl-request.adoc[]
1312

@@ -19,8 +18,8 @@ include::{snippets}health/http-response.adoc[]
1918

2019
[[health-retrieving-response-structure]]
2120
=== Response Structure
22-
The response contains details of the health of the application. The following table
23-
describes the structure of the response:
21+
The response contains details of the health of the application.
22+
The following table describes the structure of the response:
2423

2524
[cols="2,1,3"]
2625
include::{snippets}health/response-fields.adoc[]
@@ -29,8 +28,7 @@ include::{snippets}health/response-fields.adoc[]
2928

3029
[[health-retrieving-component]]
3130
== Retrieving the Health of a component
32-
To retrieve the health of a particular component of the application, make a `GET` request
33-
to `/actuator/health/\{component}`, as shown in the following curl-based example:
31+
To retrieve the health of a particular component of the application, make a `GET` request to `/actuator/health/\{component}`, as shown in the following curl-based example:
3432

3533
include::{snippets}health/component/curl-request.adoc[]
3634

@@ -52,10 +50,7 @@ include::{snippets}health/component/response-fields.adoc[]
5250

5351
[[health-retrieving-component-instance]]
5452
== Retrieving the Health of a component instance
55-
If a particular component consists of multiple instances (as the `broker` indicator in
56-
the example above), the health of a particular instance of that component can be retrieved
57-
by issuing a `GET` request to `/actuator/health/\{component}/\{instance}`, as shown in the
58-
following curl-based example:
53+
If a particular component consists of multiple instances (as the `broker` indicator in the example above), the health of a particular instance of that component can be retrieved by issuing a `GET` request to `/actuator/health/\{component}/\{instance}`, as shown in the following curl-based example:
5954

6055
include::{snippets}health/instance/curl-request.adoc[]
6156

@@ -67,8 +62,8 @@ include::{snippets}health/instance/http-response.adoc[]
6762

6863
[[health-retrieving-component-instance-response-structure]]
6964
=== Response Structure
70-
The response contains details of the health of an instance of a particular component of
71-
the application. The following table describes the structure of the response:
65+
The response contains details of the health of an instance of a particular component of the application.
66+
The following table describes the structure of the response:
7267

7368
[cols="2,1,3"]
7469
include::{snippets}health/instance/response-fields.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/heapdump.adoc

+5-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ The `heapdump` endpoint provides a heap dump from the application's JVM.
88
[[heapdump-retrieving]]
99
== Retrieving the Heap Dump
1010

11-
To retrieve the heap dump, make a `GET` request to `/actuator/heapdump`. The response
12-
is binary data in https://docs.oracle.com/javase/8/docs/technotes/samples/hprof.html[
13-
HPROF] format and can be large. Typically, you should save the response to disk for
14-
subsequent analysis. When using curl, this can be achieved by using the `-O` option,
15-
as shown in the following example:
11+
To retrieve the heap dump, make a `GET` request to `/actuator/heapdump`.
12+
The response is binary data in https://docs.oracle.com/javase/8/docs/technotes/samples/hprof.html[HPROF] format and can be large.
13+
Typically, you should save the response to disk for subsequent analysis.
14+
When using curl, this can be achieved by using the `-O` option, as shown in the following example:
1615

1716
include::{snippets}heapdump/curl-request.adoc[]
1817

19-
The preceding example results in a file named `heapdump` being written to the current
20-
working directory.
18+
The preceding example results in a file named `heapdump` being written to the current working directory.

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/httptrace.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ The `httptrace` endpoint provides information about HTTP request-response exchan
88
[[http-trace-retrieving]]
99
== Retrieving the Traces
1010

11-
To retrieve the traces, make a `GET` request to `/actuator/httptrace`, as shown in the
12-
following curl-based example:
11+
To retrieve the traces, make a `GET` request to `/actuator/httptrace`, as shown in the following curl-based example:
1312

1413
include::{snippets}httptrace/curl-request.adoc[]
1514

@@ -22,8 +21,8 @@ include::{snippets}httptrace/http-response.adoc[]
2221
[[http-trace-retrieving-response-structure]]
2322
=== Response Structure
2423

25-
The response contains details of the traced HTTP request-response exchanges. The
26-
following table describes the structure of the response:
24+
The response contains details of the traced HTTP request-response exchanges.
25+
The following table describes the structure of the response:
2726

2827
[cols="2,1,3"]
2928
include::{snippets}httptrace/response-fields.adoc[]

0 commit comments

Comments
 (0)