Commit 45a6393
DEVDOCS-6713 - Clarify resourceId construction from filterName in product filter translations (#1244)
<!-- Ticket number or summary of work -->
# [DEVDOCS-6713]
## What changed?
<!-- Provide a bulleted list in the present tense -->
* Clarify that `resourceId` values are constructed from `filterName`
values in the product filter translations query section
* Add concrete example showing how `brand` `filterName` becomes
`bc/store/productFilters/brand` `resourceId`
* Update callout and description to explicitly explain the relationship
between `filterName` and `resourceId`
## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.
Examples:
* The newly-released [X feature] is now available to use. Now, you'll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* Improved clarity in the product filter translations documentation. The
query section now clearly explains how to construct `resourceId` values
from `filterName` values, making it easier to query translations for
specific product filters.
## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
This change resolves confusion about the relationship between
`filterName` and `resourceId` when querying product filter translations.
ping @jamesqquick @bc-terra
[DEVDOCS-6713]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6713?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
---------
Co-authored-by: Terra Hyde <terra.hyde@bigcommerce.com>1 parent b351ec8 commit 45a6393
1 file changed
Lines changed: 2 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | 22 | | |
29 | 23 | | |
30 | 24 | | |
| |||
97 | 91 | | |
98 | 92 | | |
99 | 93 | | |
100 | | - | |
| 94 | + | |
101 | 95 | | |
102 | 96 | | |
103 | | - | |
| 97 | + | |
104 | 98 | | |
105 | 99 | | |
106 | 100 | | |
| |||
0 commit comments