Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Change API

3 actions 3 updates phrasing extends openapi/datadog-change-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 3

$.info

$.paths['/api/v2/security_monitoring/signals/{signal_id}/incidents'].patch

$.paths['/api/v2/security_monitoring/signals/{signal_id}/state'].patch

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 Change API
  version: 1.0.0
extends: openapi/datadog-change-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: 2
- target: $.paths['/api/v2/security_monitoring/signals/{signal_id}/incidents'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a security signal's related incidents
      effect: write
      questions:
      - How do I link a security signal to an incident?
      - Can I change which incidents a signal is associated with?
      instructions:
      - text: Set the related incidents of signal {signal_id} to {incidents}.
        slots:
          signal_id: path.signal_id
          incidents: requestBody.data
      - text: Link security signal {signal_id} to incidents {incidents}.
        slots:
          signal_id: path.signal_id
          incidents: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/signals/{signal_id}/state'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a security signal's triage state
      effect: write
      questions:
      - How do I mark a security signal as reviewed or archived?
      - Can I change the triage state of a signal and give a reason?
      instructions:
      - text: Change the triage state of signal {signal_id} to {state}.
        slots:
          signal_id: path.signal_id
          state: requestBody.data
      - text: Archive security signal {signal_id} using {state}.
        slots:
          signal_id: path.signal_id
          state: requestBody.data
      method: generated
      generated: '2026-10-01'