Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Features API

3 actions 3 updates phrasing extends openapi/elk-stack-features-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 3

$.info
$.paths['/_features'].get
$.paths['/_features/_reset'].post

OpenAPI Overlay

Raw ↑
# 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 Features API
  version: 1.0.0
extends: openapi/elk-stack-features-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: 2
- target: $.paths['/_features'].get
  update:
    x-apievangelist-phrasing:
      intent: List features that can be snapshotted
      effect: read
      questions:
      - Which feature states can I include in a snapshot?
      - What system features does my cluster have for feature_states?
      instructions:
      - text: List the features available for snapshot feature states.
      - text: Show snapshot-able features, waiting up to {master_timeout} for the master node.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_features/_reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset all feature system indices
      effect: destructive
      questions:
      - How do I wipe the state stored in system indices on a test cluster?
      - Is resetting features safe to run in production?
      instructions:
      - text: Reset all feature states and clear their system indices on this dev cluster.
      - text: Clear system index state for every feature with master timeout {master_timeout}.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'