# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elk Stack Logstash API
  version: 1.0.0
extends: openapi/elk-stack-logstash-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: 8
- target: $.paths['/_logstash/pipeline/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Logstash pipeline from Elasticsearch
      effect: read
      questions:
      - Can I read a centrally managed Logstash pipeline straight from the Elasticsearch _logstash API?
      - What config and settings does a given pipeline have in Elasticsearch central management?
      instructions:
      - text: Get Logstash pipeline {id} from the Elasticsearch _logstash endpoint.
        slots:
          id: path.id
      - text: Fetch pipelines {id} through Elasticsearch, not Kibana.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_logstash/pipeline/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a Logstash pipeline in Elasticsearch
      effect: write
      questions:
      - What fields does the Elasticsearch _logstash API require to save a pipeline, like username and last_modified?
      - Will writing a pipeline through Elasticsearch replace one with the same ID?
      instructions:
      - text: Save Logstash pipeline {id} in Elasticsearch with config {pipeline}, edited by {username}.
        slots:
          id: path.id
          pipeline: requestBody.pipeline
          username: requestBody.username
      - text: Replace pipeline {id} via the _logstash API with settings {pipeline_settings}.
        slots:
          id: path.id
          pipeline_settings: requestBody.pipeline_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_logstash/pipeline/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Logstash pipeline from Elasticsearch
      effect: destructive
      questions:
      - Can I delete a centrally managed pipeline directly through the Elasticsearch _logstash API?
      - What does Elasticsearch return after it removes a Logstash pipeline?
      instructions:
      - text: Delete Logstash pipeline {id} through the Elasticsearch _logstash API.
        slots:
          id: path.id
      - text: Remove pipeline {id} from Elasticsearch central management storage.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_logstash/pipeline'].get
  update:
    x-apievangelist-phrasing:
      intent: List Logstash pipelines in Elasticsearch
      effect: read
      questions:
      - Which Logstash pipelines are stored in Elasticsearch for central management?
      - Can I get every centrally managed pipeline from the _logstash API in one call?
      instructions:
      - text: List all Logstash pipelines stored in Elasticsearch.
      - text: Get every pipeline from the Elasticsearch _logstash endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/logstash/pipeline/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Logstash pipeline from Kibana
      effect: read
      questions:
      - How do I view a centrally managed Logstash pipeline through the Kibana API?
      - What role do I need to read a pipeline in Kibana's Logstash management?
      instructions:
      - text: Show Logstash pipeline {id} from Kibana.
        slots:
          id: path.id
      - text: Get the Kibana-managed pipeline {id} and its settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/logstash/pipeline/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Logstash pipeline in Kibana
      effect: write
      questions:
      - How do I create a centrally managed Logstash pipeline from Kibana?
      - Can I change the batch size or workers of a pipeline through Kibana's settings field?
      instructions:
      - text: Create or update Kibana pipeline {id} with config {pipeline}.
        slots:
          id: path.id
          pipeline: requestBody.pipeline
      - text: Set Kibana Logstash pipeline {id} to settings {settings} and description {description}.
        slots:
          id: path.id
          settings: requestBody.settings
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/logstash/pipeline/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Logstash pipeline in Kibana
      effect: destructive
      questions:
      - How do I remove a centrally managed pipeline using Kibana?
      - Which Kibana role lets me delete a Logstash pipeline?
      instructions:
      - text: Delete Logstash pipeline {id} via Kibana.
        slots:
          id: path.id
      - text: Remove the Kibana-managed pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/logstash/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Logstash pipelines in Kibana
      effect: read
      questions:
      - What Logstash pipelines does Kibana central management know about?
      - Is there a limit to how many pipelines I should keep before listing slows down?
      instructions:
      - text: List all Logstash pipelines managed in Kibana.
      - text: Show every centrally managed pipeline from the Kibana API.
      method: generated
      generated: '2026-09-26'