Commit 17089a1
authored
chore(catalog): CATALOG-12212 Updade product option value parameters in catalog API documentation (#1169)
<!-- Ticket number or summary of work -->
#
[CATALOG-12212](https://bigcommercecloud.atlassian.net/browse/CATALOG-12212)
## What changed?
<!-- Provide a bulleted list in the present tense -->
Corrected the exemplary values for the following parameters:
- `include_fields` should be `Allowed: label | sort_order | value_data |
is_default`.
- `exclude_fields` should be `Allowed: label | sort_order | value_data |
is_default`.
It applies to endpoints:
- `GET:
stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values`;
- `GET
:stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}`.
## 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]. -->
Now the docs are accurate and carry valid information.
## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
Tested Locally:
<img width="1377" height="913" alt="Screenshot 2025-11-25 at 16 14 39"
src="https://github.com/user-attachments/assets/137b7322-3c66-49a1-a1df-d169269a2367"
/>
<img width="1385" height="919" alt="Screenshot 2025-11-25 at 16 15 00"
src="https://github.com/user-attachments/assets/87f772a1-df50-42ae-a3ef-807208576731"
/>
ping {names}
[CATALOG-12212]:
https://bigcommercecloud.atlassian.net/browse/CATALOG-12212?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ1 parent 2417f6a commit 17089a1
1 file changed
+34
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1452 | 1452 | | |
1453 | 1453 | | |
1454 | 1454 | | |
1455 | | - | |
1456 | | - | |
| 1455 | + | |
| 1456 | + | |
1457 | 1457 | | |
1458 | 1458 | | |
1459 | 1459 | | |
| |||
1712 | 1712 | | |
1713 | 1713 | | |
1714 | 1714 | | |
1715 | | - | |
1716 | | - | |
| 1715 | + | |
| 1716 | + | |
1717 | 1717 | | |
1718 | 1718 | | |
1719 | 1719 | | |
| |||
2350 | 2350 | | |
2351 | 2351 | | |
2352 | 2352 | | |
| 2353 | + | |
| 2354 | + | |
| 2355 | + | |
| 2356 | + | |
| 2357 | + | |
| 2358 | + | |
| 2359 | + | |
| 2360 | + | |
| 2361 | + | |
| 2362 | + | |
| 2363 | + | |
| 2364 | + | |
| 2365 | + | |
| 2366 | + | |
| 2367 | + | |
| 2368 | + | |
| 2369 | + | |
| 2370 | + | |
| 2371 | + | |
| 2372 | + | |
| 2373 | + | |
| 2374 | + | |
| 2375 | + | |
| 2376 | + | |
| 2377 | + | |
| 2378 | + | |
| 2379 | + | |
| 2380 | + | |
| 2381 | + | |
| 2382 | + | |
2353 | 2383 | | |
2354 | 2384 | | |
2355 | 2385 | | |
| |||
0 commit comments