Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Filter API

9 actions 9 updates phrasing extends openapi/datadog-filter-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 9

$.info
$.paths['/api/v2/apm/config/retention-filters/{filter_id}'].get
$.paths['/api/v2/apm/config/retention-filters/{filter_id}'].put
$.paths['/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}'].get
$.paths['/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}'].put
$.paths['/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'].get
$.paths['/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'].patch
$.paths['/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'].get
$.paths['/api/v2/security_monitoring/configuration/security_filters/{security_filter_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 Filter API
  version: 1.0.0
extends: openapi/datadog-filter-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: 8
- target: $.paths['/api/v2/apm/config/retention-filters/{filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an APM retention filter
      effect: read
      questions:
      - What does a specific APM retention filter keep?
      - Can I see the sample rate on one trace retention filter?
      instructions:
      - text: Show APM retention filter {filter_id}.
        slots:
          filter_id: path.filter_id
      - text: Get the query and rate of APM filter {filter_id}.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/apm/config/retention-filters/{filter_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an APM retention filter
      effect: write
      questions:
      - Can I change the sampling rate of an APM retention filter?
      - Why can't I rename the default spans-errors retention filter?
      instructions:
      - text: Update APM retention filter {filter_id} with {data}.
        slots:
          filter_id: path.filter_id
          data: requestBody.data
      - text: Change the span query on APM filter {filter_id}.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WAF exclusion filter
      effect: read
      questions:
      - What traffic does a particular WAF exclusion filter skip?
      - Can I look up one exclusion filter by its ID?
      instructions:
      - text: Show WAF exclusion filter {exclusion_filter_id}.
        slots:
          exclusion_filter_id: path.exclusion_filter_id
      - text: Get the details of exclusion filter {exclusion_filter_id}.
        slots:
          exclusion_filter_id: path.exclusion_filter_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a WAF exclusion filter
      effect: write
      questions:
      - Can I edit the paths a WAF exclusion filter applies to?
      - Is it possible to disable an existing exclusion filter?
      instructions:
      - text: Update WAF exclusion filter {exclusion_filter_id} with {data}.
        slots:
          exclusion_filter_id: path.exclusion_filter_id
          data: requestBody.data
      - text: Edit exclusion filter {exclusion_filter_id}.
        slots:
          exclusion_filter_id: path.exclusion_filter_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a RUM retention filter
      effect: read
      questions:
      - What does one RUM retention filter keep for an app?
      - Can I see the sample rate of a RUM retention filter?
      instructions:
      - text: Show RUM retention filter {rf_id} on app {app_id}.
        slots:
          app_id: path.app_id
          rf_id: path.rf_id
      - text: Get filter {rf_id} for RUM application {app_id}.
        slots:
          app_id: path.app_id
          rf_id: path.rf_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a RUM retention filter
      effect: write
      questions:
      - Can I change how many RUM sessions a retention filter keeps?
      - Is editing a RUM retention filter's query possible?
      instructions:
      - text: Update RUM retention filter {rf_id} on app {app_id} with {data}.
        slots:
          app_id: path.app_id
          rf_id: path.rf_id
          data: requestBody.data
      - text: Change the sample rate of RUM filter {rf_id} in app {app_id}.
        slots:
          app_id: path.app_id
          rf_id: path.rf_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security filter
      effect: read
      questions:
      - Which logs does a given security filter exclude from analysis?
      - Can I view the definition of one security filter?
      instructions:
      - text: Show security filter {security_filter_id}.
        slots:
          security_filter_id: path.security_filter_id
      - text: Get the exclusions on security filter {security_filter_id}.
        slots:
          security_filter_id: path.security_filter_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a security filter
      effect: write
      questions:
      - Can I add exclusions to an existing security filter?
      - Is it possible to disable a security filter?
      instructions:
      - text: Update security filter {security_filter_id} with {data}.
        slots:
          security_filter_id: path.security_filter_id
          data: requestBody.data
      - text: Edit the query of security filter {security_filter_id}.
        slots:
          security_filter_id: path.security_filter_id
      method: generated
      generated: '2026-10-01'