Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana System API

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

$.paths['/api/status'].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 Kibana System API
  version: 1.0.0
extends: openapi/elk-stack-system-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['/api/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kibana features
      effect: read
      questions:
      - Which Kibana features can I grant or hide in spaces and roles?
      - How do I get the list of all Kibana features?
      instructions:
      - text: List all Kibana features.
      - text: Show the features available for space and role privileges.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Kibana's health status
      effect: read
      questions:
      - Is Kibana up and healthy right now?
      - Can I use Kibana's status for a Kubernetes readiness probe?
      - What is the status of Elasticsearch and plugins as Kibana sees them?
      instructions:
      - text: Check Kibana's current status.
      - text: Get Kibana's status in v8 format set to {v8format}.
        slots:
          v8format: query.v8format
      method: generated
      generated: '2026-09-26'