Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Devices API

6 actions 6 updates phrasing extends openapi/datadog-devices-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/v2/ndm/devices'].get

$.paths['/api/v2/ndm/devices/{device_id}'].get

$.paths['/api/v2/ndm/interfaces'].get

$.paths['/api/v2/ndm/tags/devices/{device_id}'].get

$.paths['/api/v2/ndm/tags/devices/{device_id}'].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 Devices API
  version: 1.0.0
extends: openapi/datadog-devices-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/v2/ndm/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List network devices
      effect: read
      questions:
      - Which network devices is Network Device Monitoring tracking?
      - Can I filter my monitored network devices by tag?
      instructions:
      - text: List all monitored network devices.
      - text: List network devices tagged {tag}, {page_size} per page.
        slots:
          tag: query.filter[tag]
          page_size: query.page[size]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/ndm/devices/{device_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network device's details
      effect: read
      questions:
      - What vendor, model and IP address does a monitored device have?
      - How do I look up a single network device by ID?
      instructions:
      - text: Get network device {device_id}.
        slots:
          device_id: path.device_id
      - text: Show the details of device {device_id}.
        slots:
          device_id: path.device_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/ndm/interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's network interfaces
      effect: read
      questions:
      - Which interfaces does a network device have and are they up?
      - Can I include the IP addresses when listing a device's interfaces?
      instructions:
      - text: List the interfaces of device {device_id}.
        slots:
          device_id: query.device_id
      - text: List interfaces on {device_id} with get_ip_addresses set to {get_ip_addresses}.
        slots:
          device_id: query.device_id
          get_ip_addresses: query.get_ip_addresses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/ndm/tags/devices/{device_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags on a network device
      effect: read
      questions:
      - What user tags are applied to a network device?
      - Can I see the tags I've assigned to one device?
      instructions:
      - text: List the tags on device {device_id}.
        slots:
          device_id: path.device_id
      - text: Show the user-defined tags for network device {device_id}.
        slots:
          device_id: path.device_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/ndm/tags/devices/{device_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the tags on a network device
      effect: write
      questions:
      - How do I change the tags on a network device?
      - Can I set a new list of user tags on a device?
      instructions:
      - text: Set the tags on device {device_id} to {tags}.
        slots:
          device_id: path.device_id
          tags: requestBody.data
      - text: Update network device {device_id}'s user tags with {tags}.
        slots:
          device_id: path.device_id
          tags: requestBody.data
      method: generated
      generated: '2026-10-01'