Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Recommendations and Pathways Personalization-based widgets…

3 actions 3 updates phrasing extends openapi/bloomreach-personalization-based-widgets-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['/personalized/{widget_id}'].get
$.paths['/personalized/{recently_viewed_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 Recommendations and Pathways Personalization-based widgets…
  version: 1.0.0
extends: openapi/bloomreach-personalization-based-widgets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/personalized/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get personalized product picks for a shopper
      effect: read
      questions:
      - How do I show a shopper product recommendations tailored to their own behavior?
      - Can a personalized recommendation widget use the visitor's customer ID and search query together?
      - What is the most items a personalized widget can return in one response?
      instructions:
      - text: Get personalized recommendations from widget {widget_id} for customer {user_id} who searched {query}.
        slots:
          widget_id: path.widget_id
          user_id: query.user_id
          query: query.query
      - text: Fetch {rows} personalized picks for customer {user_id} from widget {widget_id} on page {url}.
        slots:
          rows: query.rows
          user_id: query.user_id
          widget_id: path.widget_id
          url: query.url
      - text: Pull personalized recommendations from widget {widget_id} filtered by {filter}.
        slots:
          widget_id: path.widget_id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalized/{recently_viewed_widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a visitor's recently viewed products
      effect: read
      questions:
      - Can I display the products a visitor looked at recently on my storefront?
      - Which cookie identifies the visitor for a recently viewed products widget?
      - Is it possible to page through a long recently viewed history?
      instructions:
      - text: Get recently viewed products from widget {recently_viewed_widget_id} for the visitor with cookie {_br_uid_2}.
        slots:
          recently_viewed_widget_id: path.recently_viewed_widget_id
          _br_uid_2: query._br_uid_2
      - text: Show the last {rows} items this visitor viewed using widget {recently_viewed_widget_id}.
        slots:
          rows: query.rows
          recently_viewed_widget_id: path.recently_viewed_widget_id
      - text: Load the next page of recently viewed items from widget {recently_viewed_widget_id} starting at item {start}.
        slots:
          recently_viewed_widget_id: path.recently_viewed_widget_id
          start: query.start
      method: generated
      generated: '2026-09-26'