Skip to content

[VIRTS-3047] Update Config api docs #2353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 9, 2021
Merged

[VIRTS-3047] Update Config api docs #2353

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80c27d8
update config docs w/ summary, description
bleepbop Nov 8, 2021
cf28ab0
add parameter description to swagger
bleepbop Nov 9, 2021
a6bb4d7
add description for endpoint response
bleepbop Nov 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions app/api/v2/handlers/config_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']

Expand All @@ -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)
Expand All @@ -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(
Expand Down