Datadog APM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog APM — APM, Spans and Service Definitions (API v2) Service Definition API

5 actions 5 updates phrasing extends openapi/datadog-apm-service-definition-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v2/services/definitions'].get

$.paths['/api/v2/services/definitions'].post

$.paths['/api/v2/services/definitions/{service_name}'].get

$.paths['/api/v2/services/definitions/{service_name}'].delete

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 Datadog APM — APM, Spans and Service Definitions (API v2) Service Definition API
  version: 1.0.0
extends: openapi/datadog-apm-service-definition-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: 4
- target: $.paths['/api/v2/services/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Service Catalog definitions
      effect: read
      questions:
      - What services are registered in our Datadog Service Catalog?
      - Can I page through service definitions 100 at a time?
      - Which schema version can I ask for when listing all service definitions?
      instructions:
      - text: List all service definitions in the Service Catalog.
      - text: Get page {page} of service definitions with {size} per page.
        slots:
          page: query.page[number]
          size: query.page[size]
      - text: List every service definition using schema version {schema_version}.
        slots:
          schema_version: query.schema_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/services/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a service definition
      effect: write
      questions:
      - How do I register a new service in the Service Catalog?
      - Can I push an updated service definition to change the owner or links for a service?
      instructions:
      - text: Register this service definition in the Service Catalog.
      - text: Upsert the service definition YAML I just wrote so the catalog entry reflects it.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/services/definitions/{service_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one service's catalog definition
      effect: read
      questions:
      - Who owns a given service according to the Service Catalog?
      - What does the catalog definition for one named service contain?
      instructions:
      - text: Get the Service Catalog definition for {service_name}.
        slots:
          service_name: path.service_name
      - text: Show the definition of service {service_name} in schema version {schema_version}.
        slots:
          service_name: path.service_name
          schema_version: query.schema_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/services/definitions/{service_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service definition
      effect: destructive
      questions:
      - How do I remove a retired service from the Service Catalog?
      - Can I delete a single service's catalog definition?
      instructions:
      - text: Delete the service definition for {service_name}.
        slots:
          service_name: path.service_name
      - text: Remove {service_name} from the Service Catalog.
        slots:
          service_name: path.service_name
      method: generated
      generated: '2026-09-26'