Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Applications API

21 actions 21 updates phrasing extends openapi/datadog-applications-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 21 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v2/app-builder/apps'].get
$.paths['/api/v2/app-builder/apps'].post
$.paths['/api/v2/app-builder/apps'].delete
$.paths['/api/v2/app-builder/apps/{app_id}'].get
$.paths['/api/v2/app-builder/apps/{app_id}'].delete
$.paths['/api/v2/app-builder/apps/{app_id}'].patch
$.paths['/api/v2/app-builder/apps/{app_id}/deployment'].post
$.paths['/api/v2/app-builder/apps/{app_id}/deployment'].delete
$.paths['/api/v2/application_keys/{app_key_id}'].get
$.paths['/api/v2/application_keys/{app_key_id}'].delete
$.paths['/api/v2/application_keys/{app_key_id}'].patch
$.paths['/api/v2/current_user/application_keys'].post
$.paths['/api/v2/current_user/application_keys/{app_key_id}'].get
$.paths['/api/v2/current_user/application_keys/{app_key_id}'].delete
$.paths['/api/v2/current_user/application_keys/{app_key_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 Applications API
  version: 1.0.0
extends: openapi/datadog-applications-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: 20
- target: $.paths['/api/v2/app-builder/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List App Builder apps
      effect: read
      questions:
      - Which App Builder apps exist in my org and who created them?
      - Can I list only the published apps, or just my favorites?
      - How do I find apps tagged for a particular team in App Builder?
      instructions:
      - text: List all App Builder apps.
      - text: List apps created by {user_name}.
        slots:
          user_name: query.filter[user_name]
      - text: Show published App Builder apps tagged {tags}.
        slots:
          tags: query.filter[tags]
      - text: Find apps whose name matches {name}.
        slots:
          name: query.filter[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an App Builder app
      effect: write
      questions:
      - How do I create a new internal app in App Builder through the API?
      - Does creating an app return its ID right away?
      instructions:
      - text: Create a new App Builder app from definition {data}.
        slots:
          data: requestBody.data
      - text: 'Build an app in App Builder using this definition: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several App Builder apps at once
      effect: destructive
      questions:
      - Can I delete multiple App Builder apps in a single request?
      - What's the fastest way to clean up a batch of unused apps?
      instructions:
      - text: 'Delete these App Builder apps in one go: {data}.'
        slots:
          data: requestBody.data
      - text: Bulk remove the apps with IDs {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps/{app_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an App Builder app's full definition
      effect: read
      questions:
      - How can I see the full definition of an App Builder app?
      - Can I retrieve an older version of an app instead of the latest?
      instructions:
      - text: Get the definition of App Builder app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show version {version} of app {app_id}.
        slots:
          version: query.version
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps/{app_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single App Builder app
      effect: destructive
      questions:
      - How do I delete one App Builder app by its ID?
      - Is deleting a single app permanent?
      instructions:
      - text: Delete App Builder app {app_id}.
        slots:
          app_id: path.app_id
      - text: Remove the app {app_id} from App Builder.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps/{app_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an App Builder app
      effect: write
      questions:
      - Does updating an App Builder app create a new version?
      - Can I change just part of an app's definition and keep the rest?
      instructions:
      - text: Update App Builder app {app_id} with {data}.
        slots:
          app_id: path.app_id
          data: requestBody.data
      - text: Save a new version of app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps/{app_id}/deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an App Builder app
      effect: write
      questions:
      - How do I make an App Builder app available to other users?
      - Do I also need a restriction policy after publishing an app?
      instructions:
      - text: Publish App Builder app {app_id}.
        slots:
          app_id: path.app_id
      - text: Deploy app {app_id} so my teammates can use it.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/app-builder/apps/{app_id}/deployment'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unpublish an App Builder app
      effect: destructive
      questions:
      - Can I take an app offline without deleting it?
      - Will I be able to republish an app after unpublishing it?
      instructions:
      - text: Unpublish App Builder app {app_id}.
        slots:
          app_id: path.app_id
      - text: Remove the live version of app {app_id} but keep the app.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/application_keys/{app_key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org application key
      effect: read
      questions:
      - How can I look up any application key in my org by ID?
      - Can I see who owns an application key?
      instructions:
      - text: Get org application key {app_key_id}.
        slots:
          app_key_id: path.app_key_id
      - text: Show application key {app_key_id} including its {include} relationship.
        slots:
          app_key_id: path.app_key_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/application_keys/{app_key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org application key
      effect: destructive
      questions:
      - How do I revoke any user's application key as an org admin?
      - Can I delete an application key that belongs to someone else in my org?
      instructions:
      - text: Delete org application key {app_key_id}.
        slots:
          app_key_id: path.app_key_id
      - text: Revoke application key {app_key_id} at the organization level.
        slots:
          app_key_id: path.app_key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/application_keys/{app_key_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an org application key
      effect: write
      questions:
      - Can I rename an application key across my org?
      - What's the way to change an org application key's settings?
      instructions:
      - text: Edit org application key {app_key_id} with {data}.
        slots:
          app_key_id: path.app_key_id
          data: requestBody.data
      - text: Rename organization application key {app_key_id} using {data}.
        slots:
          app_key_id: path.app_key_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/current_user/application_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application key for myself
      effect: write
      questions:
      - How do I create a personal application key for my own user?
      - Can I generate an application key owned by me?
      instructions:
      - text: Create an application key for my user with {data}.
        slots:
          data: requestBody.data
      - text: Generate a new personal application key named per {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/current_user/application_keys/{app_key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my own application keys
      effect: read
      questions:
      - Can I look up a single application key that I own?
      - What details come back for one of my personal application keys?
      instructions:
      - text: Get my application key {app_key_id}.
        slots:
          app_key_id: path.app_key_id
      - text: Show the personal app key {app_key_id} that I own.
        slots:
          app_key_id: path.app_key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/current_user/application_keys/{app_key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of my own application keys
      effect: destructive
      questions:
      - How do I delete an application key that I own?
      - Can I revoke my personal application key without admin rights?
      instructions:
      - text: Delete my application key {app_key_id}.
        slots:
          app_key_id: path.app_key_id
      - text: Revoke my own app key {app_key_id}.
        slots:
          app_key_id: path.app_key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/current_user/application_keys/{app_key_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit one of my own application keys
      effect: write
      questions:
      - Can I rename an application key that I own?
      - What can I change on my personal application key?
      instructions:
      - text: Edit my application key {app_key_id} with {data}.
        slots:
          app_key_id: path.app_key_id
          data: requestBody.data
      - text: Rename my own app key {app_key_id} using {data}.
        slots:
          app_key_id: path.app_key_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a RUM application
      effect: write
      questions:
      - How do I set up a new RUM application for my web or mobile app?
      - Can I create a Real User Monitoring application via the API?
      instructions:
      - text: Create a RUM application with {data}.
        slots:
          data: requestBody.data
      - text: Register a new Real User Monitoring app using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a RUM application
      effect: read
      questions:
      - How can I see the settings of one RUM application?
      - Can I fetch a RUM application's client token by its ID?
      instructions:
      - text: Get RUM application {id}.
        slots:
          id: path.id
      - text: Show details for Real User Monitoring app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a RUM application
      effect: destructive
      questions:
      - How do I delete a RUM application we no longer track?
      - Is removing a RUM application from my org reversible?
      instructions:
      - text: Delete RUM application {id}.
        slots:
          id: path.id
      - text: Remove Real User Monitoring app {id} from my org.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a RUM application
      effect: write
      questions:
      - Can I rename or change the type of an existing RUM application?
      - What's the way to edit a RUM application's settings?
      instructions:
      - text: Update RUM application {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Rename Real User Monitoring app {id} using {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/usage/application_security'].get
  update:
    x-apievangelist-phrasing:
      intent: Get hourly Application Security usage
      effect: read
      questions:
      - How much Application Security usage did we have each hour last week?
      - Is the hourly Application Security usage endpoint deprecated?
      instructions:
      - text: Get hourly Application Security usage starting {start_hr}.
        slots:
          start_hr: query.start_hr
      - text: Show Application Security hourly usage from {start_hr} to {end_hr}.
        slots:
          start_hr: query.start_hr
          end_hr: query.end_hr
      method: generated
      generated: '2026-10-01'