Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Agent API

11 actions 11 updates phrasing extends openapi/datadog-agent-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 11

$.info
$.paths['/api/v2/remote_config/products/cws/agent_rules'].get
$.paths['/api/v2/remote_config/products/cws/agent_rules'].post
$.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].get
$.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].delete
$.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].patch
$.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules'].get
$.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules'].post
$.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].get
$.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].delete
$.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].patch

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 Agent API
  version: 1.0.0
extends: openapi/datadog-agent-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: 10
- target: $.paths['/api/v2/remote_config/products/cws/agent_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Workload Protection agent rules
      effect: read
      questions:
      - Which Workload Protection agent rules are defined on my commercial Datadog site?
      - Can I list only the agent rules that belong to one Workload Protection policy?
      instructions:
      - text: List all Workload Protection agent rules.
      - text: List the Workload Protection agent rules in policy {policy_id}.
        slots:
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/cws/agent_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Workload Protection agent rule
      effect: write
      questions:
      - How do I add a new Workload Protection agent rule outside the government site?
      - Can I create a runtime security agent rule with a custom expression?
      instructions:
      - text: Create a Workload Protection agent rule with {rule}.
        slots:
          rule: requestBody.data
      - text: Add a new CWS agent rule defined as {rule} on the standard site.
        slots:
          rule: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Workload Protection agent rule
      effect: read
      questions:
      - What expression does one Workload Protection agent rule use?
      - Can I read an agent rule in the context of a specific policy?
      instructions:
      - text: Get Workload Protection agent rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      - text: Show agent rule {agent_rule_id} within policy {policy_id}.
        slots:
          agent_rule_id: path.agent_rule_id
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Workload Protection agent rule
      effect: destructive
      questions:
      - How do I remove a Workload Protection agent rule on a non-government site?
      - Can I delete an agent rule from just one policy?
      instructions:
      - text: Delete Workload Protection agent rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      - text: Remove agent rule {agent_rule_id} from policy {policy_id}.
        slots:
          agent_rule_id: path.agent_rule_id
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Workload Protection agent rule
      effect: write
      questions:
      - How do I change the expression or enabled state of a Workload Protection agent rule?
      - Can I edit an agent rule scoped to a particular policy?
      instructions:
      - text: Update Workload Protection agent rule {agent_rule_id} with {changes}.
        slots:
          agent_rule_id: path.agent_rule_id
          changes: requestBody.data
      - text: Apply {changes} to agent rule {agent_rule_id} in policy {policy_id}.
        slots:
          changes: requestBody.data
          agent_rule_id: path.agent_rule_id
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent rules on the US1-FED site
      effect: read
      questions:
      - Which Workload Protection agent rules exist on the US1-FED government site?
      - On the government site, where do I list Cloud Workload Security agent rules?
      instructions:
      - text: List all agent rules on the US1-FED site.
      - text: Show the government-site Cloud Workload Security agent rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent rule on the US1-FED site
      effect: write
      questions:
      - How do I create a Workload Protection agent rule on the US1-FED government site?
      - Can I add a Cloud Workload Security agent rule in a FedRAMP org?
      instructions:
      - text: Create a US1-FED agent rule with {rule}.
        slots:
          rule: requestBody.data
      - text: Add a Cloud Workload Security agent rule {rule} on the government site.
        slots:
          rule: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent rule on the US1-FED site
      effect: read
      questions:
      - How do I read one agent rule's details on the US1-FED site?
      - On the government site, what expression does a given agent rule use?
      instructions:
      - text: Get US1-FED agent rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      - text: Show the government-site Cloud Workload Security rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent rule on the US1-FED site
      effect: destructive
      questions:
      - How do I delete a Workload Protection agent rule on the US1-FED site?
      - Can I remove a Cloud Workload Security rule from a government org?
      instructions:
      - text: Delete US1-FED agent rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      - text: Remove government-site Cloud Workload Security rule {agent_rule_id}.
        slots:
          agent_rule_id: path.agent_rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agent rule on the US1-FED site
      effect: write
      questions:
      - How do I edit an agent rule on the US1-FED government site?
      - Can I disable a Cloud Workload Security rule in a government org?
      instructions:
      - text: Update US1-FED agent rule {agent_rule_id} with {changes}.
        slots:
          agent_rule_id: path.agent_rule_id
          changes: requestBody.data
      - text: Apply {changes} to government-site Cloud Workload Security rule {agent_rule_id}.
        slots:
          changes: requestBody.data
          agent_rule_id: path.agent_rule_id
      method: generated
      generated: '2026-10-01'