Skip to content

Commit

Permalink
updated public api
Browse files Browse the repository at this point in the history
  • Loading branch information
iLLiCiTiT committed Nov 28, 2024
1 parent f1e4d82 commit ef6c6fd
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions ayon_api/_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,13 +874,14 @@ def get_events(
topics=None,
event_ids=None,
project_names=None,
states=None,
statuses=None,
users=None,
include_logs=None,
has_children=None,
newer_than=None,
older_than=None,
fields=None,
states=None,
):
"""Get events from server with filtering options.
Expand All @@ -892,7 +893,7 @@ def get_events(
event_ids (Optional[Iterable[str]]): Event ids.
project_names (Optional[Iterable[str]]): Project on which
event happened.
states (Optional[Iterable[str]]): Filtering by states.
statuses (Optional[Iterable[str]]): Filtering by statuses.
users (Optional[Iterable[str]]): Filtering by users
who created/triggered an event.
include_logs (Optional[bool]): Query also log events.
Expand All @@ -904,6 +905,8 @@ def get_events(
iso datetime string.
fields (Optional[Iterable[str]]): Fields that should be received
for each event.
states (Optional[Iterable[str]]): DEPRECATED Filtering by states.
Use 'statuses' instead.
Returns:
Generator[dict[str, Any]]: Available events matching filters.
Expand All @@ -914,13 +917,14 @@ def get_events(
topics=topics,
event_ids=event_ids,
project_names=project_names,
states=states,
statuses=statuses,
users=users,
include_logs=include_logs,
has_children=has_children,
newer_than=newer_than,
older_than=older_than,
fields=fields,
states=states,
)


Expand Down

0 comments on commit ef6c6fd

Please sign in to comment.