# 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 Session API
  version: 1.0.0
extends: openapi/microsoft-azure-sparksession-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: 9
- target: $.paths['/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Spark sessions in a Spark pool
      effect: read
      questions:
      - Which Spark sessions are currently running in my Synapse Spark pool?
      - Can I page through Spark sessions and get detailed info for each?
      instructions:
      - text: List the Spark sessions running in my Spark pool.
      - text: List {size} Spark sessions starting from {from}, with detailed info {detailed}.
        slots:
          size: query.size
          from: query.from
          detailed: query.detailed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new interactive Spark session
      effect: write
      questions:
      - How do I start an interactive Spark session in my Synapse pool?
      - Can I set executor memory, cores and the number of executors when opening a Spark session?
      instructions:
      - text: Create a Spark session named {name}.
        slots:
          name: requestBody.name
      - text: Start Spark session {name} with {numExecutors} executors of {executorMemory} memory each.
        slots:
          name: requestBody.name
          numExecutors: requestBody.numExecutors
          executorMemory: requestBody.executorMemory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Spark session's status
      effect: read
      questions:
      - Is my Spark session idle, busy or dead?
      - Can I look up a single Spark session by its ID?
      instructions:
      - text: Get Spark session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Show detailed state of Spark session {sessionId} (detailed={detailed}).
        slots:
          sessionId: path.sessionId
          detailed: query.detailed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running Spark session
      effect: destructive
      questions:
      - How do I shut down a Spark session I no longer need?
      - Can I kill an interactive Spark session to free up the pool?
      instructions:
      - text: Cancel Spark session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: End interactive Spark session {sessionId} and release its resources.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}/reset-timeout'].put
  update:
    x-apievangelist-phrasing:
      intent: Keep a Spark session alive
      effect: write
      questions:
      - How can I stop my idle Spark session from timing out?
      - Is there a keep-alive call that resets a Spark session's timeout?
      instructions:
      - text: Reset the timeout of Spark session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Send a keep-alive to Spark session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List statements run in a Spark session
      effect: read
      questions:
      - What code statements have been run in my Spark session so far?
      - Can I see the outputs of every statement in a Spark session?
      instructions:
      - text: List the statements in Spark session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Show all statement results for session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}/statements'].post
  update:
    x-apievangelist-phrasing:
      intent: Run code in a Spark session
      effect: write
      questions:
      - How do I execute a snippet of PySpark or Scala code in an open Spark session?
      - Which code kinds can I submit as a Spark statement?
      instructions:
      - text: Run this code {code} in Spark session {sessionId}.
        slots:
          code: requestBody.code
          sessionId: path.sessionId
      - text: Submit {code} as a {kind} statement to session {sessionId}.
        slots:
          code: requestBody.code
          kind: requestBody.kind
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}/statements/{statementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a Spark statement
      effect: read
      questions:
      - Has my Spark statement finished and what did it output?
      - Can I check the progress of one statement in a Spark session?
      instructions:
      - text: Get statement {statementId} in Spark session {sessionId}.
        slots:
          statementId: path.statementId
          sessionId: path.sessionId
      - text: Show the output of statement {statementId} from session {sessionId}.
        slots:
          statementId: path.statementId
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{sessionId}/statements/{statementId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Kill a running Spark statement
      effect: destructive
      questions:
      - Can I stop a long-running statement without ending the whole Spark session?
      - What kills one statement inside a Spark session?
      instructions:
      - text: Cancel statement {statementId} in Spark session {sessionId}.
        slots:
          statementId: path.statementId
          sessionId: path.sessionId
      - text: Kill the running statement {statementId} but keep session {sessionId} open.
        slots:
          statementId: path.statementId
          sessionId: path.sessionId
      method: generated
      generated: '2026-09-26'