Bloomreach · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/bloomreach-keyword-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/keyword/{widget_id}'].get
$.paths['/api/v2/widgets/proxy/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 Email Widget Keyword-based Widget Products API
  version: 1.0.0
extends: openapi/bloomreach-keyword-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/keyword/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images for a keyword widget
      effect: read
      questions:
      - How do I get enriched product images for keyword search widget results?
      - Can I facet or sort the images returned for a keyword-based widget?
      instructions:
      - text: Fetch enriched images for keyword widget {widget_id} results for {query}.
        slots:
          widget_id: path.widget_id
          query: query.query
      - text: Get {rows} product images from keyword widget {widget_id} for search {query}, sorted by {sort}.
        slots:
          widget_id: path.widget_id
          query: query.query
          rows: query.rows
          sort: query.sort
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/widgets/proxy/keyword/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product pages for a keyword widget
      effect: read
      questions:
      - How can I fetch product description pages for products in keyword search widget results?
      - What returns full product page data for a search keyword widget?
      instructions:
      - text: Fetch product description pages for keyword widget {widget_id} matching {query}.
        slots:
          widget_id: path.widget_id
          query: query.query
      - text: Proxy product pages from keyword widget {widget_id} for {query}, starting at {start}.
        slots:
          widget_id: path.widget_id
          query: query.query
          start: query.start
      method: generated
      generated: '2026-10-02'