Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Recommendations and Pathways Global recommendations widget…

2 actions 2 updates phrasing extends openapi/bloomreach-global-recommendations-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['/global/{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 Recommendations and Pathways Global recommendations widget…
  version: 1.0.0
extends: openapi/bloomreach-global-recommendations-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['/global/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get site-wide product recommendations
      effect: read
      questions:
      - How do I show site-wide recommendations, like best sellers, on my homepage?
      - Can I narrow global recommendations to a subset of products with a filter?
      - What catalog view does a global widget use if I run multiple storefronts?
      instructions:
      - text: Get site-wide recommendations from global widget {widget_id}.
        slots:
          widget_id: path.widget_id
      - text: Show {rows} global recommendations from widget {widget_id} for catalog view {view_id}.
        slots:
          rows: query.rows
          widget_id: path.widget_id
          view_id: query.view_id
      method: generated
      generated: '2026-09-26'