API structure has changed
57 structure changes including:
3 Breaking changes
8 Additions
47 Modifications
2 Removals
Modified
47
Breaking
PUT /indexes/{indexUid}/documents
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/search
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/displayed-attributes
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/distinct-attribute
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/filterable-attributes
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/ranking-rules
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/searchable-attributes
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/sortable-attributes
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/stop-words
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/settings/synonyms
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/stats
- Authentication
- Api key authentication method Modified
GET /keys/{key}
- Response
-
200 response Modified
- private, public, Additional properties are NOT allowed attributes Removed
- key, actions, indexes, description, expiresAt, createdAt, updatedAt attributes Added
- 401 response Removed
- Authentication
- Api key authentication method Modified
GET /stats
- Authentication
- Api key authentication method Modified
GET /version
- Authentication
- Api key authentication method Added
POST /dumps
- Authentication
- Api key authentication method Modified
POST /indexes
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/documents
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/documents/delete-batch
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/search
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/displayed-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/distinct-attribute
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/filterable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/ranking-rules
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
PUT /indexes/{indexUid}
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/synonyms
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/stop-words
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/sortable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
POST /indexes/{indexUid}/settings/searchable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/documents
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/documents/{documentId}
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/displayed-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/distinct-attribute
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/filterable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/ranking-rules
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/searchable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/sortable-attributes
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/stop-words
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/synonyms
- Response
-
202 response Modified
- updateId attribute Removed
- uid, indexUid, status, enqueuedAt attributes Added
- Authentication
- Api key authentication method Modified
GET /dumps/{dumpUid}/status
- Authentication
- Api key authentication method Modified
GET /indexes
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/documents
- Authentication
- Api key authentication method Modified
GET /indexes/{indexUid}/documents/{documentId}
- Authentication
- Api key authentication method Modified
Removed
2
Breaking
GET /indexes/{indexUid}/updates
GET /indexes/{indexUid}/updates/{updateId}
Added
8
POST /keys/{key}
PATCH /keys/{key}
GET /tasks/:taskUid
GET /tasks
GET /keys
GET /indexes/{indexUid}/tasks/{taskUid}
GET /indexes/{indexUid}/tasks
DELETE /keys/{key}