Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace API v2 Events API

4 actions 4 updates phrasing extends openapi/dynatrace-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Dynatrace's API. It is a proposal applied on top of the contract, not a document Dynatrace publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/events'].get

$.paths['/events/{eventId}'].get

$.paths['/events/ingest'].post

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 Dynatrace API v2 Events API
  version: 1.0.0
extends: openapi/dynatrace-events-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: 3
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events in the environment
      effect: read
      questions:
      - Which deployment or configuration events happened in the last hour?
      - Can I filter events by type and by the entities they affect?
      instructions:
      - text: List events of type {type} from {from} to {to}.
        slots:
          type: query.eventType
          from: query.from
          to: query.to
      - text: Show events affecting entities matching {entities}.
        slots:
          entities: query.entitySelector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event's details
      effect: read
      questions:
      - What exactly happened in a particular event?
      - Can I fetch a single event using its ID from a notification?
      instructions:
      - text: Get the details of event {event}.
        slots:
          event: path.eventId
      - text: Show me event {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/ingest'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a custom event such as a deployment
      effect: write
      questions:
      - How do I mark a deployment on the Dynatrace timeline?
      - Can I attach custom properties to an event I push in?
      instructions:
      - text: Ingest a {type} event titled {title} on entities matching {entities}.
        slots:
          type: requestBody.eventType
          title: requestBody.title
          entities: requestBody.entitySelector
      - text: Record a custom {type} event called {title} with properties {properties}.
        slots:
          type: requestBody.eventType
          title: requestBody.title
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'