# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Bulk API
  version: 1.0.0
extends: openapi/cvent-bulk-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: 6
- target: $.paths['/bulk-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bulk job
      effect: write
      questions:
      - How do I run the same API call over thousands of records at once?
      - Can I create a bulk job and start it immediately by including the data?
      instructions:
      - text: Create a bulk job that calls {operation} on {url}.
        slots:
          operation: requestBody.operation
          url: requestBody.url
      - text: Start a bulk {operation} job against {url} with records {data}.
        slots:
          operation: requestBody.operation
          url: requestBody.url
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk job's status
      effect: read
      questions:
      - How far along is my bulk job, and how many records failed?
      - Where can I see the status of a bulk job?
      instructions:
      - text: Get bulk job {id}.
        slots:
          id: path.id
      - text: Show successful and failed counts for bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running bulk job
      effect: destructive
      questions:
      - How do I stop a bulk job that is already processing?
      - Does cancelling a bulk job stop immediately or after the current batch?
      instructions:
      - text: Cancel bulk job {id}.
        slots:
          id: path.id
      - text: Stop processing bulk job {id} after its current batch.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}/data'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload records to a bulk job
      effect: write
      questions:
      - How do I load data into a bulk job before running it?
      - What is the maximum number of records a bulk job can hold?
      instructions:
      - text: Upload records {data} to bulk job {id}.
        slots:
          data: requestBody.data
          id: path.id
      - text: Add another batch of data to bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List results of a bulk job
      effect: read
      questions:
      - Which records in my bulk job succeeded or failed?
      - Can I filter a bulk job's results to only the failures?
      instructions:
      - text: List results for bulk job {id}.
        slots:
          id: path.id
      - text: Show bulk job {id} results matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a bulk job on its uploaded data
      effect: write
      questions:
      - How do I start processing the data I uploaded to a bulk job?
      - How many bulk jobs can run at the same time?
      instructions:
      - text: Run bulk job {id}.
        slots:
          id: path.id
      - text: Begin processing the uploaded records in bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'