From 01d7b8135ec98060396615981f2eee10743f6f08 Mon Sep 17 00:00:00 2001 From: Margaret Eker Date: Wed, 28 Oct 2026 18:42:16 -0500 Subject: [PATCH] Add information about availability of custom image roles --- .../schema/catalog-service/queries/product-variants.md | 2 +- src/pages/graphql/schema/catalog-service/queries/products.md | 4 ++-- .../graphql/schema/catalog-service/queries/refine-product.md | 2 +- .../graphql/schema/live-search/queries/product-search.md | 2 +- src/pages/includes/graphql/catalog-service/product-view.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/pages/graphql/schema/catalog-service/queries/product-variants.md b/src/pages/graphql/schema/catalog-service/queries/product-variants.md index dfdc88aff..76a1219e6 100644 --- a/src/pages/graphql/schema/catalog-service/queries/product-variants.md +++ b/src/pages/graphql/schema/catalog-service/queries/product-variants.md @@ -711,7 +711,7 @@ The `ProductViewImage` type contains details about a product image. | Field | Data Type | Description | | --- | --- | --- | | `label` | String | The display label of the product image. | -| `roles` | [String] | A list that describes how the image is used. Can be `image`, `small_image`, or `thumbnail`. | +| `roles` | [String] | A list that describes how the image is used. Includes the standard roles (`image`, `small_image`, `thumbnail`, `swatch_image`) and any merchant-defined custom role values, such as `lifestyle_image`. | | `url` | String! | The URL to the product image. | ### ProductViewLink type diff --git a/src/pages/graphql/schema/catalog-service/queries/products.md b/src/pages/graphql/schema/catalog-service/queries/products.md index 167bfb98e..fe4e57a7d 100644 --- a/src/pages/graphql/schema/catalog-service/queries/products.md +++ b/src/pages/graphql/schema/catalog-service/queries/products.md @@ -31,7 +31,7 @@ The `ProductView` output object is significantly different than the core `produc * Merchant-defined attributes are exposed in a top-level `attributes` container `[ProductViewAttribute]` and indicate their storefront roles. Roles include Show on PDP, Show on PLP, and Show on Search Results. -* Images are also accessible as a top-level container and can be filtered by their role. An image can have an `image`, `small_image`, or `thumbnail` role. +* Images are also accessible as a top-level container and can be filtered by their role. An image can have a standard role (`image`, `small_image`, `thumbnail`, or `swatch_image`) or a merchant-defined custom role. ## Syntax @@ -924,7 +924,7 @@ The `ProductViewImage` type contains details about a product image. | Field | Data Type | Description | | --- | --- | --- | | `label` | String | The display label of the product image. | -| `roles` | [String] | A list that describes how the image is used. Can be `image`, `small_image`, or `thumbnail`. | +| `roles` | [String] | A list that describes how the image is used. Includes the standard roles (`image`, `small_image`, `thumbnail`, `swatch_image`) and any merchant-defined custom role values, such as `lifestyle_image`. | | `url` | String! | The URL to the product image. | ### ProductViewLink type diff --git a/src/pages/graphql/schema/catalog-service/queries/refine-product.md b/src/pages/graphql/schema/catalog-service/queries/refine-product.md index 9c895fbba..d9ea5cecc 100644 --- a/src/pages/graphql/schema/catalog-service/queries/refine-product.md +++ b/src/pages/graphql/schema/catalog-service/queries/refine-product.md @@ -368,7 +368,7 @@ The `ProductViewImage` type contains details about a product image. | Field | Data Type | Description | | --- | --- | --- | | `label` | String | The display label of the product image. | -| `roles` | [String] | A list that describes how the image is used. Can be `image`, `small_image`, or `thumbnail`. | +| `roles` | [String] | A list that describes how the image is used. Includes the standard roles (`image`, `small_image`, `thumbnail`, `swatch_image`) and any merchant-defined custom role values, such as `lifestyle_image`. | | `url` | String! | The URL to the product image. | ### ProductViewLink type diff --git a/src/pages/graphql/schema/live-search/queries/product-search.md b/src/pages/graphql/schema/live-search/queries/product-search.md index 9b7c42b5b..4dd1266a4 100644 --- a/src/pages/graphql/schema/live-search/queries/product-search.md +++ b/src/pages/graphql/schema/live-search/queries/product-search.md @@ -1134,7 +1134,7 @@ The `ProductViewImage` type contains details about a product image. | Field | Data Type | Description | | --- | --- | --- | | `label` | String | The display label of the product image. | -| `roles` | [String] | A list that describes how the image is used. Can be `image`, `small_image`, or `thumbnail`. | +| `roles` | [String] | A list that describes how the image is used. Includes the standard roles (`image`, `small_image`, `thumbnail`, `swatch_image`) and any merchant-defined custom role values, such as `lifestyle_image`. | | `url` | String! | The URL to the product image. | ### ProductViewLink type diff --git a/src/pages/includes/graphql/catalog-service/product-view.md b/src/pages/includes/graphql/catalog-service/product-view.md index 9f4f68084..7e8174f13 100644 --- a/src/pages/includes/graphql/catalog-service/product-view.md +++ b/src/pages/includes/graphql/catalog-service/product-view.md @@ -86,7 +86,7 @@ The `ProductViewImage` type contains details about a product image. | Field | Data Type | Description | | --- | --- | --- | | `label` | String | The display label of the product image. | -| `roles` | [String] | A list that describes how the image is used. Can be `image`, `small_image`, or `thumbnail`. | +| `roles` | [String] | A list that describes how the image is used. Includes the standard roles (`image`, `small_image`, `thumbnail`, `swatch_image`) and any merchant-defined custom role values, such as `lifestyle_image`. | | `url` | String! | The URL to the product image. | ### ProductViewLink type