# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure SparkClient Spark Batch API
  version: 1.0.0
extends: openapi/microsoft-azure-sparkbatch-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['/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List Spark batch jobs in a Spark pool
      effect: read
      questions:
      - Which Spark batch jobs are running in my Synapse Spark pool?
      - Can I page through Spark batch jobs with an offset and size?
      instructions:
      - text: List Spark batch jobs in the pool.
      - text: List {size} Spark batch jobs starting from {from}.
        slots:
          size: query.size
          from: query.from
      - text: List Spark batch jobs with detailed output {detailed}.
        slots:
          detailed: query.detailed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a new Spark batch job
      effect: write
      questions:
      - How do I submit a Spark batch job to a Synapse Spark pool?
      - Can I set driver and executor memory when submitting a batch job?
      - What's required to run a Python or JAR file as a Spark batch?
      instructions:
      - text: Submit Spark batch job {name} running file {file}.
        slots:
          name: requestBody.name
          file: requestBody.file
      - text: Run Spark batch {name} from {file} with main class {className}.
        slots:
          name: requestBody.name
          file: requestBody.file
          className: requestBody.className
      - text: Submit batch {name} for {file} using {numExecutors} executors.
        slots:
          name: requestBody.name
          file: requestBody.file
          numExecutors: requestBody.numExecutors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Spark batch job
      effect: read
      questions:
      - How can I check the state of one Spark batch job?
      - Can I get detailed info such as logs for a single batch job?
      instructions:
      - text: Get Spark batch job {batchId}.
        slots:
          batchId: path.batchId
      - text: Show detailed status of Spark batch {batchId}.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batchId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Spark batch job
      effect: destructive
      questions:
      - How do I stop a Spark batch job that's still running?
      - Can I cancel a Synapse Spark batch by its ID?
      instructions:
      - text: Cancel Spark batch job {batchId}.
        slots:
          batchId: path.batchId
      - text: Kill running Spark batch {batchId}.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-09-26'