Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog management Manage feed records API

11 actions 11 updates phrasing extends openapi/bloomreach-manage-feed-records-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 11

$.info
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records'].put
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records'].patch
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/variants'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/variants/{variant_id}'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}/variants'].get
$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}/variants/{variant_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 Catalog management Manage feed records API
  version: 1.0.0
extends: openapi/bloomreach-manage-feed-records-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: 10
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records'].get
  update:
    x-apievangelist-phrasing:
      intent: List the current feed records in a catalog
      effect: read
      questions:
      - How do I see what product records are currently in my catalog feed?
      - Can I page through all the item records in a catalog?
      instructions:
      - text: List the current feed records in catalog {catalog} for account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: Show page {page} of records in catalog {catalog} ({environment}, account {account}), {limit} at a time.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the catalog with a full feed upload
      effect: write
      questions:
      - How do I upload my entire product feed at once and replace what's there?
      - What's the way to do a full feed refresh rather than a partial update?
      instructions:
      - text: Upload a full replacement feed to catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: Replace every record in catalog {catalog} ({environment}, account {account}) with a complete feed upload.
        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}/records'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or change specific feed records
      effect: write
      questions:
      - How can I change a few product records without re-uploading the whole feed?
      - Can I add new items to my catalog feed incrementally?
      instructions:
      - text: Patch selected product records in catalog {catalog} for account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: Add or edit individual items in the feed of catalog {catalog} ({environment}, account {account}) without a full upload.
        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}/records/{record_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one feed record
      effect: read
      questions:
      - How do I look up a single product record in my feed by its ID?
      - What attributes does a particular item record currently hold?
      instructions:
      - text: Get feed record {record_id} from catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      - text: Show the details of product {record_id} in catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List the variants of a feed record
      effect: read
      questions:
      - Which variants, like sizes or colors, belong to a product record?
      - Can I page through all variants of one item in my feed?
      instructions:
      - text: List variants of record {record_id} in catalog {catalog} for account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      - text: Show the size and color variants of product {record_id} in catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/variants/{variant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one variant of a feed record
      effect: read
      questions:
      - How do I get the details of one specific variant of a product?
      - What data is stored on a single SKU variant in my feed?
      instructions:
      - text: Get variant {variant_id} of record {record_id} in catalog {catalog}, account {account}, on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          variant_id: path.variant_id
          record_id: path.record_id
      - text: Show SKU {variant_id} under product {record_id} in catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          variant_id: path.variant_id
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List the views of a feed record
      effect: read
      questions:
      - Which views, such as store or region overrides, exist for a product record?
      - Can I see every view defined on one item in my feed?
      instructions:
      - text: List the views of record {record_id} in catalog {catalog} for account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      - text: Show all store or region views for product {record_id} in catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one view of a feed record
      effect: read
      questions:
      - How do I see how a product record looks in one particular view?
      - What values does a single view override for an item?
      instructions:
      - text: Get view {view_id} of record {record_id} in catalog {catalog}, account {account}, on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          record_id: path.record_id
      - text: Show product {record_id} as it appears in view {view_id} of catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a record's variants within a view
      effect: read
      questions:
      - Which variants of a product are available in a specific store view?
      - Can I list the per-view variants of an item rather than its default variants?
      instructions:
      - text: List variants of record {record_id} in view {view_id} of catalog {catalog}, account {account}, on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          record_id: path.record_id
      - text: Show the SKUs product {record_id} has under view {view_id} in catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/records/{record_id}/views/{view_id}/variants/{variant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one variant of a record within a view
      effect: read
      questions:
      - How do I get one variant's details as it appears in a particular view?
      - What does a single SKU look like under a store-specific view of a product?
      instructions:
      - text: Get variant {variant_id} of record {record_id} in view {view_id} of catalog {catalog}, account {account}, {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          variant_id: path.variant_id
          record_id: path.record_id
      - text: Show SKU {variant_id} of product {record_id} under view {view_id} in catalog {catalog} ({environment}, {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          view_id: path.view_id
          variant_id: path.variant_id
          record_id: path.record_id
      method: generated
      generated: '2026-10-02'