Update version for the next release (v0.19.0)

[alallema]

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of Meilisearch v0.28.0 for more information on the changes.

💥 Breaking changes

• update_key() can update only name and description fields. Apply key changes #477
• get_tasks() has additional parameters for filtering:: type, status and indexUid. Apply tasks changes #476
• client.get_tasks(...) and index.get_tasks() now returns the following fields: results, limit, from, next.Apply tasks changes #476
• index.search changes in the response fields: Apply indexes changes #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: Apply indexes changes #478
  • matches renamed showMatchesPosition
  • facetsDistribution request parameter is renamed facets.
• index.get_documents() request parameters: Apply documents changes #481
  • attributesToRetrieve replaced with fields.
• client.get_indexes and client.get_raw_indexes now return the following fields: results, limit, offset, total. Apply indexes changes #478
• index.get_documents and client.get_documents now return the following fields: results, limit, offset, total. Apply documents changes #481
• index.get_documents query parameter attributesToRetrieve is now called fields Apply documents changes #481
• client.get_dump_status and wait_for_dump_creation have been removed Apply dumps changes #479
• client.create_dump() now returns tasks, similar to what add_documents or create_index returns Apply dumps changes #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. Add uid to the generateTenantToken method #484

🚀 Enhancements

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

[bidoubiwa]

Changes required:

Breaking

index.get_tasks now use GET/tasks?indexUid=movies #476

We need to join the array values when filtering by status like this: [enqueued, processing]. #476

not sure these are a breaking change for the user. Not sure it is worth mentioning as well!

index.search changes in the response parameters: #478

In the response fields

_matchesInfo response parameter is renamed _matchesPosition

This is the wrong section with the request parameters

client.get_indexes and client.get_rawIndexes now returns the following fields: results, limit, offset, total

index.get_documents and client.getDocuments now returns the following fields: results, limit, offset, total

return not returns

client.get_dump_status and wait_for_dump_creation has been removed #479

Have been removed

client.create_dump() now returns an asynchronous task #479

Now returns tasks, similar to what add_documents or create_index returns.

Enhancements

index.get_tasks and client.get_tasks accept pagination metadata, added limit (default: 20), from.

index.get_tasks and client.get_tasks accept pagination parameters with limit (default: 20), from and next.

client.get_keys accept pagination metadata, added limit (default: 20), from.

client.get_keys accept pagination parameters, with limit (default: 20) and offset (default: 0).

client.get_indexes accept pagination metadata, added limit (default: 20), offset (default: 0), total. #478

client.get_indexes accept pagination parameters, with limit (default: 20) and offset (default: 0). #478

⚠️ Most points in enhancement are lacking a PR link

[bidoubiwa]

Possibility to filter the results:

In the endpoint GET /tasks we can filter by: type, status and indexUid.

get_tasks() has additional parameters for filtering:

Also missing PR

client.getTasks(...) and index.getTasks() now returns the following fields: results, limit, from, next

get_tasks instead of getTasks

Also missing PR

index.search changes in the request parameters: #478

Since these are breaking changes maybe you can leave the details you left before:

• matches renamed showMatchesPosition
• facetsDistribution request parameter is renamed facets.
• facetsDistribution response parameter is renamed facetDistribution.

index.get_documents query parameter attributesToRetrieve is now called fields #481

Same for get_document

client.create_dump() now returns an asynchronous task #479

Not very clear! As per my previous suggestion : Now returns tasks, similar to what add_documents or create_index returns

index.get_documents now accepts pagination parameters: limit, fields and offset. #481

now accepts pagination parameters: limit and offset.
Fields does not need to be included as it is not a pagination parameter and it has already been mentioned in breaking changes

client.get_indexes and client.get_rawIndexes now return the following fields: results, limit, offset, total
index.get_documents and client.getDocuments now return the following fields: results, limit, offset, total

These are missing a linked PR

[bidoubiwa]

LGTM 🔥

[alallema]

bors merge

[bors]

Build succeeded:

• integration-tests (3.6)
• integration-tests (3.7)
• integration-tests (3.8)
• integration-tests (3.9)
• mypy
• pylint