Meilisearch API changelog

Last update: Nov 29, 2022

Subscribe to the Meilisearch API changelog to be up to date on recent changes.

• RSS Feed

Nov 29, 2022

Added: DELETE /tasks
Added: POST /swap-indexes
Added: POST /tasks/cancel
Modified: GET /indexes/{indexUid}/search
- page, hitsPerPage query parameters were added
- 200 response was modified
  - page, hitsPerPage, totalHits, totalPages attributes were added
  - offset, limit, estimatedTotalHits attributes were modified
Modified: GET /tasks
- uids, indexUids, statuses, types, canceledBy, beforeEnqueuedAt, afterEnqueuedAt, beforeStartedAt, afterStartedAt, beforeFinishedAt, afterFinishedAt query parameters were added
- indexUid, status, type query parameters were removed
  Breaking
- 200 response was modified
  - results attribute was modified
Modified: GET /tasks/:taskUid
- taskUid path parameter was added
- 200 response was modified
  - canceledBy attribute was added
  - details, error attributes were modified
    Breaking
Modified: POST /indexes/{indexUid}/search
- body was modified
  - page, hitsPerPage attributes were added
- 200 response was modified
  - page, hitsPerPage, totalHits, totalPages attributes were added
  - offset, limit, estimatedTotalHits attributes were modified

Oct 3, 2022

Modified: DELETE /indexes/{indexUid}
- 202 response was added
- 204 response was removed
  Breaking
Modified: DELETE /indexes/{indexUid}/documents
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/documents/{documentId}
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/displayed-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/distinct-attribute
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/faceting
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/filterable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/pagination
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/ranking-rules
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/searchable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/sortable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/stop-words
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/synonyms
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/typo-tolerance
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/search
- matchingStrategy query parameter was added
Modified: GET /tasks
- 200 response was modified
  - results attribute was modified
Modified: GET /tasks/:taskUid
- 200 response was modified
  - batchUid attribute was removed
    Breaking
Modified: PATCH /indexes/{indexUid}
- 202 response was added
- 200 response was removed
  Breaking
Modified: PATCH /indexes/{indexUid}/settings
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PATCH /indexes/{indexUid}/settings/faceting
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PATCH /indexes/{indexUid}/settings/pagination
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PATCH /indexes/{indexUid}/settings/typo-tolerance
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: POST /indexes
- 202 response was added
- 201 response was removed
  Breaking
Modified: POST /indexes/{indexUid}/documents
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/documents/delete-batch
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/search
- body was modified
  - matchingStrategy attribute was added
Modified: PUT /indexes/{indexUid}/documents
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/displayed-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/distinct-attribute
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/filterable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/ranking-rules
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/searchable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/sortable-attributes
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/stop-words
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/synonyms
- 202 response was modified
  Breaking
  - taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes were removed
    Breaking

Jul 11, 2022

Added: DELETE /indexes/{indexUid}/settings/faceting
Added: DELETE /indexes/{indexUid}/settings/pagination
Added: GET /indexes/{indexUid}/settings/faceting
Added: GET /indexes/{indexUid}/settings/pagination
Added: PATCH /indexes/{indexUid}/settings/faceting
Added: PATCH /indexes/{indexUid}/settings/pagination
Modified: DELETE /indexes/{indexUid}/documents
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/documents/{documentId}
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/displayed-attributes
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/distinct-attribute
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/filterable-attributes
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/ranking-rules
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/searchable-attributes
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/sortable-attributes
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/stop-words
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/synonyms
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/typo-tolerance
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: GET /indexes
- limit, offset query parameters were added
- 200 response was modified
  Breaking
  - results, limit, offset, total attributes were added
    Breaking
  - uid, name, primaryKey, createdAt, updatedAt, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}
- 200 response was modified
  - name attribute was removed
    Breaking
Modified: GET /indexes/{indexUid}/documents
- fields query parameter was added
- attributesToRetrieve query parameter was removed
  Breaking
- 200 response was modified
  Breaking
  - results, limit, offset, total attributes were added
    Breaking
  - Additional properties are allowed attribute was removed
    Breaking
Modified: GET /indexes/{indexUid}/documents/{documentId}
- fields query parameter was added
Modified: GET /indexes/{indexUid}/search
- facets, showMatchesPosition query parameters were added
- facetsDistribution, matches query parameters were removed
  Breaking
- 200 response was modified
  - estimatedTotalHits, facetDistribution attributes were added
  - nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes were removed
    Breaking
  - hits attribute was modified
Modified: GET /indexes/{indexUid}/settings
- 200 response was modified
  - pagination, faceting attributes were added
Modified: GET /keys
- limit, offset query parameters were added
- 200 response was modified
  - limit, offset, total attributes were added
  - results attribute was modified
    Breaking
Modified: GET /keys/{uid_or_key}
- uidOrKey path parameter was added
- 200 response was modified
  - uid, name attributes were added
Modified: GET /tasks
- limit, from, indexUid, status, type query parameters were added
- 200 response was modified
  - limit, from, next attributes were added
  - results attribute was modified
    Breaking
Modified: GET /tasks/:taskUid
- 200 response was modified
  - details attribute was modified
Modified: PATCH /indexes/{indexUid}
Breaking
- 200 response was modified
  Breaking
  - name attribute was removed
    Breaking
Modified: PATCH /indexes/{indexUid}/settings
Breaking
- body was modified
  Breaking
  - pagination, faceting attributes were added
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PATCH /indexes/{indexUid}/settings/typo-tolerance
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PATCH /keys/{uid_or_key}
- body was modified
  - name, Additional properties are NOT allowed attributes were added
  - key, actions, indexes, expiresAt, createdAt, updatedAt attributes were removed
    Breaking
- 200 response was modified
  - uid, name attributes were added
Modified: POST /dumps
- 202 response was modified
  Breaking
  - body was modified
    Breaking
Modified: POST /indexes
- 201 response was modified
  - name attribute was removed
    Breaking
Modified: POST /indexes/{indexUid}/documents
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: POST /indexes/{indexUid}/documents/delete-batch
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: POST /indexes/{indexUid}/search
- body was modified
  - showMatchesPosition, facets attributes were added
  - matches, facetsDistribution attributes were removed
    Breaking
- 200 response was modified
  - estimatedTotalHits, facetDistribution attributes were added
  - nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes were removed
    Breaking
  - hits attribute was modified
Modified: POST /keys
Breaking
- body was modified
  Breaking
  - uid, name attributes were added
- 200 response was modified
  Breaking
  - uid, name attributes were added
Modified: PUT /indexes/{indexUid}/documents
- 202 response was modified
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/displayed-attributes
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/distinct-attribute
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/filterable-attributes
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/ranking-rules
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/searchable-attributes
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/sortable-attributes
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/stop-words
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}/settings/synonyms
Breaking
- 202 response was modified
  Breaking
  - taskUid, type attributes were added
  - uid attribute was removed
    Breaking
Removed: GET /dumps/{dumpUid}/status
Breaking
Removed: GET /indexes/{indexUid}/tasks
Breaking
Removed: GET /indexes/{indexUid}/tasks/{taskUid}
Breaking

May 16, 2022

Added: DELETE /indexes/{indexUid}/settings/typo-tolerance
Added: GET /indexes/{indexUid}/settings/typo-tolerance
Added: POST /indexes/{indexUid}/settings/typo-tolerance
Modified: GET /indexes/{indexUid}/search
- highlightPreTag, highlightPostTag, cropMarker query parameters were added
Modified: GET /indexes/{indexUid}/settings
- 200 response was modified
  - typoTolerance attribute was added
Modified: GET /indexes/{indexUid}/tasks
- 200 response was modified
  - results attribute was modified
Modified: GET /indexes/{indexUid}/tasks/{taskUid}
- 200 response was modified
  - details attribute was modified
Modified: GET /tasks
- 200 response was modified
  - results attribute was modified
Modified: GET /tasks/:taskUid
- 200 response was modified
  - details attribute was modified
Modified: POST /indexes/{indexUid}/search
- body was modified
  - highlightPreTag, highlightPostTag, cropMarker attributes were added
Modified: POST /indexes/{indexUid}/settings
- body was modified
  - typoTolerance attribute was added

Mar 14, 2022

Modified: GET /indexes/{indexUid}/tasks
- 200 response was modified
  - results attribute was modified
Modified: GET /indexes/{indexUid}/tasks/{taskUid}
- 200 response was modified
  - batchUid attribute was added
Modified: GET /tasks
- 200 response was modified
  - results attribute was modified
Modified: GET /tasks/:taskUid
- 200 response was modified
  - batchUid attribute was added

Jan 26, 2022

Jan 11, 2022

Added: DELETE /keys/{key}
Added: GET /indexes/{indexUid}/tasks
Added: GET /indexes/{indexUid}/tasks/{taskUid}
Added: GET /keys
Added: GET /tasks
Added: GET /tasks/:taskUid
Added: PATCH /keys/{key}
Added: POST /keys/{key}
Modified: DELETE /indexes/{indexUid}
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/documents
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/documents/{documentId}
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/displayed-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/distinct-attribute
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/filterable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/ranking-rules
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/searchable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/sortable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/stop-words
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: DELETE /indexes/{indexUid}/settings/synonyms
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: GET /dumps/{dumpUid}/status
- Api key authentication method was modified
  Breaking
Modified: GET /indexes
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/documents
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/documents/{documentId}
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/search
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/displayed-attributes
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/distinct-attribute
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/filterable-attributes
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/ranking-rules
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/searchable-attributes
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/sortable-attributes
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/stop-words
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/settings/synonyms
- Api key authentication method was modified
  Breaking
Modified: GET /indexes/{indexUid}/stats
- Api key authentication method was modified
  Breaking
Modified: GET /keys/{key}
Breaking
- 401 response was removed
  Breaking
- 200 response was modified
  Breaking
  - key, actions, indexes, description, expiresAt, createdAt, updatedAt attributes were added
  - private, public, Additional properties are NOT allowed attributes were removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: GET /stats
- Api key authentication method was modified
  Breaking
Modified: GET /version
- Api key authentication method was added
Modified: POST /dumps
- Api key authentication method was modified
  Breaking
Modified: POST /indexes
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/documents
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/documents/delete-batch
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/search
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/displayed-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/distinct-attribute
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/filterable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/ranking-rules
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/searchable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/sortable-attributes
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/stop-words
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: POST /indexes/{indexUid}/settings/synonyms
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Modified: PUT /indexes/{indexUid}
- Api key authentication method was modified
  Breaking
Modified: PUT /indexes/{indexUid}/documents
- 202 response was modified
  - uid, indexUid, status, enqueuedAt attributes were added
  - updateId attribute was removed
    Breaking
- Api key authentication method was modified
  Breaking
Removed: GET /indexes/{indexUid}/updates
Breaking
Removed: GET /indexes/{indexUid}/updates/{updateId}
Breaking

Nov 16, 2021

Modified: DELETE /indexes/{indexUid}
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/documents
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/documents/{documentId}
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/displayed-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/distinct-attribute
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/filterable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/ranking-rules
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/searchable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/sortable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/stop-words
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: DELETE /indexes/{indexUid}/settings/synonyms
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /dumps/{dumpUid}/status
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
- 404 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/documents
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/documents/{documentId}
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/search
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/displayed-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/distinct-attribute
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/filterable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/ranking-rules
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/searchable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/sortable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/stop-words
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/settings/synonyms
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/stats
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/updates
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /indexes/{indexUid}/updates/{updateId}
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /keys
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /stats
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: GET /version
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /dumps
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes
- 400 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/documents
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
- 413 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/documents/delete-batch
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/search
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/displayed-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/distinct-attribute
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/filterable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/ranking-rules
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/searchable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/sortable-attributes
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/stop-words
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: POST /indexes/{indexUid}/settings/synonyms
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}
- 400 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
Modified: PUT /indexes/{indexUid}/documents
- 401 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking
- 413 response was modified
  - code, type, link attributes were added
  - errorCode, errorType, errorLink attributes were removed
    Breaking

Oct 12, 2021

Modified: GET /indexes/{indexUid}/search
- 200 response was modified
  - hits attribute was modified
Modified: POST /indexes
- Content-Type header was added
Modified: POST /indexes/{indexUid}/documents
- Content-Type header was added
Modified: POST /indexes/{indexUid}/documents/delete-batch
- Content-Type header was added
Modified: POST /indexes/{indexUid}/search
- Content-Type header was added
- 200 response was modified
  - hits attribute was modified
Modified: POST /indexes/{indexUid}/settings
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/displayed-attributes
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/distinct-attribute
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/filterable-attributes
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/ranking-rules
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/searchable-attributes
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/sortable-attributes
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/stop-words
- Content-Type header was added
Modified: POST /indexes/{indexUid}/settings/synonyms
- Content-Type header was added
Modified: PUT /indexes/{indexUid}
- Content-Type header was added
Modified: PUT /indexes/{indexUid}/documents
- Content-Type header was added

Sep 13, 2021

Added: DELETE /indexes/{indexUid}/settings/sortable-attributes
Added: GET /indexes/{indexUid}/settings/sortable-attributes
Added: POST /indexes/{indexUid}/settings/sortable-attributes
Modified: GET /indexes/{indexUid}/search
- sort query parameter was added
Modified: GET /indexes/{indexUid}/settings
- 200 response was modified
  - sortableAttributes attribute was added
Modified: POST /indexes/{indexUid}/search
- body was modified
  - sort attribute was added
Modified: POST /indexes/{indexUid}/settings
- body was modified
  - sortableAttributes attribute was added

Aug 16, 2021

Jul 29, 2021

Modified: GET /indexes/{indexUid}/search
- attributesToCrop, cropLength, filter query parameters were modified
  Breaking
Modified: POST /indexes/{indexUid}/search
- body was modified
  - filter attribute was modified
    Breaking

Jul 22, 2021

Modified: GET /version
- 200 response was modified
  - commitDate attribute was added
  - buildDate attribute was removed
    Breaking

Jul 20, 2021

Modified: DELETE /indexes/{indexUid}
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/documents
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/documents/{documentId}
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/displayed-attributes
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/distinct-attribute
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/filterable-attributes
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/ranking-rules
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/searchable-attributes
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/stop-words
- 401, 404 responses were added
Modified: DELETE /indexes/{indexUid}/settings/synonyms
- 401, 404 responses were added
Modified: GET /dumps/{dumpUid}/status
Breaking
- 401, 404 responses were added
  Breaking
- 200 response was modified
  Breaking
  - startedAt, finishedAt attributes were added
  - status attribute was modified
    Breaking
Modified: GET /indexes
- 401 response was added
- 200 response was modified
  - name attribute was added
  - primaryKey attribute was modified
    Breaking
Modified: GET /indexes/{indexUid}
- 401, 404 responses were added
- 200 response was modified
  - name attribute was added
  - primaryKey attribute was modified
    Breaking
Modified: GET /indexes/{indexUid}/documents
- limit, offset, attributesToRetrieve query parameters were added
- 401, 404 responses were added
- 200 response was modified
  - Additional properties are allowed attribute was added
Modified: GET /indexes/{indexUid}/documents/{documentId}
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/search
- filter, attributesToRetrieve, limit, offset, matches query parameters were added
- 401, 404 responses were added
- filters query parameter was removed
  Breaking
- q query parameter was modified
- attributesToCrop query parameter was modified
  Breaking
- 200 response was modified
  - facetsDistribution, exhaustiveFacetsCount, Additional properties are NOT allowed attributes were added
  - hits, offset, limit, nbHits, exhaustiveNbHits, processingTimeMs, query attributes were modified
    Breaking
Modified: GET /indexes/{indexUid}/settings
- 401, 404 responses were added
- 200 response was modified
  - rankingRules, distinctAttribute, searchableAttributes, displayedAttributes, stopWords, synonyms, filterableAttributes attributes were added
Modified: GET /indexes/{indexUid}/settings/displayed-attributes
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/distinct-attribute
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/filterable-attributes
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/ranking-rules
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/searchable-attributes
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/stop-words
- 401, 404 responses were added
Modified: GET /indexes/{indexUid}/settings/synonyms
- 401, 404 responses were added
- 200 response was modified
  - Additional properties: attribute was removed
    Breaking
Modified: GET /indexes/{indexUid}/stats
- 401, 404 responses were added
- 200 response was modified
  - fieldDistribution attribute was added
  - fieldsDistribution attribute was removed
    Breaking
Modified: GET /indexes/{indexUid}/updates
- 401, 404 responses were added
- 200 response was modified
  - status, updateId, type, enqueuedAt, processedAt, duration, error attributes were added
Modified: GET /indexes/{indexUid}/updates/{updateId}
- 401, 404 responses were added
- 200 response was modified
  - status attribute was modified
    Breaking
  - type attribute was modified
Modified: GET /keys
- 401 response was added
Modified: GET /stats
- 401 response was added
- 200 response was modified
  - indexes attribute was modified
Modified: GET /version
- 401 response was added
Modified: POST /dumps
- 401 response was added
- 202 response was modified
  - startedAt, finishedAt attributes were added
  - status attribute was modified
    Breaking
Modified: POST /indexes
- 400, 401 responses were added
- 201 response was modified
  - name attribute was added
  - primaryKey attribute was modified
    Breaking
Modified: POST /indexes/{indexUid}/documents
- 401, 413 responses were added
Modified: POST /indexes/{indexUid}/documents/delete-batch
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/search
- 401, 404 responses were added
- body was modified
  - filter attribute was added
  - filters attribute was removed
    Breaking
  - q attribute was modified
- 200 response was modified
  - facetsDistribution, exhaustiveFacetsCount, Additional properties are NOT allowed attributes were added
  - hits, offset, limit, nbHits, exhaustiveNbHits, processingTimeMs, query attributes were modified
    Breaking
Modified: POST /indexes/{indexUid}/settings
- 401, 404 responses were added
- body was modified
  - filterableAttributes attribute was added
  - attributesForFaceting attribute was removed
    Breaking
  - synonyms attribute was modified
Modified: POST /indexes/{indexUid}/settings/displayed-attributes
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/distinct-attribute
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/filterable-attributes
- body was added
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/ranking-rules
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/searchable-attributes
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/stop-words
- 401, 404 responses were added
Modified: POST /indexes/{indexUid}/settings/synonyms
- 401, 404 responses were added
- body was modified
  - Additional properties: attribute was removed
    Breaking
Modified: PUT /indexes/{indexUid}
- 400, 401, 404 responses were added
- 200 response was modified
  - name attribute was added
  - primaryKey attribute was modified
    Breaking
Modified: PUT /indexes/{indexUid}/documents
- 401, 413 responses were added
- body was modified
  - Additional properties are allowed attribute was added

Jul 15, 2021

Meilisearch API changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

Documentation content has changed

Documentation content has changed

API structure has changed

API structure has changed

Documentation content has changed

API structure has changed

API structure has changed

Documentation content has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created