Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Jobs API

5 actions 5 updates phrasing extends openapi/airbyte-public-jobs-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Airbyte's API. It is a proposal applied on top of the contract, not a document Airbyte publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/jobs'].get

$.paths['/jobs'].post

$.paths['/jobs/{jobId}'].get

$.paths['/jobs/{jobId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for airbyte-api Public Jobs API
  version: 1.0.0
extends: openapi/airbyte-public-jobs-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['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List sync and reset jobs
      effect: read
      questions:
      - How do I see the recent sync jobs for a connection?
      - Can I list only failed jobs created in a date range?
      - Which jobs are currently running across my workspaces?
      instructions:
      - text: List jobs for connection {connectionId}.
        slots:
          connectionId: query.connectionId
      - text: List jobs with status {status} created after {createdAtStart}.
        slots:
          status: query.status
          createdAtStart: query.createdAtStart
      - text: List {jobType} jobs in workspace {workspaceIds}.
        slots:
          jobType: query.jobType
          workspaceIds: query.workspaceIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a sync or reset for a connection
      effect: write
      questions:
      - How do I kick off a sync for a connection right now?
      - Can I trigger a reset job on a connection?
      instructions:
      - text: Start a {jobType} job for connection {connectionId}.
        slots:
          jobType: requestBody.jobType
          connectionId: requestBody.connectionId
      - text: Trigger a sync now on connection {connectionId} with job type {jobType}.
        slots:
          connectionId: requestBody.connectionId
          jobType: requestBody.jobType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's status and details
      effect: read
      questions:
      - How do I check whether a sync job finished or failed?
      - What's the current status of a specific job?
      instructions:
      - text: Get the status of job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show details for job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running job
      effect: destructive
      questions:
      - How do I stop a sync that's currently running?
      - Can I cancel a job before it finishes?
      instructions:
      - text: Cancel job {jobId}.
        slots:
          jobId: path.jobId
      - text: Stop the running sync job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'