Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Recommendations and Pathways Item-based recommendation…

2 actions 2 updates phrasing extends openapi/bloomreach-item-based-recommendation-widget-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 2

$.info
$.paths['/item/{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 Item-based recommendation…
  version: 1.0.0
extends: openapi/bloomreach-item-based-recommendation-widget-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: 1
- target: $.paths['/item/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend products related to a given item
      effect: read
      questions:
      - How do I show similar or frequently bought together products on a product detail page?
      - Can I pass several product IDs to get recommendations for a whole cart?
      - What is context-based merchandising for item recommendations?
      instructions:
      - text: Get recommendations from widget {widget_id} for product {item_ids}.
        slots:
          widget_id: path.widget_id
          item_ids: query.item_ids
      - text: Show {rows} items related to products {item_ids}.
        slots:
          rows: query.rows
          item_ids: query.item_ids
      - text: Recommend items for {item_ids} using context product {context_pids}.
        slots:
          item_ids: query.item_ids
          context_pids: query.context_pids
      method: generated
      generated: '2026-09-26'