# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Organization Jobs API
  version: 1.0.0
extends: openapi/edge-impulse-organization-jobs-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: 8
- target: $.paths['/api/organizations/{organizationId}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's running jobs
      effect: read
      questions:
      - Which jobs are currently running in my organization?
      - Can I see only top-level active jobs and skip their child jobs?
      instructions:
      - text: List the active jobs for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show only root-level running jobs in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's finished jobs
      effect: read
      questions:
      - What jobs has my organization completed over the last week?
      - Can I page through finished organization jobs between two dates?
      instructions:
      - text: List finished jobs in organization {organizationId} between {startDate} and {endDate}.
        slots:
          organizationId: path.organizationId
          startDate: query.startDate
          endDate: query.endDate
      - text: Show the job history for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List all jobs in an organization
      effect: read
      questions:
      - How can I see both running and finished jobs for my organization in one list?
      - Can I filter organization jobs by category and leave out pipeline transform jobs?
      instructions:
      - text: List every job, active or finished, in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show all jobs in organization {organizationId} in category {category}, excluding pipeline transform jobs.
        slots:
          organizationId: path.organizationId
          category: query.category
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/{jobId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running organization job
      effect: destructive
      questions:
      - How do I stop a job that is running in my organization?
      - Can I force-cancel an organization job that won't stop?
      instructions:
      - text: Cancel job {jobId} in organization {organizationId}.
        slots:
          jobId: path.jobId
          organizationId: path.organizationId
      - text: Force-cancel job {jobId} in organization {organizationId}.
        slots:
          jobId: path.jobId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/{jobId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an organization job
      effect: read
      questions:
      - Is my organization job finished yet or still running?
      - What is the current status of a specific organization job?
      instructions:
      - text: Get the status of job {jobId} in organization {organizationId}.
        slots:
          jobId: path.jobId
          organizationId: path.organizationId
      - text: Tell me whether organization {organizationId} job {jobId} has completed.
        slots:
          organizationId: path.organizationId
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/{jobId}/stdout'].get
  update:
    x-apievangelist-phrasing:
      intent: View an organization job's logs
      effect: read
      questions:
      - Where can I read the output of an organization job to see why it failed?
      - Can I filter an organization job's logs to errors only?
      instructions:
      - text: Show the logs for job {jobId} in organization {organizationId}.
        slots:
          jobId: path.jobId
          organizationId: path.organizationId
      - text: Get the last {limit} log lines at level {logLevel} for organization {organizationId} job {jobId}.
        slots:
          limit: query.limit
          logLevel: query.logLevel
          organizationId: path.organizationId
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/jobs/{jobId}/stdout/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an organization job's logs as text
      effect: read
      questions:
      - Can I save an organization job's log output as a text file?
      - How do I download the full stdout of an organization job?
      instructions:
      - text: Download the log file for job {jobId} in organization {organizationId}.
        slots:
          jobId: path.jobId
          organizationId: path.organizationId
      - text: Save organization {organizationId} job {jobId} logs to a text file.
        slots:
          organizationId: path.organizationId
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/socket-token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a websocket token for an organization
      effect: read
      questions:
      - How do I authenticate to the websocket to stream organization job updates?
      - What token do I need to connect to the organization socket interface?
      instructions:
      - text: Get a websocket token for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Issue a socket authentication token for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'