Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog management View Catalogs data API

3 actions 3 updates phrasing extends openapi/bloomreach-view-catalogs-data-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['/accounts/{account_name}/catalogs'].get

$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}'].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 Catalog management View Catalogs data API
  version: 1.0.0
extends: openapi/bloomreach-view-catalogs-data-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['/accounts/{account_name}/catalogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's catalogs
      effect: read
      questions:
      - Which catalogs exist under my Bloomreach account?
      - How do I find the catalog names available to my account?
      instructions:
      - text: List all catalogs in account {account}.
        slots:
          account: path.account_name
      - text: Show me every catalog that account {account} owns.
        slots:
          account: path.account_name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a catalog with all its records
      effect: read
      questions:
      - How can I get the whole catalog, including its product and item records, in one call?
      - What is the current state of a catalog in staging versus production?
      instructions:
      - text: Get the full contents of catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: Show catalog {catalog} with all product and item records for account {account} in {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      method: generated
      generated: '2026-10-02'