Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Async Jobs API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v2/jobs'].get
$.paths['/v2/jobs/status/{job_id}'].get
$.paths['/v2/jobs/cancel/{job_id}'].post

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 Partner Service Async Jobs API
  version: 1.0.0
extends: openapi/explorium-asyncjobs-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: 3
- target: $.paths['/v2/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my async enrichment jobs
      effect: read
      questions:
      - Which enrichment jobs have I started, and which are still running?
      - Can I filter my background jobs by status and page through them?
      instructions:
      - text: List my enrichment jobs.
      - text: Show my jobs with status {status}.
        slots:
          status: query.status
      - text: List my jobs, skipping the first {skip}.
        slots:
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/jobs/status/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an async job
      effect: read
      questions:
      - How do I know when a background enrichment job has finished?
      - Is my queued job still processing or has it failed?
      instructions:
      - text: Check the status of job {job_id}.
        slots:
          job_id: path.job_id
      - text: Tell me whether job {job_id} is done.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/jobs/cancel/{job_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an async job
      effect: destructive
      questions:
      - Can I stop a background enrichment job that's still running?
      - What happens if I cancel a queued job before it completes?
      instructions:
      - text: Cancel job {job_id}.
        slots:
          job_id: path.job_id
      - text: Stop the running enrichment job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'