# 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 Migration API
  version: 1.0.0
extends: openapi/elk-stack-migration-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['/_migration/reindex/{index}/_cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a migration reindex
      effect: destructive
      questions:
      - How do I stop an in-progress upgrade reindex of a data stream?
      - Can I cancel a migration reindex that I started on an index?
      instructions:
      - text: Cancel the migration reindex for {index}.
        slots:
          index: path.index
      - text: Stop reindexing data stream {index} for the upgrade.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_create_from/{source}/{dest}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an index from a source index (PUT)
      effect: write
      questions:
      - How do I create a new index copying another index's mappings and settings with PUT?
      - Can I override some settings when cloning an index's config via PUT?
      instructions:
      - text: Create index {dest} from {source} using PUT.
        slots:
          source: path.source
          dest: path.dest
      - text: PUT a new index {dest} based on {source} with settings override {settings_override}.
        slots:
          source: path.source
          dest: path.dest
          settings_override: requestBody.settings_override
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_create_from/{source}/{dest}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an index from a source index (POST)
      effect: write
      questions:
      - How do I copy an index's mappings and settings into a new index with POST?
      - Can I drop index blocks when creating an index from another one via POST?
      instructions:
      - text: Create index {dest} from {source} using POST.
        slots:
          source: path.source
          dest: path.dest
      - text: POST a new index {dest} from {source}, overriding mappings with {mappings_override}.
        slots:
          source: path.source
          dest: path.dest
          mappings_override: requestBody.mappings_override
      - text: POST index {dest} from {source} with remove_index_blocks {remove_index_blocks}.
        slots:
          source: path.source
          dest: path.dest
          remove_index_blocks: requestBody.remove_index_blocks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_migration/reindex/{index}/_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check migration reindex progress
      effect: read
      questions:
      - How far along is the upgrade reindex of my data stream?
      - Did the migration reindex for an index fail?
      instructions:
      - text: Get the migration reindex status for {index}.
        slots:
          index: path.index
      - text: Show the progress of reindexing {index} for upgrade.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_migration/reindex'].post
  update:
    x-apievangelist-phrasing:
      intent: Reindex a data stream's legacy backing indices
      effect: write
      questions:
      - How do I upgrade old backing indices of a data stream before a major version upgrade?
      - Does reindexing legacy backing indices run in the background?
      instructions:
      - text: Reindex legacy backing indices from {source} in mode {mode}.
        slots:
          source: requestBody.source
          mode: requestBody.mode
      - text: Start upgrading data stream {source} with mode {mode}.
        slots:
          source: requestBody.source
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_migration/deprecations'].get
  update:
    x-apievangelist-phrasing:
      intent: List deprecated features in use cluster-wide
      effect: read
      questions:
      - Which deprecated settings is my cluster using before I upgrade?
      - What cluster and node deprecations will break on the next major version?
      instructions:
      - text: Show deprecation warnings for the whole cluster.
      - text: List all deprecated features in use across the cluster.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_migration/deprecations'].get
  update:
    x-apievangelist-phrasing:
      intent: List deprecations for a specific index
      effect: read
      questions:
      - Does one particular index use any deprecated settings?
      - Can I check deprecation issues only for certain indices?
      instructions:
      - text: Show deprecation info for index {index}.
        slots:
          index: path.index
      - text: Check {index} for deprecated settings before upgrading.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_migration/system_features'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which system features need migration
      effect: read
      questions:
      - Which system features must be migrated before I upgrade?
      - Is the system index migration finished?
      instructions:
      - text: Show the feature migration status.
      - text: List the system features that still need to be migrated.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_migration/system_features'].post
  update:
    x-apievangelist-phrasing:
      intent: Start migrating system feature indices
      effect: write
      questions:
      - How do I kick off the automatic migration of system indices?
      - Can I start upgrading system feature data before a version upgrade?
      instructions:
      - text: Start the system feature migration.
      - text: Begin migrating system indices for the upgrade.
      method: generated
      generated: '2026-09-26'