meilisearch / meilisearch/meilisearch-python
[Meilisearch v1.13.0] Add method to get tasks documents
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Python
- Stars
- 602
- Forks
- 118
- Avg merge
- 4h 44m
- Merged PRs (30d)
- 1
Description
Context
Meilisearch 1.13 introduces a method to get tasks documents.
Description
We want to add a method to this SDK to interact with the GET /tasks/{task_id}/documents API endpoint.
Tasks
- Update API method to allow retrieving a tasks documents
- Add test cases for the new method
- Add an example under the
get_task_documents_1YAML key in .code-samples.meilisearch.yaml. It should match the example in the documentation.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the existing task-related API methods in the Python SDK and use the GET /tasks/{task_id}/documents endpoint as the starting point. Add the method, test cases for it, and an example under the get_task_documents_1 key in .code-samples.meilisearch.yaml matching the documentation example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100