Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Work API

8 actions 8 updates phrasing extends openapi/lytics-work-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/work'].get

$.paths['/api/work'].post

$.paths['/api/work/{id}'].get

$.paths['/api/work/{id}'].delete

$.paths['/api/work/_status'].get

$.paths['/api/work/{id}/{cmd}'].post

$.paths['/api/work/_bounceall'].post

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 V1 Lytics Work API
  version: 1.0.0
extends: openapi/lytics-work-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/work'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration jobs
      effect: read
      questions:
      - Which integrations are running on my account right now?
      - Can I include completed or deleted jobs in the list?
      instructions:
      - text: List my running integration jobs.
      - text: 'Show work in state {state}, including completed: {showcompleted}.'
        slots:
          state: query.state
          showcompleted: query.showcompleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/work'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an integration job
      effect: write
      questions:
      - How do I start a new import or export job from a workflow?
      - What config does a new work unit need?
      instructions:
      - text: Create a work job from workflow {workflow_id}.
        slots:
          workflow_id: requestBody.workflow_id
      - text: Start workflow {workflow_id} with config {config}.
        slots:
          workflow_id: requestBody.workflow_id
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/work/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration job
      effect: read
      questions:
      - Can I check the details of one integration job?
      - What config is a particular work job running with?
      instructions:
      - text: Show work job {id}.
        slots:
          id: path.id
      - text: Fetch integration job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/work/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration job
      effect: destructive
      questions:
      - Can I delete an integration job?
      - Is it possible to remove a work unit permanently?
      instructions:
      - text: Delete work job {id}.
        slots:
          id: path.id
      - text: Remove integration job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/work/_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of integration jobs
      effect: read
      questions:
      - Can I check the run status of my jobs to see which are paused, killed or in error-wait?
      - Can I check job status for one workflow?
      instructions:
      - text: Check the run-status report for jobs in status {status}.
        slots:
          status: query.status
      - text: Check job status for workflow {workflow_id}.
        slots:
          workflow_id: query.workflow_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/work/{id}/{cmd}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a command to an integration job
      effect: write
      questions:
      - Can I pause or resume a running integration job?
      - How do I send a command to a work job?
      instructions:
      - text: Send command {cmd} to work job {id}.
        slots:
          cmd: path.cmd
          id: path.id
      - text: Run {cmd} on integration job {id}.
        slots:
          cmd: path.cmd
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/work/_bounceall'].post
  update:
    x-apievangelist-phrasing:
      intent: Bounce all integration jobs
      effect: write
      questions:
      - Can I restart every job on the account at once?
      - Can I bounce only the jobs in a particular status?
      instructions:
      - text: Bounce all work jobs.
      - text: Bounce every job with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'