Skip to content

Make params required in cancel_task #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 24, 2023
Merged

Make params required in cancel_task #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15741c2
Make params required in cancel_task
sanders41 May 18, 2023
278d77f
Merge remote-tracking branch 'origin/main' into cancel-tasks
sanders41 May 22, 2023
a2834b3
Merge branch 'main' into cancel-tasks
alallema May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion meilisearch/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ def cancel_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:

Parameters
----------
parameters (optional):
parameters:
parameters accepted by the cancel tasks route:https://docs.meilisearch.com/reference/api/tasks.html#cancel-tasks.

Returns
Expand Down
6 changes: 2 additions & 4 deletions meilisearch/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ def get_task(self, uid: int) -> Task:
task = self.http.get(f"{self.config.paths.task}/{uid}")
return Task(**task)

def cancel_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskInfo:
def cancel_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:
"""Cancel a list of enqueued or processing tasks.

Parameters
----------
parameters (optional):
parameters:
parameters accepted by the cancel tasks https://docs.meilisearch.com/reference/api/tasks.html#cancel-task.

Returns
Expand All @@ -94,8 +94,6 @@ def cancel_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskInfo:
MeilisearchApiError
An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
"""
if parameters is None:
parameters = {}
for param in parameters:
if isinstance(parameters[param], list):
parameters[param] = ",".join(parameters[param])
Expand Down