Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Cancel API

4 actions 4 updates phrasing extends openapi/datadog-cancel-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/downtime/{downtime_id}'].delete

$.paths['/api/v2/siem-historical-detections/jobs/{job_id}/cancel'].patch

$.paths['/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel'].put

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 Cancel API
  version: 1.0.0
extends: openapi/datadog-cancel-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/downtime/{downtime_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a downtime
      effect: destructive
      questions:
      - How do I end a downtime early so monitors alert again?
      - Will a canceled downtime still show up in search results?
      instructions:
      - text: Cancel downtime {downtime_id}.
        slots:
          downtime_id: path.downtime_id
      - text: End the scheduled downtime {downtime_id} now.
        slots:
          downtime_id: path.downtime_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/siem-historical-detections/jobs/{job_id}/cancel'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a historical detection job
      effect: destructive
      questions:
      - Can I stop a SIEM historical job that's still running?
      - What's the way to cancel a historical detection run?
      instructions:
      - text: Cancel historical job {job_id}.
        slots:
          job_id: path.job_id
      - text: Stop the running historical detection job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running workflow execution
      effect: destructive
      questions:
      - How do I cancel a workflow execution that's in progress?
      - Which permission is required to cancel a workflow instance?
      instructions:
      - text: Cancel instance {instance_id} of workflow {workflow_id}.
        slots:
          instance_id: path.instance_id
          workflow_id: path.workflow_id
      - text: Stop execution {instance_id} of workflow {workflow_id}.
        slots:
          instance_id: path.instance_id
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-10-01'