Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana APM annotations API

3 actions 3 updates phrasing extends openapi/elk-stack-apm-annotations-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/apm/services/{serviceName}/annotation'].post

$.paths['/api/apm/services/{serviceName}/annotation/search'].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 APM annotations API
  version: 1.0.0
extends: openapi/elk-stack-apm-annotations-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/apm/services/{serviceName}/annotation'].post
  update:
    x-apievangelist-phrasing:
      intent: Annotate an APM service
      effect: write
      questions:
      - How do I mark a deployment on an APM service's charts?
      - Can I add tags and a message to an APM service annotation?
      instructions:
      - text: Create an annotation on service {serviceName} at {timestamp} saying {message}.
        slots:
          serviceName: path.serviceName
          timestamp: requestBody.@timestamp
          message: requestBody.message
      - text: Annotate {serviceName} for version {service} with tags {tags}.
        slots:
          serviceName: path.serviceName
          service: requestBody.service
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/apm/services/{serviceName}/annotation/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search an APM service's annotations
      effect: read
      questions:
      - What deployment annotations exist for an APM service?
      - Can I search a service's annotations for one environment within a time range?
      instructions:
      - text: Search annotations for service {serviceName}.
        slots:
          serviceName: path.serviceName
      - text: Find annotations on {serviceName} in {environment} between {start} and {end}.
        slots:
          serviceName: path.serviceName
          environment: query.environment
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'