meilisearch / meilisearch/meilisearch-java
[Meilisearch v1.13.0] Add method to get tasks documents
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 245
- Forks
- 152
- PR merge metrics
- No merged PRs in 30d
Description
## Context
Meilisearch 1.13 introduces a method to [get tasks documents](https://www.meilisearch.com/docs/reference/api/async-task-management/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_1` YAML key in [.code-samples.meilisearch.yaml](../blob/main/.code-samples.meilisearch.yaml). It should match the example in [the documentation](https://github.com/meilisearch/documentation/blob/main/.code-samples.meilisearch.yaml).
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
Start by locating the SDK's existing task API methods and their tests, then review the GET /tasks/{task_id}/documents API reference linked in the issue. Add coverage for the new method 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
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100