# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Soda Cloud API v4 Runners API
  version: 1.0.0
extends: openapi/soda-data-runners-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/v1/runners'].get
  update:
    x-apievangelist-phrasing:
      intent: List runners
      effect: read
      questions:
      - Which Soda runners are registered in my organization?
      - What self-hosted and hosted runners do I have?
      instructions:
      - text: List all runners.
      - text: Show page {page} of runners.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/runners'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a self-hosted runner
      effect: write
      questions:
      - How do I get API credentials to deploy a new self-hosted runner?
      - Can I retrieve a runner's secret again after creating it?
      instructions:
      - text: Create a new self-hosted runner and give me its API key.
      - text: Generate runner credentials for a new deployment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/runners/{runnerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a runner
      effect: read
      questions:
      - What is the status and configuration of a specific runner?
      - Can I look up one runner by ID?
      instructions:
      - text: Get runner {runnerId}.
        slots:
          runnerId: path.runnerId
      - text: Show details for runner {runnerId}.
        slots:
          runnerId: path.runnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/runners/{runnerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a self-hosted runner
      effect: destructive
      questions:
      - How do I decommission a self-hosted runner?
      - Why would deleting a runner fail with a bad request?
      instructions:
      - text: Delete runner {runnerId}.
        slots:
          runnerId: path.runnerId
      - text: Remove self-hosted runner {runnerId}.
        slots:
          runnerId: path.runnerId
      method: generated
      generated: '2026-09-26'