Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Widget Item-based Recommendation Widget Products API

3 actions 3 updates phrasing extends openapi/bloomreach-item-based-recommendation-widget-products-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bloomreach's API. It is a proposal applied on top of the contract, not a document Bloomreach publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/v2/widgets/image/item/{widget_id}'].get

$.paths['/api/v2/widgets/proxy/item/{widget_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Email Widget Item-based Recommendation Widget Products API
  version: 1.0.0
extends: openapi/bloomreach-item-based-recommendation-widget-products-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v2/widgets/image/item/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images for an item-based widget
      effect: read
      questions:
      - How do I get images for frequently-bought-together recommendations on a product page?
      - Can I fetch enriched images for an item-based widget seeded with several product IDs?
      instructions:
      - text: Fetch enriched images for item-based widget {widget_id} seeded with products {item_ids}.
        slots:
          widget_id: path.widget_id
          item_ids: query.item_ids
      - text: Get {rows} recommendation images from item widget {widget_id} for items {item_ids}.
        slots:
          widget_id: path.widget_id
          item_ids: query.item_ids
          rows: query.rows
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/widgets/proxy/item/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product pages for an item-based widget
      effect: read
      questions:
      - How can I fetch product description pages for bestseller or frequently-viewed recommendations?
      - What returns full product page data for an item-based widget's results?
      instructions:
      - text: Fetch product description pages for item-based widget {widget_id} using items {item_ids}.
        slots:
          widget_id: path.widget_id
          item_ids: query.item_ids
      - text: Proxy the product pages recommended by item widget {widget_id} for {item_ids}, filtered by {filter}.
        slots:
          widget_id: path.widget_id
          item_ids: query.item_ids
          filter: query.filter
      method: generated
      generated: '2026-10-02'