Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Deployments API

4 actions 4 updates phrasing extends openapi/datadog-deployments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Datadog's API. It is a proposal applied on top of the contract, not a document Datadog publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v2/dora/deployment'].post
$.paths['/api/v2/dora/deployments'].post
$.paths['/api/v2/dora/deployments/{deployment_id}'].get

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 Datadog Deployments API
  version: 1.0.0
extends: openapi/datadog-deployments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/v2/dora/deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a deployment event for DORA metrics
      effect: write
      questions:
      - How do I report deployments so DORA deployment frequency and lead time are tracked?
      - Can I send a deployment event from my own release tooling?
      instructions:
      - text: Send a DORA deployment event with {data}.
        slots:
          data: requestBody.data
      - text: Record a deployment for DORA metrics using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/dora/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: List DORA deployment events
      effect: read
      questions:
      - Which deployments have been recorded for DORA metrics?
      - Can I query deployment events for a service and time range?
      instructions:
      - text: List DORA deployment events matching {data}.
        slots:
          data: requestBody.data
      - text: Get the deployment events for query {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/dora/deployments/{deployment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DORA deployment event
      effect: read
      questions:
      - How can I look up a single deployment event by ID?
      - What does one DORA deployment event record contain?
      instructions:
      - text: Get DORA deployment event {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show deployment event {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-10-01'