Changelog

Migration Guide

For details, refer to Migration Guide: Wrapper Version 1.6.0.

Add boosting for masters and productsuggest endpoints

The stacked endpoint /e/boost can now be configured for the SPARQUE.AI endpoints /e/masters/ and /e/productsuggest.

Version 1.5.0 introduces API version v3 with improved /categorytree endpoint behavior (#108603).

Migration Guide

For details, refer to Migration Guide: Wrapper Version 1.5.0.

The channel parameter is now included as a context parameter (/c/channel/channelName) in calls that retrieve the sortings (/e/sortings) and the recommendations (/e/recommendations).

Migration Guide

For details, refer to Migration Guide: Wrapper Version 1.4.1.

Migration Guide

For details, refer to Migration Guide: Wrapper Version 1.4.0.

'keyword' Changed from API Parameter to Context Parameter

The keyword parameter used in the search and suggestions endpoints will be provided to SPARQUE as a context parameter instead of an API parameter. You can use the parameter as usual, with the additional option to leverage it in stacked endpoints.

Migration Guide

For details, refer to Migration Guide: Wrapper Version 1.3.0.

Localization of Facet Options

A new SPARQUE stacked API facet_options_lc allows to retrieve the facet's options in the selected locale.

Fixed Facets List per Channel

Fix #106779: The channel parameter is now included as a context parameter in calls that retrieve the fixed facets (/e/fixedFacets).

Endpoint /v2/categorytree

Fix #107093: The endpoint can now handle very large trees, up to 100,000 categories.

Fix #107095: Repaired and improved the category-related caching. This includes a bug fix for requests to the categorytree endpoint using both the EntryCategoryId and Levels parameters.

Ensure a Correct Count of Options for Selected Facets

Fix #106660: The facet options count is now respected when a facet option is selected.

Introduce New Settings for Calls to /e/oneVariant and /e/masters

Two new settings were introduced. These can be enabled/disabled via the Sparque Hub:

• Prioritize catalog over masters endpoint: For workspaces using the /masters endpoint with the Search Personalization setting enabled, this setting allows controlling the order of the stacked endpoints. By default, the order will be /e/masters/e/user_product_catalog. With the setting enabled, it will be /e/user_product_catalog/e/masters.
• Add boosting for oneVariant endpoint: This new setting allows stacking the new endpoint /e/boost whenever a call to /e/oneVariant is triggered. So instead of calling /e/oneVariant, the wrapper will make a call to /e/oneVariant/e/boost. This can, for example, be used to allow sharing of the Sparque strategy between search and suggest functionality while still allowing slightly different boosting of variation and master products.

Ensure Consistent and Valid Token Information Being Returned in JWT

Fix #103366: Endpoint /api/auth: "expiresIn" and "expiresInSeconds" in the returned token are now consistent with the "expiresAt" timestamp.

Fix #105112: Endpoint /api/auth: The returned tokens are now ensured to be unexpired.

Accept Encoded '%' and '+' Characters in Path Parameter Values

Fix #104330: Incoming encoded '+' or '%' characters are now correctly embedded in the SPARQUE Desk requests.

Accept Encoded '%' and '+' Characters in Path Parameter Values

Partial fix #104330: The wrapper now accepts custom parameter values that include '+' or '%' characters.

Do Not Drop Filter When Fetching Fixed Facet Details on Product List Call

Fixed #103509: When calling the products endpoint of the Wrapper, the response may contain a list of facet groups with the number of products associated with each facet in the group. The number returned was incorrect for fixed facets if an additional filter was applied.

Remove Etags from Responses

Fixed #103583: Etags were not modified when the response of a given request changed, rendering them unusable. Therefore, they have been removed for now.

Fix Mapping of the Score Value for the Facet-Options Endpoint

Fixed #103506: The score value as returned by the facet-options endpoint is mapped incorrectly.
The score now correctly represents the number of results for the facet option.

Accept Encoded Whitespaces in Path Parameter Values

Fixed #104591: Wrapper drops URL parameter values with whitespaces.
Note that parameter names with whitespaces are still ignored, like &key%20Name=value.

Stale Cache Refresh Logical Fallacy Fix

Fixed a bug in the /search and /products endpoints to correctly check for cache expiration and trigger a background refresh if the cache is older than 30 minutes.

GZIP Response Compression

Enabled GZIP response compression.