# 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 Enrich API
  version: 1.0.0
extends: openapi/elk-stack-enrich-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: 6
- target: $.paths['/_enrich/policy/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an enrich policy by name
      effect: read
      questions:
      - What match fields and source indices does a particular enrich policy use?
      - Can I look up one enrich policy by its name?
      instructions:
      - text: Show the enrich policy named {name}.
        slots:
          name: path.name
      - text: Get the definition of enrich policy {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_enrich/policy/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an enrich policy
      effect: write
      questions:
      - How do I create an enrich policy to add lookup data to incoming documents?
      - Can an enrich policy match on geo shapes or ranges instead of exact values?
      instructions:
      - text: Create enrich policy {name} with the match definition {match}.
        slots:
          name: path.name
          match: requestBody.match
      - text: Define a geo_match enrich policy called {name} using {geo_match}.
        slots:
          name: path.name
          geo_match: requestBody.geo_match
      - text: Create range enrich policy {name} from {range}.
        slots:
          name: path.name
          range: requestBody.range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_enrich/policy/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an enrich policy and its index
      effect: destructive
      questions:
      - How do I remove an enrich policy I no longer use?
      - Does deleting an enrich policy also remove its enrich index?
      instructions:
      - text: Delete enrich policy {name}.
        slots:
          name: path.name
      - text: Remove enrich policy {name} along with its enrich index.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_enrich/policy/{name}/_execute'].put
  update:
    x-apievangelist-phrasing:
      intent: Run an enrich policy to build its index
      effect: write
      questions:
      - How do I build or refresh the enrich index after creating an enrich policy?
      - Can I run an enrich policy without waiting for it to finish?
      instructions:
      - text: Execute enrich policy {name}.
        slots:
          name: path.name
      - text: Run enrich policy {name} with wait for completion set to {wait_for_completion}.
        slots:
          name: path.name
          wait_for_completion: query.wait_for_completion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_enrich/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: List all enrich policies
      effect: read
      questions:
      - Which enrich policies exist on my cluster?
      - Can I see every enrich policy in one call?
      instructions:
      - text: List all enrich policies.
      - text: Show every enrich policy, waiting up to {master_timeout} for the master.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_enrich/_stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get enrich coordinator stats
      effect: read
      questions:
      - Which enrich policies are executing right now?
      - What statistics do the enrich coordinators report?
      instructions:
      - text: Show enrich coordinator statistics.
      - text: Get enrich stats including currently executing policies.
      method: generated
      generated: '2026-09-26'