Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Telemetry API

3 actions 3 updates phrasing extends openapi/elk-stack-telemetry-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['/phone-home/config'].get
$.paths['/phone-home/config'].put

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 Elastic Cloud Enterprise Telemetry API
  version: 1.0.0
extends: openapi/elk-stack-telemetry-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['/phone-home/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether ECE telemetry is enabled
      effect: read
      questions:
      - Is my Elastic Cloud Enterprise installation sending telemetry?
      - What is the current phone-home telemetry setting?
      instructions:
      - text: Show the ECE telemetry setting.
      - text: Check if phone-home telemetry is on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/phone-home/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn ECE telemetry on or off
      effect: write
      questions:
      - Can I opt out of ECE telemetry?
      - How is phone-home telemetry re-enabled?
      instructions:
      - text: Set ECE telemetry enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Turn phone-home telemetry {enabled}.
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'