# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Datadog Existing API
  version: 1.0.0
extends: openapi/datadog-existing-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: 9
- target: $.paths['/api/v2/incidents/{incident_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incident
      effect: write
      questions:
      - How do I change an incident's severity or status?
      - Can I update just one field on an incident without resending everything?
      instructions:
      - text: Update incident {incident_id} with {data}.
        slots:
          incident_id: path.incident_id
          data: requestBody.data
      - text: Change the attributes of incident {incident_id} to {data}.
        slots:
          incident_id: path.incident_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incident's integration metadata
      effect: write
      questions:
      - Can I edit the integration metadata linked to an incident?
      - What's the way to update a linked integration record on an incident?
      instructions:
      - text: Update integration metadata {integration_metadata_id} on incident {incident_id} with {data}.
        slots:
          integration_metadata_id: path.integration_metadata_id
          incident_id: path.incident_id
          data: requestBody.data
      - text: Edit linked integration {integration_metadata_id} for incident {incident_id}.
        slots:
          integration_metadata_id: path.integration_metadata_id
          incident_id: path.incident_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/scorecard/rules/{rule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Scorecard rule
      effect: write
      questions:
      - How do I edit a Scorecard rule that grades my services?
      - Can I change a service scorecard rule's settings?
      instructions:
      - text: Update scorecard rule {rule_id} with {data}.
        slots:
          rule_id: path.rule_id
          data: requestBody.data
      - text: Edit service Scorecard rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/rules/{rule_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security detection rule
      effect: write
      questions:
      - Must I resend every query when I modify a security detection rule?
      - What can I change on a default detection rule?
      - Can I disable a security detection rule without deleting it?
      instructions:
      - text: Update security detection rule {rule_id} with queries {queries}.
        slots:
          rule_id: path.rule_id
          queries: requestBody.queries
      - text: Set detection rule {rule_id} enabled to {isEnabled}.
        slots:
          rule_id: path.rule_id
          isEnabled: requestBody.isEnabled
      - text: Rename security rule {rule_id} to {name}.
        slots:
          rule_id: path.rule_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/rules/{rule_id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an existing security detection rule
      effect: read
      questions:
      - Can I test a detection rule I already saved against sample payloads?
      - How do I check whether an existing rule would fire on given data?
      instructions:
      - text: Test existing security rule {rule_id} against {ruleQueryPayloads}.
        slots:
          rule_id: path.rule_id
          ruleQueryPayloads: requestBody.ruleQueryPayloads
      - text: Run a test of saved detection rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/services/{service_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incident service
      effect: write
      questions:
      - How do I rename an incident service?
      - Can I partially update an incident service?
      instructions:
      - text: Update incident service {service_id} with {data}.
        slots:
          service_id: path.service_id
          data: requestBody.data
      - text: Rename the incident management service {service_id}.
        slots:
          service_id: path.service_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/teams/{team_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incident team
      effect: write
      questions:
      - Can I rename an incident team?
      - What's the way to partially update an incident team?
      instructions:
      - text: Update incident team {team_id} with {data}.
        slots:
          team_id: path.team_id
          data: requestBody.data
      - text: Rename the incident management team {team_id}.
        slots:
          team_id: path.team_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/workflows/{workflow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow
      effect: read
      questions:
      - How can I view a Workflow Automation workflow's definition?
      - Which permission does reading a workflow require?
      instructions:
      - text: Get workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      - text: Show the definition of automation workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/workflows/{workflow_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workflow
      effect: write
      questions:
      - How do I update the steps of an existing workflow?
      - Does editing a workflow need the workflows_write permission?
      instructions:
      - text: Update workflow {workflow_id} with {data}.
        slots:
          workflow_id: path.workflow_id
          data: requestBody.data
      - text: Edit the automation workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-10-01'