Change Updates

Do not miss any Meilisearch API changes, ever again

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

RSS
Meilisearch API documentation

Change #b9bc6b04

Last update:
Compare
0.21.0

API structure has changed

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