# 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 Ccr API
  version: 1.0.0
extends: openapi/elk-stack-ccr-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: 14
- target: $.paths['/_ccr/auto_follow/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one auto-follow pattern
      effect: read
      questions:
      - What settings does a specific cross-cluster replication auto-follow pattern use?
      - Can I look up a single auto-follow pattern by its name to see which leader indices it matches?
      instructions:
      - text: Show me the auto-follow pattern named {name}.
        slots:
          name: path.name
      - text: Get the leader index patterns configured in auto-follow pattern {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/auto_follow/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an auto-follow pattern
      effect: write
      questions:
      - How do I automatically replicate new indices from a remote cluster as they get created?
      - Can I exclude some leader indices from an auto-follow pattern while matching the rest?
      - Does an auto-follow pattern also pick up indices that already exist on the remote cluster?
      instructions:
      - text: Create auto-follow pattern {name} that follows indices matching {leader_index_patterns} on remote cluster {remote_cluster}.
        slots:
          name: path.name
          leader_index_patterns: requestBody.leader_index_patterns
          remote_cluster: requestBody.remote_cluster
      - text: Set up auto-following called {name} from {remote_cluster}, naming followers with the pattern {follow_index_pattern}.
        slots:
          name: path.name
          remote_cluster: requestBody.remote_cluster
          follow_index_pattern: requestBody.follow_index_pattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/auto_follow/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an auto-follow pattern
      effect: destructive
      questions:
      - How do I remove an auto-follow pattern I no longer need for cross-cluster replication?
      - Will deleting an auto-follow pattern stop replication for follower indices it already created?
      instructions:
      - text: Delete the auto-follow pattern {name}.
        slots:
          name: path.name
      - text: Remove auto-follow collection {name} from this cluster permanently.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/follow'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a follower index for a leader index
      effect: write
      questions:
      - How do I start replicating one specific index from a remote Elasticsearch cluster?
      - Can I wait until the follower index shards are active before the follow request returns?
      instructions:
      - text: Create follower index {index} that replicates leader index {leader_index} from remote cluster {remote_cluster}.
        slots:
          index: path.index
          leader_index: requestBody.leader_index
          remote_cluster: requestBody.remote_cluster
      - text: Make {index} follow {leader_index} on {remote_cluster} and wait for {wait_for_active_shards} active shards.
        slots:
          index: path.index
          leader_index: requestBody.leader_index
          remote_cluster: requestBody.remote_cluster
          wait_for_active_shards: query.wait_for_active_shards
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get follower index configuration and status
      effect: read
      questions:
      - Is my follower index currently active or paused, and which leader does it track?
      - Where can I see the replication parameters a follower index was created with?
      instructions:
      - text: Show the follower configuration and status for {index}.
        slots:
          index: path.index
      - text: Tell me whether follower index {index} is active or paused.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shard-level stats for a follower index
      effect: read
      questions:
      - How far behind the leader is my follower index on each shard?
      - Which shard-level following-task metrics are reported for a replicated index?
      instructions:
      - text: Get shard-level replication stats for follower index {index}.
        slots:
          index: path.index
      - text: Report the following-task stats for {index}, timing out after {timeout}.
        slots:
          index: path.index
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/forget_follower'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove follower retention leases from a leader
      effect: destructive
      questions:
      - How do I clean up retention leases a follower left on the leader index after unfollowing failed?
      - Why is my leader index still holding history for a follower I already removed?
      instructions:
      - text: On leader index {index}, remove the retention leases held by follower {follower_index} in cluster {follower_cluster}.
        slots:
          index: path.index
          follower_index: requestBody.follower_index
          follower_cluster: requestBody.follower_cluster
      - text: Forget follower index UUID {follower_index_uuid} on leader {index}.
        slots:
          index: path.index
          follower_index_uuid: requestBody.follower_index_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/auto_follow'].get
  update:
    x-apievangelist-phrasing:
      intent: List all auto-follow patterns
      effect: read
      questions:
      - Which auto-follow patterns are configured on this cluster?
      - Can I see every cross-cluster replication auto-follow collection at once?
      instructions:
      - text: List all auto-follow patterns on the cluster.
      - text: Show every configured auto-follow pattern, waiting up to {master_timeout} for the master node.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/auto_follow/{name}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause an auto-follow pattern
      effect: write
      questions:
      - How do I temporarily stop an auto-follow pattern from creating new follower indices?
      - Do followers that an auto-follow pattern already created keep replicating after I pause it?
      instructions:
      - text: Pause auto-follow pattern {name}.
        slots:
          name: path.name
      - text: Stop auto-follow pattern {name} from following new leader indices for now.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/pause_follow'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a follower index
      effect: write
      questions:
      - How do I temporarily stop a follower index from fetching operations from its leader?
      - Can I pause replication on one follower index before changing its settings?
      instructions:
      - text: Pause replication on follower index {index}.
        slots:
          index: path.index
      - text: Halt fetching from the leader for follower {index} so I can reconfigure it.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/auto_follow/{name}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused auto-follow pattern
      effect: write
      questions:
      - How do I turn a paused auto-follow pattern back on?
      - Will a resumed auto-follow pattern start creating followers for newly matching remote indices again?
      instructions:
      - text: Resume auto-follow pattern {name}.
        slots:
          name: path.name
      - text: Reactivate the paused auto-follow collection {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/resume_follow'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused follower index
      effect: write
      questions:
      - How do I restart replication on a follower index that I paused?
      - Can I change read and write buffer limits when resuming a follower?
      instructions:
      - text: Resume following on follower index {index}.
        slots:
          index: path.index
      - text: Restart replication for {index} with a read poll timeout of {read_poll_timeout}.
        slots:
          index: path.index
          read_poll_timeout: requestBody.read_poll_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_ccr/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster-wide cross-cluster replication stats
      effect: read
      questions:
      - What are the overall cross-cluster replication stats, including auto-follow results?
      - Have any auto-follow attempts failed recently on this cluster?
      instructions:
      - text: Show cross-cluster replication stats for the whole cluster.
      - text: Get auto-following and follower stats, timing out after {timeout}.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_ccr/unfollow'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a follower into a regular index
      effect: destructive
      questions:
      - How do I turn a follower index into a normal standalone index?
      - Does an index need to be paused and closed before I can stop it following its leader?
      instructions:
      - text: Unfollow {index} and convert it to a regular index.
        slots:
          index: path.index
      - text: Permanently stop follower {index} from tracking its leader.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'