# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Hygiene Record Delete (Work order) API
  version: 1.0.0
extends: openapi/adobe-suite-record-delete-work-order-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: 4
- target: $.paths['/workorder'].get
  update:
    x-apievangelist-phrasing:
      intent: List data hygiene work orders
      effect: read
      questions:
      - Which record delete requests has our organization submitted?
      - Can I filter data hygiene work orders by status or date range?
      - Who authored the identity deletion work orders in a sandbox?
      instructions:
      - text: List data hygiene work orders in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show work orders with status {status} created between {fromDate} and {toDate}.
        slots:
          status: query.status
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Find work orders submitted by {author} of type {type}.
        slots:
          author: query.author
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a record delete work order
      effect: destructive
      questions:
      - How do I request deletion of specific customer identities from our data?
      - Can a record delete be scoped to a single dataset?
      instructions:
      - text: Submit a work order named {displayName} to delete identities {namespacesIdentities} from dataset {datasetId}.
        slots:
          displayName: requestBody.displayName
          namespacesIdentities: requestBody.namespacesIdentities
          datasetId: requestBody.datasetId
      - text: Create a {action} work order in sandbox {sandbox} described as {description}.
        slots:
          action: requestBody.action
          sandbox: header.x-sandbox-name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workorder/{WORKORDER_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of one work order
      effect: read
      questions:
      - Has my record delete request finished processing yet?
      - What dataset and identities are attached to one particular work order?
      instructions:
      - text: Show work order {WORKORDER_ID}.
        slots:
          WORKORDER_ID: path.WORKORDER_ID
      - text: Check the status of work order {WORKORDER_ID} in sandbox {sandbox}.
        slots:
          WORKORDER_ID: path.WORKORDER_ID
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workorder/{WORKORDER_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or re-describe a work order
      effect: write
      questions:
      - Can I change the name or description on a work order I already submitted?
      - Which fields of an existing record delete request are editable?
      instructions:
      - text: Rename work order {WORKORDER_ID} to {name}.
        slots:
          WORKORDER_ID: path.WORKORDER_ID
          name: requestBody.name
      - text: Set the description of work order {WORKORDER_ID} to {description}.
        slots:
          WORKORDER_ID: path.WORKORDER_ID
          description: requestBody.description
      method: generated
      generated: '2026-09-26'