meilisearch / meilisearch/meilisearch-ruby
[Meilisearch v1.31] Allow `skipCreation` when adding/replacing 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
Description
Meilisearch v1.31.0 introduced a new skipCreation parameter to skip document creationg when using:
We want to update this SDK to allow passing the skipCreation parameter to the relevant API calls:
- POST
/indexes/{index_uid}/documents - PUT
/indexes/{index_uid}/documents
Tasks
- Update documents API methods to accept a boolean to skip creation
- Update test cases for the relevant methods
- Update the examples in .code-samples.meilisearch.yaml under the
add_or_replace_documents_1andadd_or_update_documents_1keys
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 documents API methods that handle POST and PUT requests to /indexes/{index_uid}/documents, then inspect their existing tests. Add coverage for the boolean skipCreation parameter and update the add_or_replace_documents_1 and add_or_update_documents_1 examples in .code-samples.meilisearch.yaml; the relevant tests should 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
- Clearly specified
- Newbie friendliness
- 55/100