From 8b5b0bf2cef9f8c341eebf819b52ee5cc1aa9b21 Mon Sep 17 00:00:00 2001 From: "art.dambrine" <2318827-art.dambrine@users.noreply.gitlab.com> Date: Thu, 25 Nov 2021 19:44:55 +0100 Subject: [PATCH] asciidoc documentation v0.5 --- docs.html | 54 +++++++++++++++++++++++++++++++++++++++++++- docs/partnerapi.adoc | 35 ++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 1 deletion(-) diff --git a/docs.html b/docs.html index b9fd738..9bb1703 100644 --- a/docs.html +++ b/docs.html @@ -457,6 +457,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Accessing the partner POST endpoint
  • Accessing the partner PUT endpoint
  • Accessing the partner DELETE endpoint
    • +
  • Accessing the health check endpoint
  • Useful commands @@ -1148,6 +1149,57 @@ Host: localhost:8080 +
    +

    Accessing the health check endpoint

    +
    +
    +
    $ curl --location --request GET 'http://localhost:8080/health'
    +
    +
    +
    +

    Response

    +
    +
    +
    +
    {
+    "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 +
    +
    +
    @@ -1197,7 +1249,7 @@ Path of the output is build/libs/api-spring-gradle-b2boost-0.0.1-SNAPSHOT.
    diff --git a/docs/partnerapi.adoc b/docs/partnerapi.adoc index 2fca860..2ceb5f3 100644 --- a/docs/partnerapi.adoc +++ b/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_