Merge pull request #2353 from mitre/bleepbop/VIRTS-3047/update-config…

…-api-docs [VIRTS-3047] Update Config api docs
mitre · Nov 9, 2021 · 7cb868d · 7cb868d
2 parents f81bcc6 + a6bb4d7
commit 7cb868d
Showing 1 changed file with 18 additions and 4 deletions.
diff --git a/app/api/v2/handlers/config_api.py b/app/api/v2/handlers/config_api.py
@@ -18,7 +18,15 @@ def add_routes(self, app: web.Application):
         router.add_patch('/config/main', self.update_main_config)
         router.add_patch('/config/agents', self.update_agents_config)
 
-    @aiohttp_apispec.docs(tags=['config'])
+    @aiohttp_apispec.docs(tags=['config'], summary='Retrieve Config',
+                          parameters=[{
+                              'in': 'path',
+                              'name': 'name',
+                              'schema': {'type': 'string'},
+                              'required': 'true',
+                              'description': 'Name of the configuration file to be retrieved.'
+                          }],
+                          description='Retrieves configuration by name, as specified by {name} in the request url.')
     async def get_config_with_name(self, request):
         config_name = request.match_info['name']
 
@@ -28,9 +36,13 @@ async def get_config_with_name(self, request):
             raise JsonHttpNotFound(f'Config not found: {config_name}')
         return web.json_response(config)
 
-    @aiohttp_apispec.docs(tags=['config'])
+    @aiohttp_apispec.docs(tags=['config'], summary='Update Agent Config',
+                          description='Use fields from the AgentConfigUpdateSchema in the request body to '
+                                      'update the Agent Configuration file.')
     @aiohttp_apispec.request_schema(AgentConfigUpdateSchema)
-    @aiohttp_apispec.response_schema(AgentConfigUpdateSchema)
+    @aiohttp_apispec.response_schema(AgentConfigUpdateSchema,
+                                     description='The response consists of data from the Agent configuration file '
+                                                 'dumped in the AgentConfigUpdateSchema format.')
     async def update_agents_config(self, request):
         schema = AgentConfigUpdateSchema()
         data = await self.parse_json_body(request, schema)
@@ -39,7 +51,9 @@ async def update_agents_config(self, request):
         agents_config = self._api_manager.get_filtered_config('agents')
         return web.json_response(schema.dump(agents_config))
 
-    @aiohttp_apispec.docs(tags=['config'])
+    @aiohttp_apispec.docs(tags=['config'], summary='Update Main Config',
+                          description='Use fields from the ConfigUpdateSchema in the request body to '
+                                      'update the main configuration file.')
     @aiohttp_apispec.request_schema(ConfigUpdateSchema)
     async def update_main_config(self, request):
         data = await self.parse_json_body(