Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Recommendations and Pathways Keyword-based widget API

2 actions 2 updates phrasing extends openapi/bloomreach-keyword-based-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['/keyword/{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 Keyword-based widget API
  version: 1.0.0
extends: openapi/bloomreach-keyword-based-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['/keyword/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recommendations for a search keyword
      effect: read
      questions:
      - How do I show recommended products on a search results page for what the shopper typed?
      - Can keyword recommendations include facets for filtering?
      - Is there a way to page past the first batch of keyword widget results?
      instructions:
      - text: Get recommendations from keyword widget {widget_id} for the search {query}.
        slots:
          widget_id: path.widget_id
          query: query.query
      - text: Show {rows} recommended products for the keyword {query}, starting at item {start}.
        slots:
          rows: query.rows
          query: query.query
          start: query.start
      method: generated
      generated: '2026-09-26'