Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Uptime API

3 actions 3 updates phrasing extends openapi/elk-stack-uptime-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/uptime/settings'].get
$.paths['/api/uptime/settings'].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 Kibana Uptime API
  version: 1.0.0
extends: openapi/elk-stack-uptime-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/uptime/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get uptime monitoring settings
      effect: read
      questions:
      - What certificate expiration threshold is uptime monitoring using?
      - Which heartbeat indices and default connectors are configured for uptime?
      instructions:
      - text: Show the current uptime settings.
      - text: Get the heartbeat indices and alert defaults for uptime.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/uptime/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update uptime monitoring settings
      effect: write
      questions:
      - How do I get warned earlier before TLS certificates expire?
      - Can I change the default email and connectors used for uptime alerts?
      instructions:
      - text: Set the uptime certificate expiration threshold to {certExpirationThreshold} days.
        slots:
          certExpirationThreshold: requestBody.certExpirationThreshold
      - text: Point uptime at heartbeat indices {heartbeatIndices}.
        slots:
          heartbeatIndices: requestBody.heartbeatIndices
      - text: Use connectors {defaultConnectors} and email {defaultEmail} as the uptime alert defaults.
        slots:
          defaultConnectors: requestBody.defaultConnectors
          defaultEmail: requestBody.defaultEmail
      method: generated
      generated: '2026-09-26'