API structure has changed
50 structure changes including:
15 Breaking changes
6 Additions
41 Modifications
3 Removals
Modified
41
Breaking
GET /indexes/{indexUid}/search
- Response
-
200 response Modified
- hits attribute Modified
- nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes Removed
- estimatedTotalHits, facetDistribution attributes Added
- Query
- facetsDistribution, matches query parameters Removed
- facets, showMatchesPosition query parameters Added
GET /indexes/{indexUid}/settings
- Response
-
200 response Modified
- pagination, faceting attributes Added
GET /keys
- Response
-
200 response Modified
- results attribute Modified
- limit, offset, total attributes Added
- Query
- limit, offset query parameters Added
GET /keys/{uid_or_key}
- Response
-
200 response Modified
- uid, name attributes Added
- Path
- uidOrKey path parameter Added
GET /tasks
- Response
-
200 response Modified
- results attribute Modified
- limit, from, next attributes Added
- Query
- limit, from, indexUid, status, type query parameters Added
GET /tasks/:taskUid
- Response
-
200 response Modified
- details attribute Modified
PATCH /indexes/{indexUid}
- Response
-
200 response Modified
- name attribute Removed
PATCH /indexes/{indexUid}/settings
- Body
-
content type Modified
- pagination, faceting attributes Added
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PATCH /indexes/{indexUid}/settings/typo-tolerance
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PATCH /keys/{uid_or_key}
- Body
-
content type Modified
- key, actions, indexes, expiresAt, createdAt, updatedAt attributes Removed
- name, Additional properties are NOT allowed attributes Added
- Response
-
200 response Modified
- uid, name attributes Added
POST /dumps
- Response
-
202 response Modified
- content type Modified
POST /indexes
- Response
-
201 response Modified
- name attribute Removed
POST /indexes/{indexUid}/documents
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
POST /indexes/{indexUid}/documents/delete-batch
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
POST /indexes/{indexUid}/search
- Body
-
content type Modified
- matches, facetsDistribution attributes Removed
- showMatchesPosition, facets attributes Added
- Response
-
200 response Modified
- hits attribute Modified
- nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes Removed
- estimatedTotalHits, facetDistribution attributes Added
POST /keys
- Body
-
content type Modified
- uid, name attributes Added
- Response
-
200 response Modified
- uid, name attributes Added
PUT /indexes/{indexUid}/documents
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/displayed-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/distinct-attribute
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/filterable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/ranking-rules
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/searchable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/synonyms
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/stop-words
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/sortable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/documents
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/documents/{documentId}
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/displayed-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/distinct-attribute
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/filterable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/ranking-rules
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/searchable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/sortable-attributes
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/stop-words
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/synonyms
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/typo-tolerance
- Response
-
202 response Modified
- uid attribute Removed
- taskUid, type attributes Added
GET /indexes
- Response
-
200 response Modified
- uid, name, primaryKey, createdAt, updatedAt, Additional properties are NOT allowed attributes Removed
- results, limit, offset, total attributes Added
- Query
- limit, offset query parameters Added
GET /indexes/{indexUid}
- Response
-
200 response Modified
- name attribute Removed
GET /indexes/{indexUid}/documents
- Response
-
200 response Modified
- Additional properties are allowed attribute Removed
- results, limit, offset, total attributes Added
- Query
- attributesToRetrieve query parameter Removed
- fields query parameter Added
GET /indexes/{indexUid}/documents/{documentId}
- Query
- fields query parameter Added
Removed
3
Breaking
GET /dumps/{dumpUid}/status
GET /indexes/{indexUid}/tasks
GET /indexes/{indexUid}/tasks/{taskUid}
Added
6
PATCH /indexes/{indexUid}/settings/pagination
PATCH /indexes/{indexUid}/settings/faceting
GET /indexes/{indexUid}/settings/pagination
GET /indexes/{indexUid}/settings/faceting
DELETE /indexes/{indexUid}/settings/pagination
DELETE /indexes/{indexUid}/settings/faceting