From 2f5a655d8794c92392b7bb4e0bcb6e1e5bbcacf1 Mon Sep 17 00:00:00 2001 From: Andy Applebaum Date: Mon, 20 Dec 2021 14:15:01 -0500 Subject: [PATCH] Update health_api.py Added description tag to response_schema --- app/api/v2/handlers/health_api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/api/v2/handlers/health_api.py b/app/api/v2/handlers/health_api.py index f6673757e..c15c2635e 100644 --- a/app/api/v2/handlers/health_api.py +++ b/app/api/v2/handlers/health_api.py @@ -21,7 +21,7 @@ def add_routes(self, app: web.Application): @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) + @aiohttp_apispec.response_schema(CalderaInfoSchema, 200, description='Includes all loaded plugins and system components.') async def get_health_info(self, request): loaded_plugins_sorted = sorted(self._app_svc.get_loaded_plugins(), key=operator.attrgetter('name'))