Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Reindex API

4 actions 4 updates phrasing extends openapi/elk-stack-reindex-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/_reindex/{task_id}/_cancel'].post
$.paths['/_reindex/{task_id}'].get
$.paths['/_reindex'].get

OpenAPI Overlay

Raw ↑ 
# 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 Reindex API
  version: 1.0.0
extends: openapi/elk-stack-reindex-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: 3
- target: $.paths['/_reindex/{task_id}/_cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running reindex task
      effect: destructive
      questions:
      - How do I cancel a reindex that's taking too long?
      - Can I cancel a reindex without waiting for it to fully stop?
      instructions:
      - text: Cancel reindex task {task_id}.
        slots:
          task_id: path.task_id
      - text: Cancel reindex {task_id} and return immediately with 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['/_reindex/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reindex task's status and progress
      effect: read
      questions:
      - How far along is my reindex task?
      - Can I keep tracking a reindex after a node shutdown moves it?
      instructions:
      - text: Get the status of reindex task {task_id}.
        slots:
          task_id: path.task_id
      - text: Wait up to {timeout} for reindex {task_id} to finish and show the result.
        slots:
          task_id: path.task_id
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_reindex'].get
  update:
    x-apievangelist-phrasing:
      intent: List running reindex tasks
      effect: read
      questions:
      - Which reindex jobs are running on my cluster right now?
      - Can I get detailed info on every in-progress reindex?
      instructions:
      - text: List all running reindex tasks.
      - text: Show running reindexes with detailed set to {detailed}.
        slots:
          detailed: query.detailed
      method: generated
      generated: '2026-09-26'