Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Widget Personalization-based Widget Products API

3 actions 3 updates phrasing extends openapi/bloomreach-personalization-based-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/personalized/{widget_id}'].get
$.paths['/api/v2/widgets/proxy/personalized/{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 Personalization-based Widget Products API
  version: 1.0.0
extends: openapi/bloomreach-personalization-based-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/personalized/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images for a personalized widget
      effect: read
      questions:
      - How do I get images for a shopper's past-purchase recommendations?
      - Can I fetch enriched images for a personalization widget tied to a specific user ID?
      instructions:
      - text: Fetch enriched images for personalization widget {widget_id} for user {user_id} and query {query}.
        slots:
          widget_id: path.widget_id
          user_id: query.user_id
          query: query.query
      - text: Get {rows} past-purchase product images from widget {widget_id} for shopper {user_id}, query {query}.
        slots:
          widget_id: path.widget_id
          user_id: query.user_id
          rows: query.rows
          query: query.query
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/widgets/proxy/personalized/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product pages for a personalized widget
      effect: read
      questions:
      - How can I fetch product description pages for a user's personalized recommendations?
      - What returns full product page data for a past purchases widget?
      instructions:
      - text: Fetch product description pages for personalization widget {widget_id} for user {user_id}, query {query}.
        slots:
          widget_id: path.widget_id
          user_id: query.user_id
          query: query.query
      - text: Proxy the personalized product pages from widget {widget_id} for shopper {user_id} and query {query}.
        slots:
          widget_id: path.widget_id
          user_id: query.user_id
          query: query.query
      method: generated
      generated: '2026-10-02'