meilisearch / meilisearch/meilisearch-ruby
[v1.26] Add tasks custom metadata
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
Description
Meilisearch v1.26 allows attaching custom metadata to document addition or update tasks.
We want to update this SDK's methods for documents addition and update to accept an optional metadata string.
POST /indexes/{indexUid}/documents
PUT /indexes/{indexUid}/documents
DELETE /indexes/{indexUid}/documents/{documentId}
POST /indexes/{indexUid}/documents/delete-batch
POST /indexes/{indexUid}/documents/delete
POST /indexes/{indexUid}/documents/edit
DELETE /indexes/{indexUid}/documents
For more information, read the usage guide.
Tasks
- Update all methods that interact with the listed API endpoints
- Add test cases
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 reading the v1.26 release usage guide linked in the issue, then locate the Ruby methods corresponding to the listed document endpoints. Update each method to accept optional metadata and add test cases covering it; done means all listed endpoints support the option and the tests pass.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100