Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v1.12.0] Add methods for the batches API #597

Open
5 tasks
Strift opened this issue Dec 31, 2024 · 3 comments
Open
5 tasks

[v1.12.0] Add methods for the batches API #597

Strift opened this issue Dec 31, 2024 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Strift
Copy link

Strift commented Dec 31, 2024

Following the changes related to Meilisearch v1.12.0 mega issue

Description

Add a feature introduced in Meilisearch v1.12.0: the batches API.

For more information refer to the docs:

For reference, here is how this works in JavaScript using meilisearch-js:

// Get all batches
const batches = await client.getBatches();
// Get one batch by ID
const batch = client.getBatch(BATCH_UID);

Tasks

  • Add the relevant methods to get one batch and get all batches (in meilisearch-js, the equivalent methods are getBatch() and getBatches())
  • ⚠️ Add integration tests ⚠️
  • Update the code samples in .code-samples.meilisearch.yaml for the following keys, using the same examples as their curl counterpart:
    • Add example for get_batch_1
    • Add example for get_all_batches_1
@Strift Strift added enhancement New feature or request good first issue Good for newcomers labels Dec 31, 2024
@rakeshkumarnahak
Copy link

Hello @Strift, I would like to work on this issue. Please assign this to me.

@Strift
Copy link
Author

Strift commented Jan 8, 2025

Hello @rakeshkumarnahak,

Thanks for your interest!

We prefer not assigning issues, because we've met users who asked to be assigned and never came back.
This sometimes discourages other volunteer contributors from opening a PR to fix this issue.

But you are more than welcome to open a PR for this one. We will accept and merge the first PR fixing the issue (while adhering to our contributing guidelines.)

We are looking forward to reviewing your PR 😊

@rakeshkumarnahak
Copy link

Thanks for the response @Strift , I'll start working on it from now on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants