Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Monitors API

6 actions 6 updates phrasing extends openapi/datadog-monitors-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 6

$.info
$.paths['/api/v1/monitor'].get
$.paths['/api/v1/monitor'].post
$.paths['/api/v1/monitor/{monitor_id}'].get
$.paths['/api/v1/monitor/{monitor_id}'].put
$.paths['/api/v1/monitor/{monitor_id}'].delete

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 Monitors API
  version: 1.0.0
extends: openapi/datadog-monitors-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: 5
- target: $.paths['/api/v1/monitor'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitors
      effect: read
      questions:
      - Which monitors are currently alerting?
      - Can I find monitors by name or tag?
      - How many monitors can one page return?
      instructions:
      - text: List monitors in group state {group_states}.
        slots:
          group_states: query.group_states
      - text: Find monitors whose name contains {name}.
        slots:
          name: query.name
      - text: List monitors tagged {tags}.
        slots:
          tags: query.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitor'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitor
      effect: write
      questions:
      - How do I set up an alert when a metric crosses a threshold?
      - Can I create a monitor on log patterns or APM traces?
      instructions:
      - text: Create a {type} monitor named {name} on {query} that sends {message}.
        slots:
          type: requestBody.type
          name: requestBody.name
          query: requestBody.query
          message: requestBody.message
      - text: Create monitor {name} with priority {priority}.
        slots:
          name: requestBody.name
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitor/{monitor_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitor
      effect: read
      questions:
      - What's the current status and query of a given monitor?
      - Can I see if a specific monitor is muted by downtime?
      instructions:
      - text: Show monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Get monitor {monitor_id} with downtimes set to {with_downtimes}.
        slots:
          monitor_id: path.monitor_id
          with_downtimes: query.with_downtimes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitor/{monitor_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a monitor
      effect: write
      questions:
      - Can I change the threshold or query of an existing monitor?
      - Does editing a monitor replace its whole configuration?
      instructions:
      - text: Change the query of monitor {monitor_id} to {query}.
        slots:
          monitor_id: path.monitor_id
          query: requestBody.query
      - text: Update the notification message on monitor {monitor_id} to {message}.
        slots:
          monitor_id: path.monitor_id
          message: requestBody.message
      - text: Rename monitor {monitor_id} to {name}.
        slots:
          monitor_id: path.monitor_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitor/{monitor_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitor
      effect: destructive
      questions:
      - Can I delete a monitor that an SLO still references?
      - Is deleting a monitor reversible?
      instructions:
      - text: Delete monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Force delete monitor {monitor_id} with force={force}.
        slots:
          monitor_id: path.monitor_id
          force: query.force
      method: generated
      generated: '2026-10-01'