# 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 Search Application API
  version: 1.0.0
extends: openapi/elk-stack-search-application-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['/_application/search_application/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a search application
      effect: read
      questions:
      - Which indices and template does a particular search application use?
      - Can I look up a search application by name?
      instructions:
      - text: Show search application {name}.
        slots:
          name: path.name
      - text: Get the details of the {name} search application.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a search application
      effect: write
      questions:
      - How do I set up a search application over several indices?
      - Can I make the call fail if the search application already exists?
      instructions:
      - text: Create search application {name} over indices {indices}.
        slots:
          name: path.name
          indices: requestBody.indices
      - text: Save search application {name} on {indices} using template {template}.
        slots:
          name: path.name
          indices: requestBody.indices
          template: requestBody.template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search application
      effect: destructive
      questions:
      - Are the indices removed when I delete a search application?
      - What removes a search application and its alias?
      instructions:
      - text: Delete search application {name}.
        slots:
          name: path.name
      - text: Remove the {name} search application and its alias.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application'].get
  update:
    x-apievangelist-phrasing:
      intent: List search applications
      effect: read
      questions:
      - What search applications exist in my cluster?
      - Can I filter the search application list by name?
      instructions:
      - text: List all search applications.
      - text: List search applications matching {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application/{name}/_render_query'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a search application's query
      effect: read
      questions:
      - Can I see the Elasticsearch query a search application would generate without running it?
      - What query does my search template produce for these parameters?
      instructions:
      - text: Render the query for {name} with params {params}.
        slots:
          name: path.name
          params: requestBody.params
      - text: Show the generated query of search application {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application/{name}/_search'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a search application search
      effect: read
      questions:
      - How do I run a search through a search application's template?
      - Can search results include typed aggregation keys?
      instructions:
      - text: Search {name} with params {params}.
        slots:
          name: path.name
          params: requestBody.params
      - text: Run search application {name} with a GET request.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/search_application/{name}/_search'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a search application search via POST
      effect: read
      questions:
      - Can I run a search application query with a POST request body?
      - Which call searches a search application when I send params by POST?
      instructions:
      - text: Using POST, search {name} with params {params}.
        slots:
          name: path.name
          params: requestBody.params
      - text: POST a search to application {name} with typed keys {typed_keys}.
        slots:
          name: path.name
          typed_keys: query.typed_keys
      method: generated
      generated: '2026-09-26'