Merge #493

493: Update version for the next release (v0.19.0) r=alallema a=alallema

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

## 💥 Breaking changes

- `update_key()` can update **only** `name` and `description` fields. #477
- `get_tasks()` has additional parameters for filtering:: `type`, `status` and `indexUid`. #476
- `client.get_tasks(...)` and `index.get_tasks()` now returns the following fields: `results`, `limit`, `from`, `next`.#476
- `index.search` changes in the response `fields`: #478
    - `nbHits` replaced with `estimatedTotalHits`
    - `exhaustiveNbHits` is deleted
    - `exhaustiveFacetsCount` is deleted
    - `matches` renamed `showMatchesPosition`
    - `facetsDistribution` response parameter is renamed `facetDistribution`.
- `index.search` changes in the request parameters:  #478
    - `matches` renamed `showMatchesPosition`
    - `facetsDistribution` request parameter is renamed `facets`.
- `index.get_documents()` request parameters: #481
  - `attributesToRetrieve` replaced with `fields`.
- `client.get_indexes` and `client.get_raw_indexes` now return the following fields: `results`, `limit`, `offset`, `total`. #478
- `index.get_documents` and `client.get_documents` now return the following fields: `results`, `limit`, `offset`, `total`. #481
- `index.get_documents` query parameter `attributesToRetrieve` is now called `fields` #481
- `client.get_dump_status` and `wait_for_dump_creation` have been removed #479
- `client.create_dump()` now returns tasks, similar to what add_documents or create_index returns #479
- `client.generate_tenant_token(api_key_uid, search_rules, expires_at)` has now a mandatory `api_key_uid` parameter which should contain the uid of a specific API key. #484

## 🚀 Enhancements

- `index.get_tasks` and `client.get_tasks` accept pagination metadata, added `limit` (default: 20), `from`. #476
- `client.get_indexes` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #478
- `client.get_keys` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #477
- `client.get_key(key_or_uid)` can now also find keys based on their key uid. #477
- `client.create_key(options)` lets you specify a custom uid (optionally) to create a new Key. #477
- `index.get_documents` now accepts pagination parameters: `limit` (default: 20) and `offset` (default: 0). #481


Co-authored-by: alallema <[email protected]>
Co-authored-by: Amélie <[email protected]>

Author: bors[bot]

meilisearch/version.py

@@ -1,4 +1,4 @@
-__version__ = "0.18.3"
+__version__ = "0.19.0"
 
 def qualified_version() -> str:
     """Get the qualified version of this module."""