# 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 Searchable Snapshots API
  version: 1.0.0
extends: openapi/elk-stack-searchable-snapshots-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: 7
- target: $.paths['/_searchable_snapshots/cache/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shared cache stats across all nodes
      effect: read
      questions:
      - How full is the shared cache for partially mounted indices across my cluster?
      - Can I see cluster-wide cache statistics for frozen-tier searchable snapshots?
      instructions:
      - text: Show shared cache statistics for every node.
      - text: Report cluster-wide searchable snapshot cache usage.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_searchable_snapshots/{node_id}/cache/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shared cache stats for specific nodes
      effect: read
      questions:
      - What does the searchable snapshot cache look like on one particular node?
      - Can I limit cache statistics to selected node IDs?
      instructions:
      - text: Get cache usage on node {node_id} alone.
        slots:
          node_id: path.node_id
      - text: Report the partially mounted index cache on nodes {node_id} only.
        slots:
          node_id: path.node_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_searchable_snapshots/cache/clear'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear the searchable snapshot cache everywhere
      effect: write
      questions:
      - Can I flush the shared cache for all partially mounted indices?
      - Does clearing the whole cache ignore unavailable indices?
      instructions:
      - text: Clear the searchable snapshot cache for all indices.
      - text: Clear the cache across every index, with ignore_unavailable {ignore_unavailable}.
        slots:
          ignore_unavailable: query.ignore_unavailable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_searchable_snapshots/cache/clear'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear the searchable snapshot cache for an index
      effect: write
      questions:
      - How do I clear cached data for just one mounted index or data stream?
      - Can I target an index pattern when clearing the snapshot cache?
      instructions:
      - text: Clear the searchable snapshot cache for index {index}.
        slots:
          index: path.index
      - text: Drop cached data for indices matching {index}, expanding wildcards to {expand_wildcards}.
        slots:
          index: path.index
          expand_wildcards: query.expand_wildcards
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_snapshot/{repository}/{snapshot}/_mount'].post
  update:
    x-apievangelist-phrasing:
      intent: Mount a snapshot as a searchable index
      effect: write
      questions:
      - How do I make an index inside a snapshot searchable without restoring it fully?
      - Can I mount a snapshot index under a new name with shared-cache storage?
      - Why shouldn't I manually mount snapshots that ILM manages?
      instructions:
      - text: Mount index {index} from snapshot {snapshot} in repository {repository}.
        slots:
          index: requestBody.index
          snapshot: path.snapshot
          repository: path.repository
      - text: Mount {index} from {repository}/{snapshot} as {renamed_index} using storage {storage}.
        slots:
          index: requestBody.index
          repository: path.repository
          snapshot: path.snapshot
          renamed_index: requestBody.renamed_index
          storage: query.storage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_searchable_snapshots/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get searchable snapshot stats for all indices
      effect: read
      questions:
      - What are the searchable snapshot statistics across the whole cluster?
      - Can I break searchable snapshot stats down by shard or index level?
      instructions:
      - text: Show searchable snapshot statistics for every mounted index.
      - text: Report cluster-wide searchable snapshot stats at level {level}.
        slots:
          level: query.level
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_searchable_snapshots/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get searchable snapshot stats for an index
      effect: read
      questions:
      - How is one mounted searchable snapshot index performing?
      - Can I get searchable snapshot stats for a single index pattern?
      instructions:
      - text: Show searchable snapshot statistics for index {index}.
        slots:
          index: path.index
      - text: Report stats for mounted index {index} at level {level}.
        slots:
          index: path.index
          level: query.level
      method: generated
      generated: '2026-09-26'