Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Groups API

7 actions 7 updates phrasing extends openapi/datadog-groups-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/scim/Groups'].get
$.paths['/api/v2/scim/Groups/{group_id}'].put
$.paths['/api/v2/scim/Groups/{group_id}'].patch
$.paths['/api/v2/sensitive-data-scanner/config'].get
$.paths['/api/v2/sensitive-data-scanner/config'].patch
$.paths['/api/v2/sensitive-data-scanner/config/groups/{group_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 Groups API
  version: 1.0.0
extends: openapi/datadog-groups-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/scim/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM groups
      effect: read
      questions:
      - Which groups have been provisioned into my organization over SCIM?
      - Can I filter SCIM groups by display name and page through them?
      instructions:
      - text: List all SCIM groups.
      - text: List SCIM groups matching {filter}, {count} at a time from index {startIndex}.
        slots:
          filter: query.filter
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/scim/Groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM group
      effect: write
      questions:
      - How do I replace a SCIM group's name and full member list in one call?
      - Can I overwrite a group's members with a new set through SCIM?
      instructions:
      - text: Replace SCIM group {group_id} with display name {displayName} and members {members}.
        slots:
          group_id: path.group_id
          displayName: requestBody.displayName
          members: requestBody.members
      - text: Overwrite the whole SCIM group {group_id} so its members are exactly {members}.
        slots:
          group_id: path.group_id
          members: requestBody.members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/scim/Groups/{group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a SCIM group
      effect: write
      questions:
      - How do I add or remove a single member from a SCIM group without replacing it?
      - Can I apply SCIM patch operations to a group?
      instructions:
      - text: Apply SCIM patch operations {Operations} to group {group_id}.
        slots:
          Operations: requestBody.Operations
          group_id: path.group_id
      - text: Partially update SCIM group {group_id} using {Operations}.
        slots:
          group_id: path.group_id
          Operations: requestBody.Operations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/sensitive-data-scanner/config'].get
  update:
    x-apievangelist-phrasing:
      intent: List Sensitive Data Scanner groups
      effect: read
      questions:
      - Which Sensitive Data Scanner groups are configured in my org?
      - Can I see the scanning groups and the rules they contain?
      instructions:
      - text: List all Sensitive Data Scanner groups.
      - text: Show my sensitive data scanning configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/sensitive-data-scanner/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder Sensitive Data Scanner groups
      effect: write
      questions:
      - How do I change the order in which scanning groups are evaluated?
      - Can I move a Sensitive Data Scanner group to the top of the list?
      instructions:
      - text: Reorder the scanning groups to {order}.
        slots:
          order: requestBody.data
      - text: Set the Sensitive Data Scanner group order to {order} with meta {meta}.
        slots:
          order: requestBody.data
          meta: requestBody.meta
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/sensitive-data-scanner/config/groups/{group_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a scanning group and its rule order
      effect: write
      questions:
      - How do I change the filter or settings of one Sensitive Data Scanner group?
      - Can I reorder the rules inside a single scanning group?
      instructions:
      - text: Update scanning group {group_id} with {changes}.
        slots:
          group_id: path.group_id
          changes: requestBody.data
      - text: Reorder the rules inside scanning group {group_id} using {changes} and meta {meta}.
        slots:
          group_id: path.group_id
          changes: requestBody.data
          meta: requestBody.meta
      method: generated
      generated: '2026-10-01'