Skip to content

Commit 9f3a3be

Browse files
Merge pull request #1039 from akeneo/DXIM-16
DXIM-16 update doc about default param
2 parents 7c0869c + 245c805 commit 9f3a3be

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

content/extensions/ui-extensions.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -495,17 +495,18 @@ Examples:
495495
If the URL begins with a placeholder, we won't verify its validity. The link might not work when used.
496496
:::
497497

498-
#### Fixed query parameters
499-
For an [iframe](#iframe) UI extension, with `pim.product.tab`, `pim.sub-product-model.tab`, `pim.product-model.tab` as [position](#position), several parameters are sent by default as SearchParameters in a GET query, so the server knows who is the connected user (insecure) and in which context the iframe is opened.
498+
#### Default query parameters
499+
For an [iframe](#iframe) UI extension, several parameters are sent by default as SearchParameters in a GET query, so the server knows who is the connected user (insecure) and in which context the iframe is opened.
500500

501501
For example, when `url` is `https://customerwebsite.com/iframe/`, the called URL is `https://customerwebite.com/iframe/?paramA=valueA&paramB=valueB`
502502

503-
For all positions except `pim.product-grid.action-bar`, parameters relative to the connected user are sent:
504-
- `user[catalog_locale]`
505-
- `user[catalog_scope]`
506-
- `user[ui_locale]`
503+
For all positions, parameters relative to the connected user and the extension position are sent:
507504
- `user[username]`
508505
- `user[email]`
506+
- `user[ui_locale]`
507+
- `user[catalog_locale]` except for `pim.product-grid.action-bar`
508+
- `user[catalog_scope]` except for `pim.product-grid.action-bar`
509+
- `position`
509510

510511
::: warning
511512
**Important security notice**
@@ -523,7 +524,7 @@ For `pim.product.tab` position, these parameters are sent:
523524
- `product[uuid]`
524525
- `product[identifier]`
525526

526-
For `pim.product-model.tab` position, this parameter is sent:
527+
For `pim.product-model.tab` and `pim.sub-product-model.header` position, this parameter is sent:
527528
- `product[code]`
528529

529530
For `pim.category.tab` position, this parameter is sent:

0 commit comments

Comments
 (0)