meilisearch / meilisearch/meilisearch-ruby
[Meilisearch v1.13.0] Add method to get tasks documents
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Ruby
- Stars
- 224
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
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 SDK's existing task API methods and their test cases, then compare the required GET /tasks/{task_id}/documents endpoint with the Meilisearch v1.13 documentation. Add the new API method, cover it with tests, and add the matching get_task_documents_1 example in .code-samples.meilisearch.yaml.】【。
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100