Skip to content

Commit a6bb4d7

Browse files
committed
add description for endpoint response
1 parent cf28ab0 commit a6bb4d7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

app/api/v2/handlers/config_api.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ async def get_config_with_name(self, request):
4040
description='Use fields from the AgentConfigUpdateSchema in the request body to '
4141
'update the Agent Configuration file.')
4242
@aiohttp_apispec.request_schema(AgentConfigUpdateSchema)
43-
@aiohttp_apispec.response_schema(AgentConfigUpdateSchema)
43+
@aiohttp_apispec.response_schema(AgentConfigUpdateSchema,
44+
description='The response consists of data from the Agent configuration file '
45+
'dumped in the AgentConfigUpdateSchema format.')
4446
async def update_agents_config(self, request):
4547
schema = AgentConfigUpdateSchema()
4648
data = await self.parse_json_body(request, schema)

0 commit comments

Comments
 (0)