Bloomreach · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/bloomreach-category-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/category/{widget_id}'].get

$.paths['/api/v2/widgets/proxy/category/{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 Email Widget Category-based Widget Products API
  version: 1.0.0
extends: openapi/bloomreach-category-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/category/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product images for a category widget
      effect: read
      questions:
      - How do I get enriched product images for a category recommendation widget?
      - Can I sort or filter the images returned for a category widget's products?
      - Is there a way to fetch only image data for products recommended on a category page?
      instructions:
      - text: Fetch enriched images for products in category widget {widget_id} for category {cat_id}.
        slots:
          widget_id: path.widget_id
          cat_id: query.cat_id
      - text: Get {rows} product images from category widget {widget_id} for category {cat_id}, sorted by {sort}.
        slots:
          widget_id: path.widget_id
          cat_id: query.cat_id
          rows: query.rows
          sort: query.sort
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/widgets/proxy/category/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product pages for a category widget
      effect: read
      questions:
      - How can I fetch the product detail pages behind a category-based widget?
      - Can I page through product description pages for a category widget's recommendations?
      - What returns full product page data for items a category widget recommends?
      instructions:
      - text: Fetch the product description pages for category widget {widget_id} on category {cat_id}.
        slots:
          widget_id: path.widget_id
          cat_id: query.cat_id
      - text: Proxy product pages from category widget {widget_id} for category {cat_id} starting at {start}.
        slots:
          widget_id: path.widget_id
          cat_id: query.cat_id
          start: query.start
      method: generated
      generated: '2026-10-02'