# 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 Fleet API
  version: 1.0.0
extends: openapi/elk-stack-fleet-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['/{index}/_fleet/global_checkpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an index's global checkpoints
      effect: read
      questions:
      - What are the current global checkpoints for an index Fleet server reads from?
      - Can I wait for the global checkpoint to advance before it returns?
      instructions:
      - text: Get global checkpoints for index {index}.
        slots:
          index: path.index
      - text: Wait for checkpoints on {index} to advance past {checkpoints}, wait_for_advance {wait_for_advance}.
        slots:
          index: path.index
          checkpoints: query.checkpoints
          wait_for_advance: query.wait_for_advance
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_fleet/_fleet_msearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet multi search via GET, no index
      effect: read
      questions:
      - Can I send several Fleet searches in one GET request without naming an index in the path?
      - Is wait_for_checkpoints supported on a GET Fleet msearch at the cluster level?
      instructions:
      - text: Run a GET Fleet msearch across indices after checkpoints {wait_for_checkpoints}.
        slots:
          wait_for_checkpoints: query.wait_for_checkpoints
      - text: Send a cluster-level GET Fleet multi search, max concurrent {max_concurrent_searches}.
        slots:
          max_concurrent_searches: query.max_concurrent_searches
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_fleet/_fleet_msearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet multi search via POST, no index
      effect: read
      questions:
      - How do I POST a batch of Fleet searches without an index in the URL?
      - Can a POST Fleet msearch at cluster level allow partial results?
      instructions:
      - text: POST a cluster-level Fleet msearch with partial results {allow_partial_search_results}.
        slots:
          allow_partial_search_results: query.allow_partial_search_results
      - text: Submit several Fleet searches by POST with no default index, search type {search_type}.
        slots:
          search_type: query.search_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_fleet/_fleet_msearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet multi search via GET on an index
      effect: read
      questions:
      - Can I run several Fleet searches against one default index using GET?
      - Does an index-scoped GET Fleet msearch honor checkpoints?
      instructions:
      - text: Run a GET Fleet msearch on index {index}.
        slots:
          index: path.index
      - text: GET multiple Fleet searches on {index} waiting for checkpoints {wait_for_checkpoints}.
        slots:
          index: path.index
          wait_for_checkpoints: query.wait_for_checkpoints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_fleet/_fleet_msearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet multi search via POST on an index
      effect: read
      questions:
      - How do I POST a batch of Fleet searches against a specific index?
      - Can an index-scoped POST Fleet msearch limit concurrent shard requests?
      instructions:
      - text: POST a Fleet msearch to index {index}.
        slots:
          index: path.index
      - text: Send multiple Fleet searches by POST to {index} with shard concurrency {max_concurrent_shard_requests}.
        slots:
          index: path.index
          max_concurrent_shard_requests: query.max_concurrent_shard_requests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_fleet/_fleet_search'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet search via GET
      effect: read
      questions:
      - Can I run a GET search that only executes after a given checkpoint is visible?
      - Does the GET Fleet search accept a q query string?
      instructions:
      - text: Run a GET Fleet search on {index} for {q}.
        slots:
          index: path.index
          q: query.q
      - text: GET search {index} once checkpoints {wait_for_checkpoints} are processed.
        slots:
          index: path.index
          wait_for_checkpoints: query.wait_for_checkpoints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_fleet/_fleet_search'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a Fleet search via POST
      effect: read
      questions:
      - How do I POST a Fleet search with a Query DSL body that waits for a checkpoint?
      - Can a POST Fleet search include aggregations and sorting?
      instructions:
      - text: POST a Fleet search to {index} with query {query}.
        slots:
          index: path.index
          query: requestBody.query
      - text: Send a POST Fleet search on {index} with aggregations {aggregations} after checkpoints {wait_for_checkpoints}.
        slots:
          index: path.index
          aggregations: requestBody.aggregations
          wait_for_checkpoints: query.wait_for_checkpoints
      method: generated
      generated: '2026-09-26'