Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Widget Global Recommendation Widget Products API

3 actions 3 updates phrasing extends openapi/bloomreach-global-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/global/{widget_id}'].get
$.paths['/api/v2/widgets/proxy/global/{widget_id}'].get

OpenAPI Overlay

Raw ↑ 
# 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 Global Recommendation Widget Products API
  version: 1.0.0
extends: openapi/bloomreach-global-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/global/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images for a global widget
      effect: read
      questions:
      - How do I get enriched images for trending products on my homepage?
      - Can I filter which products' images come back from a global recommendation widget?
      instructions:
      - text: Fetch enriched images for products in global widget {widget_id}.
        slots:
          widget_id: path.widget_id
      - text: Get {rows} trending product images from global widget {widget_id} filtered by {filter}.
        slots:
          widget_id: path.widget_id
          rows: query.rows
          filter: query.filter
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/widgets/proxy/global/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product pages for a global widget
      effect: read
      questions:
      - How can I fetch product description pages for a trending products widget?
      - What gives me full product page data for a global widget on a context-less page?
      instructions:
      - text: Fetch product description pages for global widget {widget_id}.
        slots:
          widget_id: path.widget_id
      - text: Proxy {rows} trending product pages from global widget {widget_id}.
        slots:
          widget_id: path.widget_id
          rows: query.rows
      method: generated
      generated: '2026-10-02'