# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Tasks API
  version: 1.0.0
extends: openapi/elk-stack-tasks-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['/_tasks/_cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel tasks matching filters
      effect: destructive
      questions:
      - How do I cancel every running reindex task across the cluster at once?
      - Can I cancel tasks only on certain nodes or under one parent task?
      instructions:
      - text: Cancel all tasks matching action {actions}.
        slots:
          actions: query.actions
      - text: Cancel running tasks on nodes {nodes} whose parent task is {parent_task_id}.
        slots:
          nodes: query.nodes
          parent_task_id: query.parent_task_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_tasks/{task_id}/_cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a specific task by ID
      effect: destructive
      questions:
      - How do I cancel one long-running Elasticsearch task when I know its ID?
      - Can I wait until a specific task has actually stopped after cancelling it?
      instructions:
      - text: Cancel task {task_id}.
        slots:
          task_id: path.task_id
      - text: 'Cancel task {task_id} and wait for completion: {wait_for_completion}.'
        slots:
          task_id: path.task_id
          wait_for_completion: query.wait_for_completion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_tasks/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get information about a task
      effect: read
      questions:
      - What is the progress of a specific running task in my cluster?
      - Can I block until a given task finishes and then see its result?
      instructions:
      - text: Show details for task {task_id}.
        slots:
          task_id: path.task_id
      - text: Wait for task {task_id} to complete, up to {timeout}, and return its status.
        slots:
          task_id: path.task_id
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List running tasks in the cluster
      effect: read
      questions:
      - Which tasks are currently running on my Elasticsearch nodes?
      - Can I group running tasks by parent or by node?
      instructions:
      - text: List all tasks currently running in the cluster.
      - text: List running {actions} tasks with detailed info, grouped by {group_by}.
        slots:
          actions: query.actions
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'