Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Demand API

4 actions 4 updates phrasing extends openapi/datadog-demand-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/agentless_scanning/ondemand/aws'].get

$.paths['/api/v2/agentless_scanning/ondemand/aws'].post

$.paths['/api/v2/agentless_scanning/ondemand/aws/{task_id}'].get

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 Demand API
  version: 1.0.0
extends: openapi/datadog-demand-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/agentless_scanning/ondemand/aws'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS on-demand scan tasks
      effect: read
      questions:
      - Which on-demand agentless scans have run against my AWS resources?
      - How many AWS on-demand tasks does the list return?
      instructions:
      - text: List recent AWS on-demand scan tasks.
      - text: Show the latest agentless on-demand tasks for AWS.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/agentless_scanning/ondemand/aws'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an AWS on-demand agentless scan
      effect: write
      questions:
      - Can I scan one AWS resource right now with high priority?
      - Does agentless scanning need to be enabled before an on-demand scan?
      instructions:
      - text: Trigger an on-demand scan of AWS resource {task}.
        slots:
          task: requestBody.data
      - text: Scan {task} now with agentless scanning.
        slots:
          task: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/agentless_scanning/ondemand/aws/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AWS on-demand scan task
      effect: read
      questions:
      - Can I check the status of one on-demand scan task?
      - What data does a single on-demand task return?
      instructions:
      - text: Get on-demand task {task_id}.
        slots:
          task_id: path.task_id
      - text: Check the status of AWS scan task {task_id}.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'