Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog management Feed indexing API

2 actions 2 updates phrasing extends openapi/bloomreach-feed-indexing-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['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/indexes'].post

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 Catalog management Feed indexing API
  version: 1.0.0
extends: openapi/bloomreach-feed-indexing-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: 1
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/indexes'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a catalog indexing job
      effect: write
      questions:
      - How do I trigger a reindex after updating my product feed?
      - Can I force indexing to proceed even if the document count drops sharply?
      - What starts an indexing job so catalog changes show up in search?
      instructions:
      - text: Start an indexing job for catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: 'Reindex catalog {catalog} ({environment}, account {account}) and ignore document count drops: {ignore_drop}.'
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          ignore_drop: header.BR-Ignore-Document-Count-Drop
      method: generated
      generated: '2026-10-02'