Skip to content

Commit 2dbf39c

Browse files
committed
Polish asciidoc formatting
1 parent a28072b commit 2dbf39c

36 files changed

+66
-156
lines changed

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[audit-events]]
22
= Audit Events (`auditevents`)
3-
43
The `auditevents` endpoint provides information about the application's audit events.
54

65

76

87
[[audit-events-retrieving]]
98
== Retrieving Audit Events
10-
119
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown in the following curl-based example:
1210

1311
include::{snippets}/auditevents/filtered/curl-request.adoc[]
@@ -21,7 +19,6 @@ include::{snippets}/auditevents/filtered/http-response.adoc[]
2119

2220
[[audit-events-retrieving-query-parameters]]
2321
=== Query Parameters
24-
2522
The endpoint uses query parameters to limit the events that it returns.
2623
The following table shows the supported query parameters:
2724

@@ -32,7 +29,6 @@ include::{snippets}/auditevents/filtered/request-parameters.adoc[]
3229

3330
[[audit-events-retrieving-response-structure]]
3431
=== Response Structure
35-
3632
The response contains details of all of the audit events that matched the query.
3733
The following table describes the structure of the response:
3834

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[beans]]
22
= Beans (`beans`)
3-
43
The `beans` endpoint provides information about the application's beans.
54

65

76

87
[[beans-retrieving]]
98
== Retrieving the Beans
10-
119
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
1210

1311
include::{snippets}/beans/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/beans/http-response.adoc[]
2018

2119
[[beans-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the application's beans.
2522
The following table describes the structure of the response:
2623

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[[caches]]
22
= Caches (`caches`)
3-
43
The `caches` endpoint provides access to the application's caches.
54

65

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[conditions]]
22
= Conditions Evaluation Report (`conditions`)
3-
43
The `conditions` endpoint provides information about the evaluation of conditions on configuration and auto-configuration classes.
54

65

76

87
[[conditions-retrieving]]
98
== Retrieving the Report
10-
119
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
1210

1311
include::{snippets}/conditions/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/conditions/http-response.adoc[]
2018

2119
[[conditions-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the application's condition evaluation.
2522
The following table describes the structure of the response:
2623

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[configprops]]
22
= Configuration Properties (`configprops`)
3-
43
The `configprops` endpoint provides information about the application's `@ConfigurationProperties` beans.
54

65

76

87
[[configprops-retrieving]]
98
== Retrieving All @ConfigurationProperties Beans
10-
119
To retrieve all of the `@ConfigurationProperties` beans, make a `GET` request to `/actuator/configprops`, as shown in the following curl-based example:
1210

1311
include::{snippets}/configprops/all/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/configprops/all/http-response.adoc[]
2018

2119
[[configprops-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the application's `@ConfigurationProperties` beans.
2522
The following table describes the structure of the response:
2623

@@ -31,7 +28,6 @@ include::{snippets}/configprops/all/response-fields.adoc[]
3128

3229
[[configprops-retrieving-by-prefix]]
3330
== Retrieving @ConfigurationProperties Beans By Prefix
34-
3531
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:
3632

3733
include::{snippets}/configprops/prefixed/curl-request.adoc[]
@@ -46,7 +42,6 @@ NOTE: The `\{prefix}` does not need to be exact, a more general prefix will retu
4642

4743
[[configprops-retrieving-by-prefix-response-structure]]
4844
=== Response Structure
49-
5045
The response contains details of the application's `@ConfigurationProperties` beans.
5146
The following table describes the structure of the response:
5247

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[env]]
22
= Environment (`env`)
3-
43
The `env` endpoint provides information about the application's `Environment`.
54

65

76

87
[[env-entire]]
98
== Retrieving the Entire Environment
10-
119
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in the following curl-based example:
1210

1311
include::{snippets}/env/all/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/env/all/http-response.adoc[]
2018

2119
[[env-entire-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the application's `Environment`.
2522
The following table describes the structure of the response:
2623

@@ -31,7 +28,6 @@ include::{snippets}/env/all/response-fields.adoc[]
3128

3229
[[env-single-property]]
3330
== Retrieving a Single Property
34-
3531
To retrieve a single property, make a `GET` request to `/actuator/env/{property.name}`, as shown in the following curl-based example:
3632

3733
include::{snippets}/env/single/curl-request.adoc[]
@@ -45,7 +41,6 @@ include::{snippets}/env/single/http-response.adoc[]
4541

4642
[[env-single-response-structure]]
4743
=== Response Structure
48-
4944
The response contains details of the requested property.
5045
The following table describes the structure of the response:
5146

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[flyway]]
22
= Flyway (`flyway`)
3-
43
The `flyway` endpoint provides information about database migrations performed by Flyway.
54

65

76

87
[[flyway-retrieving]]
98
== Retrieving the Migrations
10-
119
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the following curl-based example:
1210

1311
include::{snippets}/flyway/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/flyway/http-response.adoc[]
2018

2119
[[flyway-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the application's Flyway migrations.
2522
The following table describes the structure of the response:
2623

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[heapdump]]
22
= Heap Dump (`heapdump`)
3-
43
The `heapdump` endpoint provides a heap dump from the application's JVM.
54

65

76

87
[[heapdump-retrieving]]
98
== Retrieving the Heap Dump
10-
119
To retrieve the heap dump, make a `GET` request to `/actuator/heapdump`.
1210
The response is binary data in https://docs.oracle.com/javase/8/docs/technotes/samples/hprof.html[HPROF] format and can be large.
1311
Typically, you should save the response to disk for subsequent analysis.

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[http-trace]]
22
= HTTP Trace (`httptrace`)
3-
43
The `httptrace` endpoint provides information about HTTP request-response exchanges.
54

65

76

87
[[http-trace-retrieving]]
98
== Retrieving the Traces
10-
119
To retrieve the traces, make a `GET` request to `/actuator/httptrace`, as shown in the following curl-based example:
1210

1311
include::{snippets}/httptrace/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/httptrace/http-response.adoc[]
2018

2119
[[http-trace-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains details of the traced HTTP request-response exchanges.
2522
The following table describes the structure of the response:
2623

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[info]]
22
= Info (`info`)
3-
43
The `info` endpoint provides general information about the application.
54

65

76

87
[[info-retrieving]]
98
== Retrieving the Info
10-
119
To retrieve the information about the application, make a `GET` request to `/actuator/info`, as shown in the following curl-based example:
1210

1311
include::{snippets}/info/curl-request.adoc[]
@@ -20,7 +18,6 @@ include::{snippets}/info/http-response.adoc[]
2018

2119
[[info-retrieving-response-structure]]
2220
=== Response Structure
23-
2421
The response contains general information about the application.
2522
Each section of the response is contributed by an `InfoContributor`.
2623
Spring Boot provides `build` and `git` contributions.
@@ -29,7 +26,6 @@ Spring Boot provides `build` and `git` contributions.
2926

3027
[[info-retrieving-response-structure-build]]
3128
==== Build Response Structure
32-
3329
The following table describe the structure of the `build` section of the response:
3430

3531
[cols="2,1,3"]
@@ -39,7 +35,6 @@ include::{snippets}/info/response-fields-beneath-build.adoc[]
3935

4036
[[info-retrieving-response-structure-git]]
4137
==== Git Response Structure
42-
4338
The following table describes the structure of the `git` section of the response:
4439

4540
[cols="2,1,3"]

0 commit comments

Comments
 (0)