MISP
/
PyMISP
mirror of https://github.com/MISP/PyMISP
2
0
Fork 0
Code Issues Releases Wiki Activity

chg: Improve docstring for get_event 

fix #686
pull/700/head
Raphaël Vinot 2021-01-20 13:44:23 +01:00
parent 9561ce362e
commit 644492ace1
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pymisp/api.py
View File

@ -309,10 +309,12 @@ class PyMISP:
deleted: Union[bool, int, list] = False, deleted: Union[bool, int, list] = False,
extended: Union[bool, int] = False, extended: Union[bool, int] = False,
pythonify: bool = False) -> Union[Dict, MISPEvent]: pythonify: bool = False) -> Union[Dict, MISPEvent]:
"""Get an event from a MISP instance """Get an event from a MISP instance. Includes collections like
Attribute, EventReport, Feed, Galaxy, Object, Tag, etc. so the
response size may be large.
:param event: event to get :param event: event to get
:param deleted: whether to include deleted events :param deleted: whether to include soft-deleted attributes
:param extended: whether to get extended events :param extended: whether to get extended events
:param pythonify: Returns a list of PyMISP Objects instead of the plain json output. Warning: it might use a lot of RAM :param pythonify: Returns a list of PyMISP Objects instead of the plain json output. Warning: it might use a lot of RAM
""" """