Bloomreach · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Workspace Imports API

2 actions 2 updates phrasing extends openapi/bloomreach-imports-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['/data/v2/workspaces/{workspaceId}/imports/{import_id}/start'].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 Workspace Imports API
  version: 1.0.0
extends: openapi/bloomreach-imports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/data/v2/workspaces/{workspaceId}/imports/{import_id}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an existing data import
      effect: write
      questions:
      - How do I kick off a configured data import in my Bloomreach Engagement workspace from code?
      - Can I point an import run at a different file or URL just for this one run?
      - Is it possible to skip the source connection test when starting an import?
      instructions:
      - text: Start import {import_id} in workspace {workspaceId}.
        slots:
          import_id: path.import_id
          workspaceId: path.workspaceId
      - text: Run import {import_id} in workspace {workspaceId} using source {path} instead of its configured one.
        slots:
          import_id: path.import_id
          workspaceId: path.workspaceId
          path: requestBody.path
      - text: Trigger import {import_id} without testing the connection first.
        slots:
          import_id: path.import_id
      method: generated
      generated: '2026-09-26'