API Evangelist conversational phrasing for Privacy Automation - Data Subject Request (DSR) Automation…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Privacy Automation - Data Subject Request (DSR) Automation…
  version: 1.0.0
extends: openapi/onetrust-subtasks-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: 11
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List subtasks on a request
      effect: read
      questions:
      - Which subtasks are attached to a specific privacy request?
      - Can I see the deadline and approver for each subtask on a request?
      instructions:
      - text: List subtasks for request {requestQueueRefId}.
        slots:
          requestQueueRefId: path.requestQueueRefId
      - text: Show every subtask attached to data subject request {requestQueueRefId}.
        slots:
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subtask to a request
      effect: write
      questions:
      - Can I add a custom subtask to a data subject request and assign it by email?
      - Is it possible to require a comment or resolution when a subtask is closed?
      instructions:
      - text: Add subtask {taskName} to request {requestQueueRefId} described as {description}.
        slots:
          taskName: requestBody.taskName
          requestQueueRefId: path.requestQueueRefId
          description: requestBody.description
      - text: 'Create subtask {taskName} on {requestQueueRefId} for {userEmail}: {description}.'
        slots:
          taskName: requestBody.taskName
          requestQueueRefId: path.requestQueueRefId
          userEmail: requestBody.userEmail
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subtask from a template
      effect: write
      questions:
      - Can I add a subtask to a request using a saved subtask template?
      - What do I pass to create a subtask with a template's configuration?
      instructions:
      - text: Add a subtask from template {templateName} to request {requestQueueRefId}.
        slots:
          templateName: requestBody.templateName
          requestQueueRefId: path.requestQueueRefId
      - text: Apply subtask template {templateName} on {requestQueueRefId}.
        slots:
          templateName: requestBody.templateName
          requestQueueRefId: path.requestQueueRefId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List subtasks (deprecated endpoint)
      effect: read
      questions:
      - Is the old list-subtasks endpoint still supported after January 2026?
      - Can I list subtasks by modified date using the deprecated call?
      instructions:
      - text: Using the deprecated endpoint, list subtasks with status {status}.
        slots:
          status: query.status
      - text: List subtasks modified on {modifieddate} via the legacy call.
        slots:
          modifieddate: query.modifieddate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subtask
      effect: read
      questions:
      - Who is assigned to a subtask and when is it due?
      - Can I include comments when fetching one subtask?
      instructions:
      - text: Get subtask {subtaskID}.
        slots:
          subtaskID: path.subtaskID
      - text: Show subtask {subtaskID} with its comments.
        slots:
          subtaskID: path.subtaskID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a subtask's details
      effect: write
      questions:
      - Can I change a subtask's assignee, deadline or description?
      - Is it possible to reassign a subtask to a group?
      instructions:
      - text: Update subtask {subtaskID} description to {description}.
        slots:
          subtaskID: path.subtaskID
          description: requestBody.description
      - text: Reassign subtask {subtaskID} to {userEmail} with deadline {deadline}, description {description}.
        slots:
          subtaskID: path.subtaskID
          userEmail: requestBody.userEmail
          deadline: requestBody.deadline
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskID}/add/discovery'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach Targeted Data Discovery to a subtask
      effect: write
      questions:
      - Can I add Targeted Data Discovery details to a subtask?
      - Where do data discovery results get attached on a request's subtask?
      instructions:
      - text: Add Targeted Data Discovery details to subtask {subtaskID}.
        slots:
          subtaskID: path.subtaskID
      - text: Attach data discovery results to subtask {subtaskID}.
        slots:
          subtaskID: path.subtaskID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskID}/complete'].put
  update:
    x-apievangelist-phrasing:
      intent: Complete a subtask
      effect: write
      questions:
      - Can I resolve a subtask and mark it complete with a comment?
      - Is a comment required to close out a subtask?
      instructions:
      - text: Complete subtask {subtaskID} with comment {comment}.
        slots:
          subtaskID: path.subtaskID
          comment: requestBody.comment
      - text: Resolve subtask {subtaskID} using resolution {resolutionId}, noting {comment}.
        slots:
          subtaskID: path.subtaskID
          resolutionId: requestBody.resolutionId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskID}/reprocess'].put
  update:
    x-apievangelist-phrasing:
      intent: Rerun a system subtask
      effect: write
      questions:
      - Can I rerun a system subtask that failed?
      - Which subtask statuses cannot be reprocessed?
      instructions:
      - text: Reprocess system subtask {subtaskID}.
        slots:
          subtaskID: path.subtaskID
      - text: Retry system subtask {subtaskID} with note {Comment}.
        slots:
          subtaskID: path.subtaskID
          Comment: requestBody.Comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v2/subtasks/{subtaskId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a subtask's status
      effect: write
      questions:
      - What statuses can I set a subtask to?
      - Can I mark a subtask as failed or rejected?
      instructions:
      - text: Set subtask {subtaskId} status to {status}.
        slots:
          subtaskId: path.subtaskId
          status: requestBody.status
      - text: Mark subtask {subtaskId} as {status} with comment {comment}.
        slots:
          subtaskId: path.subtaskId
          status: requestBody.status
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/datasubject/v3/subtasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Search subtasks by criteria
      effect: read
      questions:
      - Can I find subtasks by request type, system name or subtask status?
      - Is there a way to include closed subtasks when filtering?
      - Which subtasks were created during a given request stage?
      instructions:
      - text: Find subtasks with status {SubtaskStatus} for system {SystemName}.
        slots:
          SubtaskStatus: requestBody.SubtaskStatus
          SystemName: requestBody.SystemName
      - text: Search subtasks for request type {RequestType}, including closed ones.
        slots:
          RequestType: requestBody.RequestType
      method: generated
      generated: '2026-09-26'