Elastic Stack · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/elk-stack-xpack-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['/_xpack'].get

$.paths['/_xpack/usage'].get

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 Elasticsearch Request & Response Specification Xpack API
  version: 1.0.0
extends: openapi/elk-stack-xpack-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['/_xpack'].get
  update:
    x-apievangelist-phrasing:
      intent: Get build, license and feature info
      effect: read
      questions:
      - Which license is installed on my cluster and which features does it enable?
      - Can I get the build number and timestamp of my Elasticsearch cluster?
      instructions:
      - text: Show the cluster's build, license and available features.
      - text: Get cluster info limited to the categories {categories}.
        slots:
          categories: query.categories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_xpack/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get feature usage statistics
      effect: read
      questions:
      - How much are the licensed features on my cluster actually being used?
      - What usage statistics are available for enabled features?
      instructions:
      - text: Show usage statistics for the enabled features.
      - text: Get feature usage stats with a master timeout of {master_timeout}.
        slots:
          master_timeout: query.master_timeout
      method: generated
      generated: '2026-09-26'