# 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 Eql API
  version: 1.0.0
extends: openapi/elk-stack-eql-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: 5
- target: $.paths['/_eql/search/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of an async EQL search
      effect: read
      questions:
      - How do I fetch the results of an EQL search that ran asynchronously?
      - Can I wait a little longer for an async EQL search to finish when fetching it?
      instructions:
      - text: Get the results of async EQL search {id}.
        slots:
          id: path.id
      - text: Fetch EQL search {id}, waiting up to {wait_for_completion_timeout} for completion.
        slots:
          id: path.id
          wait_for_completion_timeout: query.wait_for_completion_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_eql/search/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an async EQL search and its results
      effect: destructive
      questions:
      - How do I cancel and clean up an async EQL search?
      - Does deleting a stored EQL search also remove its results?
      instructions:
      - text: Delete async EQL search {id}.
        slots:
          id: path.id
      - text: Cancel EQL search {id} and discard its stored results.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_eql/search/status/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an async EQL search
      effect: read
      questions:
      - Is my async EQL search still running?
      - Can I check an EQL search's progress without downloading its hits?
      instructions:
      - text: Check the status of EQL search {id}.
        slots:
          id: path.id
      - text: Tell me whether EQL search {id} has completed, without results.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_eql/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an EQL query (GET)
      effect: read
      questions:
      - How do I run an Event Query Language query over an index with a GET request?
      - Can a GET EQL search return partial results if some shards fail?
      instructions:
      - text: Run the EQL query {query} against {index} using a GET request.
        slots:
          query: requestBody.query
          index: path.index
      - text: Using GET, search {index} with EQL {query} and return {size} matches.
        slots:
          index: path.index
          query: requestBody.query
          size: requestBody.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_eql/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an EQL query (POST)
      effect: read
      questions:
      - What is the POST form of an EQL search for detecting event sequences?
      - Can I POST an EQL search that keeps its results for later retrieval?
      instructions:
      - text: POST the EQL query {query} to {index}.
        slots:
          query: requestBody.query
          index: path.index
      - text: 'With a POST, search {index} for sequence {query} and keep results on completion: {keep_on_completion}.'
        slots:
          index: path.index
          query: requestBody.query
          keep_on_completion: requestBody.keep_on_completion
      method: generated
      generated: '2026-09-26'