Updated Documents Function and fixed issued:#769

[Er-Sadiq]

Description This PR introduces the updateDocumentsByFunction method to the Documents class in the Meilisearch SDK. This method enables updating documents in a specified index based on a provided function.

Changes:

Added Method: Implemented the updateDocumentsByFunction method in Documents.java. Allows updating documents using a function via the new /indexes/:uid/documents/edit API endpoint. Includes error handling for null or empty function parameters. Returns a TaskInfo object that provides details about the task created. Addresses issue #769, which requests the addition of document updates via a function.

[curquiza]

Hello @Er-Sadiq Sorry for the delay

The test does not pass. I will review once the CI is green 😊

[Er-Sadiq]

@curquiza Sure ,No Problem.. Let me know if there is to fix something on fix or any improvements you are looking for Thank you ..

[curquiza]

@Er-Sadiq Check the CI result below to know what do fix

And/or run the test locally to ensure you push commits that pass the tests 😊

[coderabbitai[bot]]

Walkthrough

A method for adding or replacing documents in an index was removed from the Documents class. A new method was introduced to update documents using a provided update function, which performs validation and sends a POST request to a new endpoint. No other changes were made.

Changes

File	Change Summary
src/main/java/com/meilisearch/sdk/Documents.java	Removed addDocuments method; added updateDocumentsByFunction method with input validation and new endpoint logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Documents
    participant MeilisearchServer

    Client->>Documents: updateDocumentsByFunction(uid, updateFunction)
    Documents->>Documents: Validate updateFunction
    Documents->>MeilisearchServer: POST /indexes/{uid}/documents/edit (updateFunction)
    MeilisearchServer-->>Documents: TaskInfo
    Documents-->>Client: TaskInfo

Poem

In the code garden, old ways are shed,
No more addDocuments, it's put to bed.
Now updates bloom with functions bright,
Validated, posted, everything right.
The server responds with a TaskInfo tune—
Rabbits rejoice, new features in bloom! 🐇

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[brunoocasali]

Hey @Er-Sadiq are you still interested in making this move forward? Otherwise I will close this PR :)

If so, please:

• Add tests to the implementation you just did
• Ensure the CI is green ✅

[brunoocasali]

Closing this due to lack of activity, feel free to reopen if you want to contribute :)