Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Job Statuses API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v2/job_statuses'].get
$.paths['/api/v2/job_statuses/{job_status_id}'].get
$.paths['/api/v2/job_statuses/show_many'].get
$.paths['/api/v2/routing/agents/instance_values/job'].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 Zendesk Job Statuses API
  version: 1.0.0
extends: openapi/zendesk-job-statuses-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: 4
- target: $.paths['/api/v2/job_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List background job statuses
      effect: read
      questions:
      - Which background jobs have run recently in my account?
      - How are job statuses sorted when I list them?
      instructions:
      - text: List the statuses of recent background jobs.
      - text: Show all job statuses, most recently completed first.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/job_statuses/{job_status_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a background job's status
      effect: read
      questions:
      - Has the bulk import job I queued finished yet?
      - Can I check the progress of a single background job?
      instructions:
      - text: Check the status of that background job.
      - text: Show the progress and results of one queued job.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/job_statuses/show_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the status of several jobs
      effect: read
      questions:
      - Can I check several background jobs in one request?
      - What format do the job IDs need when checking many at once?
      instructions:
      - text: Show the statuses of jobs {ids}.
        slots:
          ids: query.ids
      - text: Check whether jobs {ids} have completed.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/routing/agents/instance_values/job'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk set routing attributes for agents
      effect: write
      questions:
      - Can I add or remove skills for up to 100 agents at once?
      - Is there a job for replacing routing attribute values across many agents?
      instructions:
      - text: Add the Spanish skill to these agents in a bulk job.
      - text: Replace the routing attribute values for a batch of agents.
      method: generated
      generated: '2026-09-26'