Skip to content

Add API documentation for /contacts/{name} #2424

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
bleepbop merged 3 commits into from
Jan 6, 2022
Merged

Add API documentation for /contacts/{name} #2424

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e0bbf8
Add API documentation for /contacts/{name}
damionmounts Jan 3, 2022
c15df99
highlight dict keys returned
damionmounts Jan 6, 2022
a0021bc
Merge branch 'master' into api/v2/contacts
bleepbop Jan 6, 2022
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
15 changes: 14 additions & 1 deletion app/api/v2/handlers/contact_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,20 @@ def add_routes(self, app: web.Application):
router = app.router
router.add_get('/contacts/{name}', self.get_contact_report)

@aiohttp_apispec.docs(tags=['contacts'])
@aiohttp_apispec.docs(tags=['contacts'],
summary='Retrieve a List of Beacons made by Agents to the specified Contact',
description='Returns a list of beacons made by agents to the specified contact. The response'
' is formatted as a list of dictionaries. The dictionaries have the keys `paw`,'
' `instructions`, and `date`. `paw` being the paw of the agent that made the'
' beacon. `instructions` being a list of strings (commands) executed by the'
' agent since its last beacon. `date` being a UTC date/time string.',
parameters=[{
'in': 'path',
'name': 'name',
'schema': {'type': 'string'},
'required': 'true',
'description': 'Name of the contact to get beacons for, e.g. HTTP, TCP, et cetera.'
}])
async def get_contact_report(self, request: web.Request):
contact_name = request.match_info['name']
report = self._api_manager.get_contact_report(contact_name)
Expand Down