algolia
Algolia Search API
Documented Correlation-ID and Request-ID headers
Added documentation about request identification headers: Correlation-ID (returned in all responses to identify requests in logs) and optional Request-ID (custom 11-character alphanumeric identifier). This documents existing API behaviour but does not change any endpoints, parameters, or response schemas.
Alert history
- Informational
Documented Correlation-ID and Request-ID headers
Added documentation about request identification headers:
Correlation-ID(returned in all responses to identify requests in logs) and optionalRequest-ID(custom 11-character alphanumeric identifier). This documents existing API behaviour but does not change any endpoints, parameters, or response schemas. - Breaking
Several fields removed from recommend/search schemas
Multiple fields are removed from key schemas in the Algolia Recommend API spec:
facetFiltersremoved frombaseRecommendSearchParamsenableABTestremoved frombaseRecommendSearchParamsrankingschema definition removed and its$refremoved fromrecommendIndexSettingsenableRulesmoved out ofrecommendIndexSettingsand into an inline object onrecommendSearchParamsonly
Additionally,
fallbackParamsnow composesbaseRecommendSearchParams + searchParamsQuery + recommendIndexSettingsinstead of the fullrecommendSearchParams, changing which parameters are accepted for fallback requests. Clients passingfacetFilters,enableABTest,ranking, orenableRules(in contexts other thanrecommendSearchParams) to these schemas may have those parameters silently ignored or rejected. - Additive
Add searchResponsePartial schema for flexible response field control
The API adds a new
searchResponsePartialschema to thesearchResultunion that represents partial search responses when theresponseFieldsparameter excludes certain fields. This enables clients to explicitly handle cases where optional response fields may be omitted, improving flexibility in response handling without breaking existing integrations.