Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Dashboards API

4 actions 4 updates phrasing extends openapi/datadog-dashboards-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/dashboard/lists/manual/{dashboard_list_id}/dashboards'].get

$.paths['/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'].put

$.paths['/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'].delete

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 Dashboards API
  version: 1.0.0
extends: openapi/datadog-dashboards-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/dashboard/lists/manual/{dashboard_list_id}/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: Get dashboards in a dashboard list
      effect: read
      questions:
      - Which dashboards are in a given dashboard list?
      - Can I see the contents of a manual dashboard list?
      instructions:
      - text: Show the dashboards in list {dashboard_list_id}.
        slots:
          dashboard_list_id: path.dashboard_list_id
      - text: List items of dashboard list {dashboard_list_id}.
        slots:
          dashboard_list_id: path.dashboard_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the dashboards in a dashboard list
      effect: write
      questions:
      - Can I set exactly which dashboards a list contains?
      - Is updating a dashboard list's items a full replacement?
      instructions:
      - text: Set dashboard list {dashboard_list_id} to contain {dashboards}.
        slots:
          dashboard_list_id: path.dashboard_list_id
          dashboards: requestBody.dashboards
      - text: Update the items of dashboard list {dashboard_list_id}.
        slots:
          dashboard_list_id: path.dashboard_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove dashboards from a dashboard list
      effect: destructive
      questions:
      - Can I take dashboards out of a list without deleting them?
      - How do I remove a few dashboards from a dashboard list?
      instructions:
      - text: Remove {dashboards} from dashboard list {dashboard_list_id}.
        slots:
          dashboard_list_id: path.dashboard_list_id
          dashboards: requestBody.dashboards
      - text: Delete items from dashboard list {dashboard_list_id}.
        slots:
          dashboard_list_id: path.dashboard_list_id
      method: generated
      generated: '2026-10-01'