Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Bulk Operation API

5 actions 5 updates phrasing extends openapi/strivacity-bulk-operation-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/admin/api/v1/bulk'].post
$.paths['/admin/api/v1/bulk'].head
$.paths['/admin/api/v1/bulk/{jobId}'].get
$.paths['/admin/api/v1/bulk/{jobId}/errors'].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 Admin Portal Bulk Operation API
  version: 1.0.0
extends: openapi/strivacity-bulk-operation-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/admin/api/v1/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk operation job
      effect: write
      questions:
      - How do I run a bulk import or update across many accounts?
      - Does creating a bulk job give me an ID to track it?
      instructions:
      - text: Create a bulk operation job.
      - text: Start a bulk job and give me its job ID.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/bulk'].head
  update:
    x-apievangelist-phrasing:
      intent: Check whether a bulk operation is running
      effect: read
      questions:
      - Is there a bulk operation in progress right now?
      - Can I check if another bulk job is already running before starting one?
      instructions:
      - text: Check whether any bulk operation is currently running.
      - text: Tell me if a bulk job is in progress.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/bulk/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bulk job's status
      effect: read
      questions:
      - How far along is my bulk operation job?
      - Has a specific bulk job finished yet?
      instructions:
      - text: Get the status of bulk job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check whether bulk job {jobId} has completed.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/bulk/{jobId}/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from a bulk job
      effect: read
      questions:
      - Which records failed in my bulk operation?
      - How do I see why rows in a bulk job errored?
      instructions:
      - text: List the errors for bulk job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show which items failed in bulk job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'