Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Rules API

4 actions 4 updates phrasing extends openapi/datadog-rules-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/security_monitoring/configuration/suppressions/{suppression_id}'].patch

$.paths['/api/v2/security_monitoring/rules/test'].post

$.paths['/api/v2/sensitive-data-scanner/config/rules/{rule_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 Rules API
  version: 1.0.0
extends: openapi/datadog-rules-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/security_monitoring/configuration/suppressions/{suppression_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a security suppression rule
      effect: write
      questions:
      - Can I change the query of an existing suppression rule?
      - Does updating a suppression rule allow partial changes?
      instructions:
      - text: Update suppression rule {suppression_id} with {data}.
        slots:
          suppression_id: path.suppression_id
          data: requestBody.data
      - text: Edit the signal suppression {suppression_id}.
        slots:
          suppression_id: path.suppression_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/rules/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a new detection rule before saving
      effect: read
      questions:
      - Can I test a detection rule definition before I create it?
      - How do I check whether a draft rule fires on sample payloads?
      instructions:
      - text: Test the draft detection rule {rule} against {ruleQueryPayloads}.
        slots:
          rule: requestBody.rule
          ruleQueryPayloads: requestBody.ruleQueryPayloads
      - text: 'Dry-run this unsaved security rule: {rule}.'
        slots:
          rule: requestBody.rule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/sensitive-data-scanner/config/rules/{rule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Sensitive Data Scanner rule
      effect: write
      questions:
      - Can I change the regex of a Sensitive Data Scanner rule?
      - Why does editing a rule built on a standard pattern fail?
      instructions:
      - text: Update scanning rule {rule_id} with {data}.
        slots:
          rule_id: path.rule_id
          data: requestBody.data
      - text: Edit Sensitive Data Scanner rule {rule_id} using {data} and meta {meta}.
        slots:
          rule_id: path.rule_id
          data: requestBody.data
          meta: requestBody.meta
      method: generated
      generated: '2026-10-01'