From 6b89f38f876430863abf315900e2d1200f2e1435 Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Thu, 4 Aug 2022 12:52:25 +0530 Subject: [PATCH] Island: Fix docstrings in IpAddresses resource --- monkey/monkey_island/cc/resources/ip_addresses.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/monkey/monkey_island/cc/resources/ip_addresses.py b/monkey/monkey_island/cc/resources/ip_addresses.py index b64a032f9..85e88b094 100644 --- a/monkey/monkey_island/cc/resources/ip_addresses.py +++ b/monkey/monkey_island/cc/resources/ip_addresses.py @@ -5,6 +5,10 @@ from monkey_island.cc.resources.request_authentication import jwt_required class IpAddresses(AbstractResource): + """ + Endpoint for the Monkey Island's local IP addresses + """ + urls = ["/api/island/ip-addresses"] def __init__(self, local_ip_addresses: Sequence[str]): @@ -13,9 +17,9 @@ class IpAddresses(AbstractResource): @jwt_required def get(self) -> Sequence[str]: """ - Gets the IP addresses of the Island network interfaces + Sends the local IP addresses of the Island - :return: a dictionary with "ip_addresses" key that points to a list of IP's + :return: Local IPs """ return self._local_ips