Bloomreach · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/bloomreach-category-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['/category/{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 Category-based widget API
  version: 1.0.0
extends: openapi/bloomreach-category-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['/category/{widget_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recommendations for a category page
      effect: read
      questions:
      - How do I show recommended products on a category landing page?
      - Can category recommendations come back with facets I can filter on?
      - Is it possible to page through category widget results?
      instructions:
      - text: Get recommendations from widget {widget_id} for category {cat_id}.
        slots:
          widget_id: path.widget_id
          cat_id: query.cat_id
      - text: Show {rows} recommended products for category {cat_id} with facets turned on.
        slots:
          rows: query.rows
          cat_id: query.cat_id
      - text: Filter category {cat_id} recommendations from widget {widget_id} by {filter}.
        slots:
          cat_id: query.cat_id
          widget_id: path.widget_id
          filter: query.filter
      method: generated
      generated: '2026-09-26'