# 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 License API
  version: 1.0.0
extends: openapi/elk-stack-license-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['/_license'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the cluster license
      effect: read
      questions:
      - What type of Elastic license is my cluster running?
      - When does my current Elasticsearch license expire?
      instructions:
      - text: Show the current license details.
      - text: Get the license, reporting enterprise licenses as enterprise ({accept_enterprise}).
        slots:
          accept_enterprise: query.accept_enterprise
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license'].put
  update:
    x-apievangelist-phrasing:
      intent: Install a license with a PUT request
      effect: write
      questions:
      - Can I install a new license with PUT without restarting nodes?
      - What happens if a new license drops features I'm using?
      instructions:
      - text: Install license {license} using PUT.
        slots:
          license: requestBody.license
      - text: PUT the license {license} and acknowledge feature changes ({acknowledge}).
        slots:
          license: requestBody.license
          acknowledge: query.acknowledge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license'].post
  update:
    x-apievangelist-phrasing:
      intent: Install a license with a POST request
      effect: write
      questions:
      - Is there a POST form of the update license call?
      - Can I send several licenses in one POST update?
      instructions:
      - text: POST the licenses {licenses} to the cluster.
        slots:
          licenses: requestBody.licenses
      - text: Update the license via POST with {license}, acknowledging changes ({acknowledge}).
        slots:
          license: requestBody.license
          acknowledge: query.acknowledge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the cluster license
      effect: destructive
      questions:
      - What happens to my subscription level if I delete the license?
      - Who is allowed to remove the license when operator privileges are on?
      instructions:
      - text: Delete the cluster license.
      - text: Remove the license with a master timeout of {master_timeout}.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license/basic_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a basic license can be started
      effect: read
      questions:
      - Is my cluster eligible to start a basic license?
      - Can I switch to the free basic license right now?
      instructions:
      - text: Check the basic license eligibility status.
      - text: Tell me whether a basic license can be started.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license/trial_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a trial license can be started
      effect: read
      questions:
      - Is my cluster still eligible for a free trial?
      - Have I already used my trial for this major version?
      instructions:
      - text: Check the trial license status.
      - text: Tell me whether a trial can be started.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license/start_basic'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a basic license
      effect: write
      questions:
      - How do I move my cluster onto an indefinite basic license?
      - Do I need to acknowledge losing features when starting basic?
      instructions:
      - text: Start a basic license.
      - text: Start a basic license and acknowledge lost features ({acknowledge}).
        slots:
          acknowledge: query.acknowledge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_license/start_trial'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a 30-day trial license
      effect: write
      questions:
      - Can I start a 30-day trial of all subscription features?
      - What trial type can I request when starting a trial?
      instructions:
      - text: Start a 30-day trial.
      - text: Start a trial of type {type} and acknowledge it ({acknowledge}).
        slots:
          type: query.type
          acknowledge: query.acknowledge
      method: generated
      generated: '2026-09-26'