# 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 Slm API
  version: 1.0.0
extends: openapi/elk-stack-slm-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: 10
- target: $.paths['/_slm/policy/{policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a snapshot lifecycle policy
      effect: read
      questions:
      - When did my nightly snapshot policy last succeed or fail?
      - What schedule and repository does a particular snapshot policy use?
      instructions:
      - text: Get snapshot lifecycle policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Show the latest snapshot attempts for policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/policy/{policy_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a snapshot policy
      effect: write
      questions:
      - How do I schedule automatic nightly snapshots of my cluster?
      - Can I set a retention rule so old snapshots get cleaned up automatically?
      instructions:
      - text: Create snapshot policy {policy_id} on schedule {schedule} into repository {repository}.
        slots:
          policy_id: path.policy_id
          schedule: requestBody.schedule
          repository: requestBody.repository
      - text: Update policy {policy_id} to name snapshots {name} and apply retention {retention}.
        slots:
          policy_id: path.policy_id
          name: requestBody.name
          retention: requestBody.retention
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/policy/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a snapshot lifecycle policy
      effect: destructive
      questions:
      - How do I stop a snapshot policy from taking any more snapshots?
      - Does deleting a snapshot policy remove the snapshots it already took?
      instructions:
      - text: Delete snapshot policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Remove the SLM policy {policy_id} but keep existing snapshots.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/policy/{policy_id}/_execute'].put
  update:
    x-apievangelist-phrasing:
      intent: Take a snapshot now using a policy
      effect: write
      questions:
      - Can I take a snapshot immediately before an upgrade instead of waiting for the schedule?
      - How do I manually trigger a snapshot policy?
      instructions:
      - text: Run snapshot policy {policy_id} now.
        slots:
          policy_id: path.policy_id
      - text: Take an immediate snapshot using policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/_execute_retention'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete expired snapshots now
      effect: destructive
      questions:
      - How do I force snapshot retention to run and delete expired snapshots right away?
      - Can I clean up old snapshots without waiting for the retention schedule?
      instructions:
      - text: Run snapshot retention now to remove expired snapshots.
      - text: Apply SLM retention rules immediately with a timeout of {timeout}.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: List all snapshot lifecycle policies
      effect: read
      questions:
      - What snapshot policies are set up in my cluster?
      - Which of my snapshot policies had failures recently?
      instructions:
      - text: List every snapshot lifecycle policy.
      - text: Show all SLM policies with their last success and failure.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get snapshot lifecycle statistics
      effect: read
      questions:
      - How many snapshots has SLM taken, failed or deleted in total?
      - What are the per-policy snapshot counts?
      instructions:
      - text: Get snapshot lifecycle management statistics.
      - text: Show snapshots taken and failed per SLM policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether snapshot lifecycle is running
      effect: read
      questions:
      - Is snapshot lifecycle management running or stopped?
      - Did someone stop SLM on this cluster?
      instructions:
      - text: Check the SLM operating mode.
      - text: Tell me if snapshot lifecycle management is running.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start snapshot lifecycle management
      effect: write
      questions:
      - How do I restart SLM after it was stopped for maintenance?
      - Do I need to start snapshot lifecycle management manually?
      instructions:
      - text: Start snapshot lifecycle management.
      - text: Resume SLM with a master timeout of {master_timeout}.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_slm/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop snapshot lifecycle management
      effect: write
      questions:
      - How do I pause all scheduled snapshots during cluster maintenance?
      - Does stopping SLM cancel snapshots that are already in progress?
      instructions:
      - text: Stop snapshot lifecycle management.
      - text: Halt all SLM operations with a timeout of {timeout}.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'