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

Update the return of methods that should return TaskInfo #610

Closed
10 tasks done
alallema opened this issue Nov 29, 2022 · 3 comments · Fixed by #676
Closed
10 tasks done

Update the return of methods that should return TaskInfo #610

alallema opened this issue Nov 29, 2022 · 3 comments · Fixed by #676
Labels
good first issue Good for newcomers maintenance Anything related to maintenance (CI, tests, refactoring...)

Comments

@alallema
Copy link
Contributor

alallema commented Nov 29, 2022

Most of the methods that call the Meilisearch API are asynchronous and should return the dedicated class TaskInfo class like:

    def add_documents(
        self,
        documents: list[dict[str, Any]],
        primary_key: str | None = None,
    ) -> TaskInfo:

But a lot of them return instead a Dict:

    def create_dump(self) -> dict[str, str]:

Methods to update:

  • create_index()
  • delete_index()
  • create_key()
  • update_key()
  • delete_key()
  • create_dump()
  • update_settings() and all subsetting update methods
  • reset_settings() and all subsetting reset methods

To do:

  • Update the return of the methods
  • Adapt tests
@alallema alallema added good first issue Good for newcomers maintenance Anything related to maintenance (CI, tests, refactoring...) enhancement New feature or request and removed enhancement New feature or request labels Nov 29, 2022
@sajdakabir
Copy link
Contributor

Hey @alallema i would like to work on this.

@sanders41
Copy link
Collaborator

Hi @sajdakabir issues here are free for anyone to pick up, they don't get assigned. Feel free to work on it.

@sajdakabir
Copy link
Contributor

okay thank you :) .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers maintenance Anything related to maintenance (CI, tests, refactoring...)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants