Skip to content

Update the return of methods that should return TaskInfo #610

@alallema

Description

@alallema

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersmaintenanceAnything related to maintenance (CI, tests, refactoring...)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions