Skip to content
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

VIRTS-3151 Agents HEAD/GET/POST documentation #2398

Merged
merged 7 commits into from
Dec 22, 2021
Merged

VIRTS-3151 Agents HEAD/GET/POST documentation #2398

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
63832fe
Agent Documentation
yee-jonathan Dec 14, 2021
44b8e6a
Fixed spacing
yee-jonathan Dec 14, 2021
c18c608
Fixed indent to match parenthesis
yee-jonathan Dec 16, 2021
21dac84
Fixed wording in regard to retrieving agents
yee-jonathan Dec 16, 2021
ffe8da7
Merge branch 'master' into VIRTS---3151-Agents-HEAD/GET/POST-Document…
ArtificialErmine Dec 21, 2021
72ce015
Merge branch 'master' into VIRTS---3151-Agents-HEAD/GET/POST-Document…
ArtificialErmine Dec 22, 2021
636897f
Merge branch 'master' into VIRTS---3151-Agents-HEAD/GET/POST-Document…
ArtificialErmine Dec 22, 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
14 changes: 10 additions & 4 deletions app/api/v2/handlers/agent_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ def add_routes(self, app: web.Application):
router.add_get('/deploy_commands', self.get_deploy_commands)
router.add_get('/deploy_commands/{ability_id}', self.get_deploy_commands_for_ability)

@aiohttp_apispec.docs(tags=['agents'])
@aiohttp_apispec.docs(tags=['agents'],
summary="Retrieve all agents",
description="Retrieve all agents by criteria. Use fields from the "
"'AgentSchema' in the request body to filter the retrieved agents.")
@aiohttp_apispec.querystring_schema(BaseGetAllQuerySchema)
@aiohttp_apispec.response_schema(AgentSchema(many=True, partial=True))
@aiohttp_apispec.response_schema(AgentSchema(many=True, partial=True),
description="Returns a list of all agents in 'AgentSchema' format.")
async def get_agents(self, request: web.Request):
agents = await self.get_all_objects(request)
return web.json_response(agents)
Expand All @@ -40,9 +44,11 @@ async def get_agent_by_id(self, request: web.Request):
agent = await self.get_object(request)
return web.json_response(agent)

@aiohttp_apispec.docs(tags=['agents'])
@aiohttp_apispec.docs(tags=['agents'],
summary="Create a new agent",
description="Creates a new agent using the format from 'AgentSchema'.")
@aiohttp_apispec.request_schema(AgentSchema)
@aiohttp_apispec.response_schema(AgentSchema)
@aiohttp_apispec.response_schema(AgentSchema, description="Returns a single agent in 'AgentSchema' format")
async def create_agent(self, request: web.Request):
agent = await self.create_object(request)
return web.json_response(agent.display)
Expand Down