Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Health Report API

3 actions 3 updates phrasing extends openapi/elk-stack-health-report-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['/_health_report'].get
$.paths['/_health_report/{feature}'].get

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 Health Report API
  version: 1.0.0
extends: openapi/elk-stack-health-report-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['/_health_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full cluster health report
      effect: read
      questions:
      - Is my Elasticsearch cluster healthy, and which indicators are yellow or red?
      - Can I get a quick health summary without the verbose diagnosis details?
      instructions:
      - text: Get the health report for all indicators on my cluster.
      - text: Show cluster health across every indicator with verbose {verbose}.
        slots:
          verbose: query.verbose
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_health_report/{feature}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the health of one cluster feature
      effect: read
      questions:
      - How do I check the health of just one area, like shard availability or disk?
      - Can I see the root cause and impacts for a single health indicator?
      instructions:
      - text: Get the health report for indicator {feature}.
        slots:
          feature: path.feature
      - text: Diagnose feature {feature}, returning up to {size} affected resources.
        slots:
          feature: path.feature
          size: query.size
      method: generated
      generated: '2026-09-26'