Add SSL response structure to actuator info endpoint documentation

Signed-off-by: Shekhar Aggarwal <[email protected]>

Author: shekharAggarwal

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/info.adoc

@@ -76,3 +76,23 @@ The following table describes the structure of the `java` section of the respons
 
 [cols="2,1,3"]
 include::partial$rest/actuator/info/response-fields-beneath-java.adoc[]
+
+
+
+[[info.retrieving.response-structure.ssl]]
+==== SSL Response Structure
+
+The following table describes the structure of the `ssl` section of the response:
+
+[cols="2,1,3"]
+include::partial$rest/actuator/info/response-fields-beneath-ssl.adoc[]
+
+
+
+[[info.retrieving.response-structure.ssl]]
+==== SSL Response Structure
+
+The following table describes the structure of the `ssl` section of the response:
+
+[cols="2,1,3"]
+include::partial$rest/actuator/info/response-fields-beneath-ssl.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/info/InfoEndpointDocumentationTests.java

@@ -30,8 +30,10 @@
 import org.springframework.boot.actuate.info.JavaInfoContributor;
 import org.springframework.boot.actuate.info.OsInfoContributor;
 import org.springframework.boot.actuate.info.ProcessInfoContributor;
+import org.springframework.boot.actuate.info.SslInfoContributor;
 import org.springframework.boot.info.BuildProperties;
 import org.springframework.boot.info.GitProperties;
+import org.springframework.boot.info.SslInfo;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
@@ -55,7 +57,7 @@ class InfoEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 	void info() {
 		assertThat(this.mvc.get().uri("/actuator/info")).hasStatusOk()
 			.apply(MockMvcRestDocumentation.document("info", gitInfo(), buildInfo(), osInfo(), processInfo(),
-					javaInfo()));
+					javaInfo(), sslInfo()));
 	}
 
 	private ResponseFieldsSnippet gitInfo() {
@@ -142,6 +144,31 @@ private ResponseFieldsSnippet javaInfo() {
 					.optional());
 	}
 
+	private ResponseFieldsSnippet sslInfo() {
+		return responseFields(beneathPath("ssl"),
+				fieldWithPath("enabled").description("Whether SSL is enabled.").type(JsonFieldType.BOOLEAN),
+				fieldWithPath("protocol").description("Protocol being used for SSL communication, if available.")
+					.type(JsonFieldType.STRING)
+					.optional(),
+				fieldWithPath("ciphers").description("Ciphers used for SSL connections, if available.")
+					.type(JsonFieldType.ARRAY)
+					.optional(),
+				fieldWithPath("trustStore").description("Trust store information.").optional(),
+				fieldWithPath("trustStore.provider").description("Provider of the trust store, if available.")
+					.type(JsonFieldType.STRING)
+					.optional(),
+				fieldWithPath("trustStore.type").description("Type of the trust store, if available.")
+					.type(JsonFieldType.STRING)
+					.optional(),
+				fieldWithPath("keyStore").description("Key store information.").optional(),
+				fieldWithPath("keyStore.provider").description("Provider of the key store, if available.")
+					.type(JsonFieldType.STRING)
+					.optional(),
+				fieldWithPath("keyStore.type").description("Type of the key store, if available.")
+					.type(JsonFieldType.STRING)
+					.optional());
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class TestConfiguration {
 
@@ -186,6 +213,17 @@ JavaInfoContributor javaInfoContributor() {
 			return new JavaInfoContributor();
 		}
 
+		@Bean
+		SslInfo sslInfo() {
+			// Create a mock SslInfo that will provide the SSL information
+			return new SslInfo(null, null);
+		}
+
+		@Bean
+		SslInfoContributor sslInfoContributor(SslInfo sslInfo) {
+			return new SslInfoContributor(sslInfo);
+		}
+
 	}
 
 }