Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Stack API

7 actions 7 updates phrasing extends openapi/elk-stack-stack-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/stack/instance-types'].get

$.paths['/stack/versions'].get

$.paths['/stack/versions'].post

$.paths['/stack/versions/{version}'].get

$.paths['/stack/versions/{version}'].put

$.paths['/stack/versions/{version}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elastic Cloud Enterprise Stack API
  version: 1.0.0
extends: openapi/elk-stack-stack-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: 6
- target: $.paths['/stack/instance-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List instance types (deprecated)
      effect: read
      questions:
      - Which instance types are available for deployments?
      - Is the instance types listing going away in a future release?
      instructions:
      - text: List all instance types.
      - text: Show the deprecated instance types catalog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stack/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available Elastic Stack versions
      effect: read
      questions:
      - Which Elastic Stack versions can I deploy?
      - Can I include deleted or unusable stack versions in the list?
      instructions:
      - text: List available Elastic Stack versions.
      - text: Show all stack versions including deleted ones with show_deleted {show_deleted}.
        slots:
          show_deleted: query.show_deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stack/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an Elastic Stack pack
      effect: write
      questions:
      - How do I upload a new stack pack so a version becomes available?
      - Can I send a stack pack as a zip file?
      instructions:
      - text: Upload stack pack {file}.
        slots:
          file: requestBody.file
      - text: Create or update a stack version from zip {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stack/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Elastic Stack version
      effect: read
      questions:
      - How do I see the template and details of one stack version?
      - What does the configuration for a specific Elastic Stack version contain?
      instructions:
      - text: Get Elastic Stack version {version}.
        slots:
          version: path.version
      - text: Show the template for stack version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stack/versions/{version}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Elastic Stack version configuration
      effect: write
      questions:
      - How do I change the Elasticsearch and Kibana settings of a stack version?
      - Can I restore a stack version that was marked deleted?
      instructions:
      - text: Update stack version {version} with Elasticsearch config {elasticsearch} and Kibana config {kibana}.
        slots:
          version: path.version
          elasticsearch: requestBody.elasticsearch
          kibana: requestBody.kibana
      - text: Set rolling upgrade compatible versions {rolling_upgrade_compatible_versions} on {version}.
        slots:
          rolling_upgrade_compatible_versions: requestBody.rolling_upgrade_compatible_versions
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stack/versions/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an Elastic Stack version from the list
      effect: destructive
      questions:
      - How do I hide a stack version from the available versions?
      - Is deleting a stack version permanent, or just a flag?
      instructions:
      - text: Delete stack version {version}.
        slots:
          version: path.version
      - text: Mark Elastic Stack version {version} as deleted.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'