Prettify swagger description of ApiHealthCheck

cardano-foundation · Nov 13, 2020 · d847bd0 · d847bd0
1 parent a825a55
commit d847bd0
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml
@@ -1802,10 +1802,13 @@ components:
       enum: ["available", "unavailable", "unreachable", "no_smash_configured"]
       description: |
         The status of the SMASH server. Possible values are:
-          - available -> SMASH server is awaiting your requests
-          - unavailable -> SMASH server is running, but currently unavailable, try again in a short time
-          - unreachable -> SMASH server could not be reached or didn't return a health status
-          - no_smash_configured -> SMASH is currently not configured, adjust the Settings first
+
+        status                  | description
+        ---                     | ---
+        `"available"`           | server is awaiting your requests
+        `"unavailable"`         | server is running, but currently unavailable, try again in a short time
+        `"unreachable"`         | server could not be reached or didn't return a health status
+        `"no_smash_configured"` | SMASH is currently not configured, adjust the Settings first
 
     ApiWalletPutPassphraseData: &ApiWalletPutPassphraseData
       type: object