Merge pull request #2411 from mitre/bernsteinj-patch-1

Update health_api.py
mitre · Dec 20, 2021 · 7e323ea · 7e323ea
2 parents 970492a + 4fd2eb5
commit 7e323ea
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/app/api/v2/handlers/health_api.py b/app/api/v2/handlers/health_api.py
@@ -18,7 +18,9 @@ def add_routes(self, app: web.Application):
         router = app.router
         router.add_get('/health', security.authentication_exempt(self.get_health_info))
 
-    @aiohttp_apispec.docs(tags=["health"])
+    @aiohttp_apispec.docs(tags=['health'],
+                          summary='Health endpoints returns the status of CALDERA',
+                          description='Returns the status of CALDERA and additional details including versions of system components')
     @aiohttp_apispec.response_schema(CalderaInfoSchema, 200)
     async def get_health_info(self, request):
         loaded_plugins_sorted = sorted(self._app_svc.get_loaded_plugins(), key=operator.attrgetter('name'))