Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Carolina Menezes <[email protected]>
  • Loading branch information
mariana-caetano and carolinamenezes authored Dec 20, 2024
1 parent 34105f7 commit 62b9062
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/release-notes/2024-12-20-new-sponsored-count-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ createdAt: "2024-12-20T00:00:00.219Z"
excerpt: "FastStore projects now include a new parameter to improve the management of sponsored product search results."
---

We've added a new parameter, `sponsoredCount`, to the search query. This parameter gives more control over the number of sponsored products returned in your store’s search results.
We've added a new parameter, `sponsoredCount`, to FastStore's search query. This new parameter allows you to control the number of sponsored products displayed in your store’s search results, providing more flexibility in managing search relevance and sponsored content.

> Extension API users: If you are using the [`ClientProductGallery`](https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments#clientproductgalleryquery) fragment, this change may cause errors. Make sure your implementation is updated to handle the `sponsoredCount` parameter accordingly by following the instructions in the [next section](#api-extension-users).
> ❗️ Extension API users: If you are using the [`ClientProductGallery`](https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments#clientproductgalleryquery) fragment, this change may cause errors. To prevent issues, ensure your implementation is updated to handle the `sponsoredCount` parameter by following the instructions in the [API Extension Users](#api-extension-users) section below.
## What needs to be done?

To have the new parameter enabled in your project, follow these steps:
To enable this new feature in your FastStore project, follow these steps:

1. Open your FastStore project using your preferred code editor.
2. Update your FastStore project to version `3.0.157` or later, by running the following:
Expand All @@ -26,7 +26,7 @@ To have the new parameter enabled in your project, follow these steps:

### API extension users

If you are using the [`ClientProductGallery`](https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments#clientproductgalleryquery) fragment, after updating the store version to the latest one, you may encounter the following error:
If you are using the [`ClientProductGallery`](https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments#clientproductgalleryquery) fragment, you may encounter the following error after upgrading your FastStore version:

```bash
[FAILED] GraphQL Document Validation failed with 1 errors;
Expand All @@ -39,7 +39,7 @@ Running lifecycle hook "afterStart" scripts...
To fix it, follow these steps:
1. Go to the file where you are using the `ClientManyProducts` fragment, and add the missing `sponsoredCount` parameter.
1. Go to the file where you are using the `ClientManyProducts` fragment, and add the missing `sponsoredCount` parameter. For example:
```ts mark=8
import { gql } from "@faststore/core/api";
Expand Down

0 comments on commit 62b9062

Please sign in to comment.