Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge Submit Deletion Request API

2 actions 2 updates phrasing extends openapi/ada-submitdeletionrequest-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ada's API. It is a proposal applied on top of the contract, not a document Ada publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v2/end-users/delete'].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 Knowledge Submit Deletion Request API
  version: 1.0.0
extends: openapi/ada-submitdeletionrequest-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v2/end-users/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Request bulk erasure of end users' data
      effect: destructive
      questions:
      - How do I erase personal data for many end users in one request?
      - How many identifiers can one bulk deletion request include?
      - Is resubmitting the same deletion request safe from creating duplicate jobs?
      instructions:
      - text: Erase all personal data for identifiers {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Submit a bulk deletion for {identifiers} with client reference {client_reference}.
        slots:
          identifiers: requestBody.identifiers
          client_reference: requestBody.client_reference
      method: generated
      generated: '2026-09-26'