Elastic Stack · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/'].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 Info API
  version: 1.0.0
extends: openapi/elk-stack-info-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: 1
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster build and version info
      effect: read
      questions:
      - What version of Elasticsearch is my cluster running?
      - How can I see the cluster name, UUID and build details of my Elasticsearch deployment?
      - Does the root endpoint report the real version number on Serverless projects?
      instructions:
      - text: Tell me which Elasticsearch version and build my cluster is on.
      - text: 'Fetch the basic cluster info: name, cluster UUID and Lucene version.'
      method: generated
      generated: '2026-09-26'