Island: Fix docstrings in IpAddresses resource

This commit is contained in:
Shreya Malviya 2022-08-04 12:52:25 +05:30
parent e2702ffacb
commit 6b89f38f87
1 changed files with 6 additions and 2 deletions

View File

@ -5,6 +5,10 @@ from monkey_island.cc.resources.request_authentication import jwt_required
class IpAddresses(AbstractResource): class IpAddresses(AbstractResource):
"""
Endpoint for the Monkey Island's local IP addresses
"""
urls = ["/api/island/ip-addresses"] urls = ["/api/island/ip-addresses"]
def __init__(self, local_ip_addresses: Sequence[str]): def __init__(self, local_ip_addresses: Sequence[str]):
@ -13,9 +17,9 @@ class IpAddresses(AbstractResource):
@jwt_required @jwt_required
def get(self) -> Sequence[str]: 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 return self._local_ips