From 58ae79bee36dd7ba51b6d609e0769d206955ccd9 Mon Sep 17 00:00:00 2001 From: Audrius Mecionis Date: Thu, 25 Feb 2021 15:06:06 +0100 Subject: [PATCH] docs: added get_workflow_logs function under rest API docs section --- docs/index.rst | 2 +- reana_client/api/client.py | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 7f77f410..36ce44e1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,7 +21,7 @@ API docs ======== .. automodule:: reana_client.api.client - :members: create_workflow_from_json, upload_to_server, upload_file, start_workflow, list_files, get_workflow_status, download_file + :members: create_workflow_from_json, upload_to_server, upload_file, start_workflow, list_files, get_workflow_status, download_file, get_workflow_logs .. include:: ../CHANGES.rst diff --git a/reana_client/api/client.py b/reana_client/api/client.py index ebec6954..cfe51388 100644 --- a/reana_client/api/client.py +++ b/reana_client/api/client.py @@ -313,7 +313,14 @@ def upload_file(workflow, file_, file_name, access_token): def get_workflow_logs(workflow, access_token, steps=None, page=None, size=None): - """Get logs from a workflow engine.""" + """Get logs from a workflow engine. + + :param workflow: name or id which identifies the workflow. + :param access_token: access token of the current user. + :param steps: list of step names to get logs for. + :param page: page number of returned log list. + :param size: page size of returned log list. + """ try: (response, http_response) = current_rs_api_client.api.get_workflow_logs( workflow_id_or_name=workflow,