# 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-event-cloud-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 operation over thousands of records?
      - If I include data when creating a bulk job, does it start right away?
      instructions:
      - text: Create a bulk job that calls {operation} on {url}.
        slots:
          operation: requestBody.operation
          url: requestBody.url
      - text: Create and immediately 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:
      - Has my bulk job finished, and how many records failed?
      - Can I check the progress of a bulk job?
      instructions:
      - text: Get bulk job {id}.
        slots:
          id: path.id
      - text: Show the status and success/failure counts of 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's processing?
      - Does cancelling a bulk job stop the batch it's already on?
      instructions:
      - text: Cancel bulk job {id}.
        slots:
          id: path.id
      - text: Stop 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:
      - Is there a limit on how many records I can upload to a bulk job per call?
      - Can I upload bulk job data in several chunks before running it?
      instructions:
      - text: Upload records {data} to bulk job {id}.
        slots:
          data: requestBody.data
          id: path.id
      - text: Add another chunk of data {data} to bulk job {id} before it runs.
        slots:
          data: requestBody.data
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk-jobs/{id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List a bulk job's per-record results
      effect: read
      questions:
      - Which records in my bulk job failed and why?
      - Can I filter bulk job results to only the errors?
      instructions:
      - text: List the results of 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: Start processing a bulk job
      effect: write
      questions:
      - How do I kick off a bulk job after uploading its data?
      - How many bulk jobs can run at the same time?
      instructions:
      - text: Run bulk job {id}.
        slots:
          id: path.id
      - text: Start processing the uploaded data in bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'