Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace API v2 Entities API

6 actions 6 updates phrasing extends openapi/dynatrace-entities-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 6

$.info
$.paths['/entities'].get
$.paths['/entities/{entityId}'].get
$.paths['/entityTypes'].get
$.paths['/entityTypes/{type}'].get
$.paths['/entities/lookup'].post

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 Dynatrace API v2 Entities API
  version: 1.0.0
extends: openapi/dynatrace-entities-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: 5
- target: $.paths['/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored entities matching a selector
      effect: read
      questions:
      - Which hosts or services is Dynatrace currently monitoring?
      - Can I filter monitored entities by type and tag and sort the results?
      instructions:
      - text: List monitored entities matching {selector}.
        slots:
          selector: query.entitySelector
      - text: Find all entities matching {selector} seen between {from} and {to}.
        slots:
          selector: query.entitySelector
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitored entity's details
      effect: read
      questions:
      - What properties and relationships does a specific service or host have?
      - Can I fetch one entity by its TYPE-HEX entity ID?
      instructions:
      - text: Get the details of entity {entity}.
        slots:
          entity: path.entityId
      - text: Show entity {entity} including fields {fields}.
        slots:
          entity: path.entityId
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entityTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available entity types
      effect: read
      questions:
      - What kinds of entities can Dynatrace monitor, like SERVICE or HOST?
      - Is there a catalog of every entity type in my environment?
      instructions:
      - text: List all entity types in the environment.
      - text: Show entity types {size} at a time.
        slots:
          size: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entityTypes/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity type's definition
      effect: read
      questions:
      - Which properties and relationships are available on the PROCESS_GROUP type?
      - What fields can I request for a given entity type?
      instructions:
      - text: Describe the entity type {type}.
        slots:
          type: path.type
      - text: Show the properties and relationships defined for type {type}.
        slots:
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up an entity ID by display name
      effect: read
      questions:
      - I know a service's name, how do I get its entity ID?
      - Can I resolve a human-readable host name to its Dynatrace ID?
      instructions:
      - text: Look up the entity ID for {type} named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Find the ID of the {type} called {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      method: generated
      generated: '2026-09-26'