Skip to content

Add information about availability of custom image roles - #635

Merged
meker12 merged 2 commits into
mainfrom
ACAP-1272-catalog-service-custom-image-role-support
Oct 29, 2026
Merged

meker12 merged 2 commits into
mainfrom
ACAP-1272-catalog-service-custom-image-role-support

Conversation

@meker12

@meker12 meker12 commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Clarify support for standard and merchant-defined custom image roles in Catalog Service and Live Search GraphQL documentation.

JIRA: ACAP-1272

Changes

  • Add swatch_image to the documented standard image roles.
  • Clarify that ProductViewImage.roles can include merchant-defined custom values, such as lifestyle_image.
  • Update the Catalog Service products, productVariants, and refineProduct references, the shared ProductView documentation, and the Live Search productSearch reference.
  • Update the products overview to reflect custom image role support.

whatsnew
The ProductViewImage type in the Catalog Service GraphQL API now returns custom image roles, in addition to the standard image, small_image, thumbnail, and swatch_image roles. Merchants can define their own roles in AEM Assets, and storefronts can query them to display the right image in the right context, such as a lifestyle shot or a size chart. See product queries for details.

@github-actions

Copy link
Copy Markdown
Contributor

🔍 Linter Report

Click to expand full report
═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-29T00:40:36.522Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-webapi/commerce-webapi
Skipped Rules:
  - check-frontmatter → src/pages/includes
  - missing-heading → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 5


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    5
  📄 Files with issues:  0
  ❌ Total errors:       0
  ⚠️  Total warnings:     0
  📋 Total issues:       0

Result: ✅ PASSED - All files passed linting successfully!

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

@github-project-automation github-project-automation Bot moved this from 📋 Needs Review to 👍 Approved in Commerce - Pull Requests Oct 29, 2026
@meker12
meker12 merged commit bc938ed into main Oct 29, 2026
43 checks passed
@meker12
meker12 deleted the ACAP-1272-catalog-service-custom-image-role-support branch October 29, 2026 16:25
@github-project-automation github-project-automation Bot moved this from 👍 Approved to 🏁 Done in Commerce - Pull Requests Oct 29, 2026
@meker12 meker12 added the technical Changes to code, examples, or technical processes label Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

technical Changes to code, examples, or technical processes

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

2 participants