# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elk Stack Cat API
  version: 1.0.0
extends: openapi/elk-stack-cat-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: 47
- target: $.paths['/_cat/aliases'].get
  update:
    x-apievangelist-phrasing:
      intent: List all index aliases in the cluster
      effect: read
      questions:
      - What index aliases exist across my Elasticsearch cluster?
      - Can I see the filter and routing settings for every alias at once?
      - Does the cat aliases listing include data stream aliases?
      instructions:
      - text: Show me every index alias in the cluster as a table.
      - text: List all aliases sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/aliases/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show details for specific index aliases
      effect: read
      questions:
      - Which indices does a particular alias point to?
      - How can I check the routing and filter of one named alias?
      instructions:
      - text: Show the alias {alias_name} and the indices behind it.
        slots:
          alias_name: path.name
      - text: Display only the columns {columns} for aliases matching {alias_name}.
        slots:
          columns: query.h
          alias_name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/allocation'].get
  update:
    x-apievangelist-phrasing:
      intent: Show shard allocation and disk use per node
      effect: read
      questions:
      - How many shards are allocated to each data node right now?
      - Which nodes are running low on disk space for shards?
      instructions:
      - text: Show shard counts and disk usage for all data nodes.
      - text: List shard allocation across nodes sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/allocation/{node_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show shard allocation for specific nodes
      effect: read
      questions:
      - How much disk does one particular node use for its shards?
      - Can I check shard allocation for just a single data node?
      instructions:
      - text: Show shard allocation and disk space for node {node_id}.
        slots:
          node_id: path.node_id
      - text: Report the shard count on nodes {node_id} using the local cluster state.
        slots:
          node_id: path.node_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/circuit_breaker'].get
  update:
    x-apievangelist-phrasing:
      intent: Show circuit breaker statistics
      effect: read
      questions:
      - Are any circuit breakers tripping in my cluster?
      - What memory limits are the circuit breakers enforcing on each node?
      instructions:
      - text: Show circuit breaker stats for every node.
      - text: List all circuit breakers with columns {columns}.
        slots:
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/circuit_breaker/{circuit_breaker_patterns}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show stats for matching circuit breakers
      effect: read
      questions:
      - Can I look at only the request or fielddata circuit breaker?
      - How often has a specific circuit breaker tripped?
      instructions:
      - text: Show statistics for circuit breakers matching {patterns}.
        slots:
          patterns: path.circuit_breaker_patterns
      - text: Check the trip count of the {patterns} breaker.
        slots:
          patterns: path.circuit_breaker_patterns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/component_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List component templates in the cluster
      effect: read
      questions:
      - Which component templates are defined in my cluster?
      - What reusable building blocks exist for my index templates?
      instructions:
      - text: List all component templates.
      - text: Show component templates sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/component_templates/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show component templates matching a name
      effect: read
      questions:
      - Is there a component template with a particular name?
      - Can I filter component templates by a name pattern?
      instructions:
      - text: Show the component template {template_name}.
        slots:
          template_name: path.name
      - text: List component templates whose names match {template_name}.
        slots:
          template_name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count documents across the whole cluster
      effect: read
      questions:
      - How many live documents are stored in my entire cluster?
      - Does the cluster-wide document count include deleted documents?
      instructions:
      - text: Give me the total document count for the cluster.
      - text: Count every document in the cluster and show columns {columns}.
        slots:
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count cluster documents via a POST request
      effect: read
      questions:
      - Can I fetch the cluster-wide document count with a POST instead of a GET?
      - Is there a POST form of the cat count call for the whole cluster?
      instructions:
      - text: Send a POST to cat count to get the cluster's total documents.
      - text: Use the POST cat count call for all indices, showing columns {columns}.
        slots:
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/count/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Count documents in specific indices
      effect: read
      questions:
      - How many documents are in one particular index or data stream?
      - Can I get a quick document count for a set of indices?
      instructions:
      - text: Count the documents in index {index}.
        slots:
          index: path.index
      - text: Show the live document count for data stream {index}.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/count/{index}'].post
  update:
    x-apievangelist-phrasing:
      intent: Count index documents via a POST request
      effect: read
      questions:
      - Is there a POST variant for counting documents in a named index?
      - Can I count one index's documents with POST when GET is blocked?
      instructions:
      - text: Use a POST request to count documents in {index}.
        slots:
          index: path.index
      - text: Send the POST cat count for index {index} with columns {columns}.
        slots:
          index: path.index
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/fielddata'].get
  update:
    x-apievangelist-phrasing:
      intent: Show field data cache memory per node
      effect: read
      questions:
      - How much heap is the field data cache using on each node?
      - Which fields are consuming the most fielddata memory?
      instructions:
      - text: Show field data cache usage across all data nodes.
      - text: Report fielddata heap usage for the fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/fielddata/{fields}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show field data cache for named fields
      effect: read
      questions:
      - How much fielddata memory does a single field take?
      - Can I check the fielddata cache for only a few specific fields?
      instructions:
      - text: Show fielddata memory used by field {fields}.
        slots:
          fields: path.fields
      - text: Report heap used by fielddata for {fields}, sorted by {sort_columns}.
        slots:
          fields: path.fields
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check cluster health status
      effect: read
      questions:
      - Is my Elasticsearch cluster green, yellow or red?
      - Can I see cluster health without the timestamp columns?
      instructions:
      - text: Show the cluster health status.
      - text: Check cluster health and include timestamps set to {ts}.
        slots:
          ts: query.ts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat'].get
  update:
    x-apievangelist-phrasing:
      intent: Show help for the CAT APIs
      effect: read
      questions:
      - What cat endpoints are available to call?
      - Where can I find a list of all the compact cat commands?
      instructions:
      - text: Show the cat API help listing.
      - text: List every available cat endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/indices'].get
  update:
    x-apievangelist-phrasing:
      intent: List all indices with health and size
      effect: read
      questions:
      - Which indices in my cluster are in red or yellow health?
      - How many documents and how much storage does each index use?
      - Can I list only the primary shard sizes for my indices?
      instructions:
      - text: List every index with its health, doc count and size.
      - text: Show all indices with health status {health}.
        slots:
          health: query.health
      - text: List indices sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/indices/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show information for specific indices
      effect: read
      questions:
      - What is the document count and store size of a specific index?
      - Is one particular index healthy?
      instructions:
      - text: Show health, docs and size for index {index}.
        slots:
          index: path.index
      - text: Show index {index} with primary-shard stats only set to {pri}.
        slots:
          index: path.index
          pri: query.pri
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/master'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the elected master node
      effect: read
      questions:
      - Which node is currently the elected master?
      - What is the IP address of my cluster's master node?
      instructions:
      - text: Tell me which node is the master.
      - text: Show the master node's ID, host and IP.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/data_frame/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: List data frame analytics jobs
      effect: read
      questions:
      - What data frame analytics jobs are configured in my cluster?
      - Which of my data frame analytics jobs are running or stopped?
      instructions:
      - text: List all data frame analytics jobs.
      - text: Show data frame analytics jobs sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/data_frame/analytics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a specific data frame analytics job
      effect: read
      questions:
      - What is the state of one particular data frame analytics job?
      - Can I check the memory usage of a single analytics job?
      instructions:
      - text: Show the data frame analytics job {job_id}.
        slots:
          job_id: path.id
      - text: Display columns {columns} for analytics job {job_id}.
        slots:
          columns: query.h
          job_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/datafeeds'].get
  update:
    x-apievangelist-phrasing:
      intent: List machine learning datafeeds
      effect: read
      questions:
      - Which machine learning datafeeds exist and what state are they in?
      - Is there a cap on how many datafeeds the cat listing returns?
      instructions:
      - text: List all ML datafeeds.
      - text: Show datafeeds sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/datafeeds/{datafeed_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a specific machine learning datafeed
      effect: read
      questions:
      - Is a particular datafeed started or stopped?
      - How many searches has one datafeed run?
      instructions:
      - text: Show the datafeed {datafeed_id}.
        slots:
          datafeed_id: path.datafeed_id
      - text: Check the state of datafeed {datafeed_id} without failing if it's missing ({allow_no_match}).
        slots:
          datafeed_id: path.datafeed_id
          allow_no_match: query.allow_no_match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/anomaly_detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List anomaly detection jobs
      effect: read
      questions:
      - What anomaly detection jobs are configured in my cluster?
      - Which anomaly detection jobs are open and processing data?
      instructions:
      - text: List all anomaly detection jobs.
      - text: Show anomaly detection jobs sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/anomaly_detectors/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a specific anomaly detection job
      effect: read
      questions:
      - How much memory is a particular anomaly detection job using?
      - What state is one anomaly detection job in?
      instructions:
      - text: Show anomaly detection job {job_id}.
        slots:
          job_id: path.job_id
      - text: Display columns {columns} for anomaly job {job_id}.
        slots:
          columns: query.h
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/trained_models'].get
  update:
    x-apievangelist-phrasing:
      intent: List trained models
      effect: read
      questions:
      - Which trained inference models are deployed in my cluster?
      - Can I page through trained models in a compact table?
      instructions:
      - text: List all trained models.
      - text: Show {size} trained models starting at {from}.
        slots:
          size: query.size
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/ml/trained_models/{model_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a specific trained model
      effect: read
      questions:
      - What is the configuration of one particular trained model?
      - How heavily is a single trained model being used?
      instructions:
      - text: Show trained model {model_id}.
        slots:
          model_id: path.model_id
      - text: Display columns {columns} for trained model {model_id}.
        slots:
          columns: query.h
          model_id: path.model_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/nodeattrs'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom node attributes
      effect: read
      questions:
      - What custom attributes are set on my cluster's nodes?
      - Which nodes are tagged with a hot or warm attribute?
      instructions:
      - text: List custom attributes on every node.
      - text: Show node attributes sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/nodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List cluster nodes and their resources
      effect: read
      questions:
      - Which nodes are in my cluster and what roles do they have?
      - How much heap and CPU is each node using?
      instructions:
      - text: List all nodes in the cluster.
      - text: Show nodes with full node IDs set to {full_id}.
        slots:
          full_id: query.full_id
      - text: List nodes showing only the columns {columns}.
        slots:
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/pending_tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending cluster-level tasks
      effect: read
      questions:
      - Are there cluster state changes waiting to be applied?
      - Why is my cluster slow to apply mapping updates?
      instructions:
      - text: Show pending cluster tasks.
      - text: List pending tasks sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins installed on each node
      effect: read
      questions:
      - Which plugins are running on each node of my cluster?
      - Can I include bootstrap plugins in the plugin list?
      instructions:
      - text: List the plugins on every node.
      - text: 'Show plugins including bootstrap ones: {include_bootstrap}.'
        slots:
          include_bootstrap: query.include_bootstrap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/recovery'].get
  update:
    x-apievangelist-phrasing:
      intent: List shard recoveries across the cluster
      effect: read
      questions:
      - Which shards are currently recovering or relocating?
      - Can I see only active shard recoveries?
      instructions:
      - text: Show all shard recoveries in the cluster.
      - text: 'Show only active recoveries: {active_only}.'
        slots:
          active_only: query.active_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/recovery/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show shard recoveries for specific indices
      effect: read
      questions:
      - How is the shard recovery going for one particular index?
      - Is a replica of a specific index still syncing?
      instructions:
      - text: Show shard recovery progress for index {index}.
        slots:
          index: path.index
      - text: Show detailed recovery info for {index}.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshot repositories
      effect: read
      questions:
      - Which snapshot repositories are registered in my cluster?
      - What type of storage does each snapshot repository use?
      instructions:
      - text: List all snapshot repositories.
      - text: Show snapshot repositories sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Lucene segments across all indices
      effect: read
      questions:
      - How many Lucene segments do my indices have?
      - Could too many small segments be slowing my searches?
      instructions:
      - text: Show segment information for all indices.
      - text: List segments across indices sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/segments/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show Lucene segments for specific indices
      effect: read
      questions:
      - How many segments does one index have after a force merge?
      - What is the segment size breakdown for a particular data stream?
      instructions:
      - text: Show segments for index {index}.
        slots:
          index: path.index
      - text: List segments of {index}, ignoring unavailable indices ({ignore_unavailable}).
        slots:
          index: path.index
          ignore_unavailable: query.ignore_unavailable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/shards'].get
  update:
    x-apievangelist-phrasing:
      intent: List all shards in the cluster
      effect: read
      questions:
      - Which shards are unassigned in my cluster?
      - Where is each primary and replica shard located?
      instructions:
      - text: List every shard with its state and node.
      - text: Show all shards sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/shards/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show shards for specific indices
      effect: read
      questions:
      - On which nodes do the shards of one index live?
      - Are any shards of a particular index unassigned?
      instructions:
      - text: Show the shards of index {index}.
        slots:
          index: path.index
      - text: List shards for {index} with columns {columns}.
        slots:
          index: path.index
          columns: query.h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots in all repositories
      effect: read
      questions:
      - What snapshots have been taken of my cluster?
      - When did my most recent snapshot succeed?
      instructions:
      - text: List all snapshots across repositories.
      - text: Show snapshots sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/snapshots/{repository}'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots in a specific repository
      effect: read
      questions:
      - Which backups are stored in one particular snapshot repository?
      - Did any snapshots in a given repository fail?
      instructions:
      - text: List snapshots in repository {repository}.
        slots:
          repository: path.repository
      - text: Show snapshots from {repository} ignoring unavailable ones ({ignore_unavailable}).
        slots:
          repository: path.repository
          ignore_unavailable: query.ignore_unavailable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks running in the cluster
      effect: read
      questions:
      - What tasks are running on my cluster right now?
      - Can I filter running tasks by action type or node?
      instructions:
      - text: List all currently running tasks.
      - text: Show running tasks for actions {actions}.
        slots:
          actions: query.actions
      - text: List tasks on nodes {nodes} with detailed output.
        slots:
          nodes: query.nodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List index templates
      effect: read
      questions:
      - Which index templates are defined in my cluster?
      - What index patterns do my index templates apply to?
      instructions:
      - text: List all index templates.
      - text: Show index templates sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/templates/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show index templates matching a name
      effect: read
      questions:
      - Does an index template with a certain name exist?
      - What priority and patterns does a specific index template have?
      instructions:
      - text: Show the index template {template_name}.
        slots:
          template_name: path.name
      - text: List index templates matching {template_name}.
        slots:
          template_name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/thread_pool'].get
  update:
    x-apievangelist-phrasing:
      intent: Show thread pool statistics per node
      effect: read
      questions:
      - Are any thread pools rejecting requests on my nodes?
      - How busy are the search and write thread pools?
      instructions:
      - text: Show thread pool stats for all nodes.
      - text: List thread pools sorted by {sort_columns}.
        slots:
          sort_columns: query.s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/thread_pool/{thread_pool_patterns}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show stats for specific thread pools
      effect: read
      questions:
      - How many queued tasks does the write thread pool have?
      - Can I watch just the search thread pool for rejections?
      instructions:
      - text: Show thread pool stats for {pools}.
        slots:
          pools: path.thread_pool_patterns
      - text: Check active, queued and rejected counts for the {pools} pool.
        slots:
          pools: path.thread_pool_patterns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/transforms'].get
  update:
    x-apievangelist-phrasing:
      intent: List transforms
      effect: read
      questions:
      - Which transforms are configured in my cluster?
      - Can I page through my transforms in a compact table?
      instructions:
      - text: List all transforms.
      - text: Show {size} transforms starting at {from}.
        slots:
          size: query.size
          from: query.from
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_cat/transforms/{transform_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a specific transform
      effect: read
      questions:
      - Is a particular transform started, stopped or failed?
      - How many documents has one transform processed?
      instructions:
      - text: Show transform {transform_id}.
        slots:
          transform_id: path.transform_id
      - text: Display columns {columns} for transform {transform_id}.
        slots:
          columns: query.h
          transform_id: path.transform_id
      method: generated
      generated: '2026-09-26'