Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog management Catalog configuration API

5 actions 5 updates phrasing extends openapi/bloomreach-catalog-configuration-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 5

$.info
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/LATEST'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/LATEST'].post
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/{config_id}'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/reserved-attributes'].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 Catalog management Catalog configuration API
  version: 1.0.0
extends: openapi/bloomreach-catalog-configuration-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: 4
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/LATEST'].get
  update:
    x-apievangelist-phrasing:
      intent: View the current catalog configuration
      effect: read
      questions:
      - How can I see the catalog settings that are live in the Bloomreach dashboard right now?
      - Which custom attributes are configured on my catalog at the moment?
      - Can I pull the present catalog configuration for staging separately from production?
      instructions:
      - text: Show the current configuration of catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: List the custom attribute settings in the latest config for catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/LATEST'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the current catalog configuration
      effect: write
      questions:
      - How do I update catalog settings programmatically instead of clicking through the dashboard?
      - Can I automate changes to custom attribute configuration on a catalog?
      instructions:
      - text: Update the current configuration of catalog {catalog} in account {account} on {environment} with {data}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          data: requestBody.data
      - text: Apply this attribute config change {data} to the live settings of catalog {catalog} for account {account} in {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          data: requestBody.data
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/configs/{config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a past catalog configuration
      effect: read
      questions:
      - What did my catalog configuration look like when a particular index was built?
      - Can I look up an earlier configuration version by its config ID?
      instructions:
      - text: Get historical configuration {config_id} for catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          config_id: path.config_id
      - text: Show me the older config {config_id} that was in effect for catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          config_id: path.config_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/reserved-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a catalog's reserved attributes
      effect: read
      questions:
      - Which attribute names are reserved in my catalog and can't be used for custom fields?
      - Where can I find the list of reserved product attributes for a catalog?
      instructions:
      - text: List the reserved attributes for catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: Check which attribute names are reserved in catalog {catalog} ({environment}) for account {account}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      method: generated
      generated: '2026-10-02'