asciidoc documentation v0.5

docs.html

@@ -457,6 +457,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <li><a href="#_accessing_the_partner_post_endpoint">Accessing the partner POST endpoint</a></li>
 <li><a href="#_accessing_the_partner_put_endpoint">Accessing the partner PUT endpoint</a></li>
 <li><a href="#_accessing_the_partner_delete_endpoint">Accessing the partner DELETE endpoint</a></li>
+<li><a href="#_accessing_the_health_check_endpoint">Accessing the health check endpoint</a></li>
 </ul>
 </li>
 <li><a href="#_useful_commands">Useful commands</a>
@@ -1148,6 +1149,57 @@ Host: localhost:8080</code></pre>
 </div>
 </div>
 </div>
+<div class="sect2">
+<h3 id="_accessing_the_health_check_endpoint">Accessing the health check endpoint</h3>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl --location --request GET 'http://localhost:8080/health'</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Response</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code data-lang="json" class="language-json hljs">{
+    "status": "UP",
+    "components": {
+        "db": {
+            "status": "UP",
+            "details": {
+                "database": "H2",
+                "validationQuery": "isValid()"
+            }
+        },
+        "diskSpace": {
+            "status": "UP",
+            "details": {
+                "total": 250438021120,
+                "free": 10172166144,
+                "threshold": 10485760,
+                "exists": true
+            }
+        },
+        "ping": {
+            "status": "UP"
+        }
+    }
+}</code></pre>
+</div>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+For security purpose you can display less by changing <code>management.endpoint.health.show-details=always</code> to <code>never</code> in <code>application.properties</code>
+</td>
+</tr>
+</table>
+</div>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -1197,7 +1249,7 @@ Path of the output is <code>build/libs/api-spring-gradle-b2boost-0.0.1-SNAPSHOT.
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2021-11-25 07:19:41 +0100
+Last updated 2021-11-25 19:41:31 +0100
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

docs/partnerapi.adoc

@@ -291,6 +291,41 @@ Response
 ----
 
 
+=== Accessing the health check endpoint
+[source,bash]
+-----
+$ curl --location --request GET 'http://localhost:8080/health'
+-----
+Response
+[source,json]
+----
+{
+    "status": "UP",
+    "components": {
+        "db": {
+            "status": "UP",
+            "details": {
+                "database": "H2",
+                "validationQuery": "isValid()"
+            }
+        },
+        "diskSpace": {
+            "status": "UP",
+            "details": {
+                "total": 250438021120,
+                "free": 10172166144,
+                "threshold": 10485760,
+                "exists": true
+            }
+        },
+        "ping": {
+            "status": "UP"
+        }
+    }
+}
+----
+NOTE: For security purpose you can display less by changing `management.endpoint.health.show-details=always` to `never` in `application.properties`
+
 == Useful commands
 _Assuming you are using a bash cli_