Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog management Job processing API

3 actions 3 updates phrasing extends openapi/bloomreach-job-processing-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/{catalog_name}/environments/{environment_name}/jobs/{job_id}'].get

$.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/jobs'].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 Job processing API
  version: 1.0.0
extends: openapi/bloomreach-job-processing-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/{catalog_name}/environments/{environment_name}/jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a catalog job
      effect: read
      questions:
      - How do I check whether my feed upload or indexing job has finished?
      - Can I see the full details of a single job by its ID?
      instructions:
      - text: Get the status of job {job_id} for catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          job_id: path.job_id
      - text: Show details for job {job_id} on catalog {catalog} ({environment}, account {account}).
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          job_id: path.job_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a catalog's jobs
      effect: read
      questions:
      - Which jobs have run against my catalog recently?
      - Can I filter the catalog's job history by job class?
      - Is the list of catalog jobs paginated?
      instructions:
      - text: List all jobs for catalog {catalog} in account {account} on {environment}.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
      - text: List {class} jobs for catalog {catalog} ({environment}, account {account}), {limit} per page.
        slots:
          account: path.account_name
          catalog: path.catalog_name
          environment: path.environment_name
          class: query.class
          limit: query.limit
      method: generated
      generated: '2026-10-02'