Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Case API

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

$.info
$.paths['/api/v2/cases'].post
$.paths['/api/v2/cases/{case_id}'].get
$.paths['/api/v2/cases/{case_id}/priority'].post
$.paths['/api/v2/cases/{case_id}/status'].post
$.paths['/api/v2/cases/{case_id}/unarchive'].post
$.paths['/api/v2/cases/{case_id}/unassign'].post

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 Case API
  version: 1.0.0
extends: openapi/datadog-case-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: 6
- target: $.paths['/api/v2/cases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a case
      effect: write
      questions:
      - Can I open a case in Case Management from an automation?
      - What fields does a new case need?
      instructions:
      - text: Create a case titled {case}.
        slots:
          case: requestBody.data
      - text: Open a new Case Management case with {case}.
        slots:
          case: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/{case_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a case's details
      effect: read
      questions:
      - Can I look up a case by its key instead of its UUID?
      - What details come back for a single case?
      instructions:
      - text: Get case {case_id}.
        slots:
          case_id: path.case_id
      - text: Show me the details of case {case_id}.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/{case_id}/priority'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a case's priority
      effect: write
      questions:
      - Can I raise the priority of an existing case?
      - Which priority levels can a case be set to?
      instructions:
      - text: Set case {case_id} priority to {priority}.
        slots:
          case_id: path.case_id
          priority: requestBody.data
      - text: Escalate the priority of case {case_id}.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/{case_id}/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a case's status
      effect: write
      questions:
      - Can I move a case to in progress or closed?
      - Which statuses can a case have?
      instructions:
      - text: Set case {case_id} status to {status}.
        slots:
          case_id: path.case_id
          status: requestBody.data
      - text: Close case {case_id}.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/{case_id}/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Unarchive a case
      effect: write
      questions:
      - Can I bring an archived case back?
      - Is archiving a case reversible?
      instructions:
      - text: Unarchive case {case_id}.
        slots:
          case_id: path.case_id
      - text: Restore archived case {case_id} to the active list.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/{case_id}/unassign'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove the assignee from a case
      effect: write
      questions:
      - Can I unassign a case so nobody owns it?
      - What do I send to clear a case's assignee?
      instructions:
      - text: Unassign case {case_id}.
        slots:
          case_id: path.case_id
      - text: Clear the assignee on case {case_id}.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'