# 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 Analytics API
  version: 1.0.0
extends: openapi/elk-stack-analytics-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['/_application/analytics/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a named behavioral analytics collection
      effect: read
      questions:
      - How do I look up one behavioral analytics collection by name?
      - Does a specific analytics collection exist for my search application?
      instructions:
      - text: Get the behavioral analytics collection named {name}.
        slots:
          name: path.name
      - text: Show analytics collection {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/analytics/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a behavioral analytics collection
      effect: write
      questions:
      - How do I start tracking search behavior with a new analytics collection?
      - Can I create an analytics collection for my search application?
      instructions:
      - text: Create behavioral analytics collection {name}.
        slots:
          name: path.name
      - text: Set up a new analytics collection called {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/analytics/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a behavioral analytics collection
      effect: destructive
      questions:
      - Does deleting an analytics collection also delete its data stream?
      - What's the way to remove a behavioral analytics collection?
      instructions:
      - text: Delete analytics collection {name} and its data stream.
        slots:
          name: path.name
      - text: Remove behavioral analytics collection {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: List all behavioral analytics collections
      effect: read
      questions:
      - Which behavioral analytics collections exist on my cluster?
      - Can I see every analytics collection at once?
      instructions:
      - text: List all behavioral analytics collections.
      - text: Show every analytics collection I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_application/analytics/{collection_name}/event/{event_type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a search behavior event
      effect: write
      questions:
      - How do I send a search or click event into an analytics collection?
      - Can I get debug output back when posting an analytics event?
      instructions:
      - text: Post a {event_type} event to analytics collection {collection_name}.
        slots:
          event_type: path.event_type
          collection_name: path.collection_name
      - text: Record a {event_type} event in {collection_name} with debug {debug}.
        slots:
          event_type: path.event_type
          collection_name: path.collection_name
          debug: query.debug
      method: generated
      generated: '2026-09-26'