meilisearch / meilisearch/meilisearch-php
[v1.26] Add tasks custom metadata
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- PHP
- Stars
- 757
- Forks
- 125
- Avg merge
- 6d 8h
- Merged PRs (30d)
- 2
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 reviewing the SDK methods that call the seven listed document endpoints and the linked Meilisearch v1.26 usage guide to confirm the optional metadata format. Update each relevant method and add test cases covering metadata handling; done means all listed endpoint methods accept the optional metadata string and the tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100