Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Autosuggest API v2 API

2 actions 2 updates phrasing extends openapi/bloomreach-autosuggest-api-v2-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['/'].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 Autosuggest API v2 API
  version: 1.0.0
extends: openapi/bloomreach-autosuggest-api-v2-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['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest searches and products as a shopper types
      effect: read
      questions:
      - How do I show search suggestions while a shopper is still typing?
      - Can autosuggest return product and category suggestions, not just query completions?
      - Which catalog views do I have to name for Bloomreach autosuggest to work?
      instructions:
      - text: Get autosuggestions for the partial query {q} from catalog views {catalog_views}.
        slots:
          q: query.q
          catalog_views: query.catalog_views
      - text: Suggest completions for {q} for customer {user_id}.
        slots:
          q: query.q
          user_id: query.user_id
      method: generated
      generated: '2026-09-26'