API Evangelist conversational phrasing for Privacy Automation - Assessment Automation Assessment…

# 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 - Assessment Automation Assessment…
  version: 1.0.0
extends: openapi/onetrust-assessment-actions-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: 13
- target: $.paths['/api/assessment/v1/assessments/{assessmentId}/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete an assessment review with a result
      effect: write
      questions:
      - Can I finish reviewing a submitted assessment and pick a result option?
      - What stage does an assessment move to once its review is completed?
      - Can I add a closure comment when completing an assessment review?
      instructions:
      - text: Complete the review of assessment {assessmentId} with result {resultId}.
        slots:
          assessmentId: path.assessmentId
          resultId: requestBody.resultId
      - text: Close out review on assessment {assessmentId} with comment {closureComment}.
        slots:
          assessmentId: path.assessmentId
          closureComment: requestBody.closureComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch an assessment (v2 endpoint)
      effect: write
      questions:
      - Can I still launch an assessment through the older v2 endpoint?
      - What fields does the v2 launch-assessment call require?
      instructions:
      - text: Using the v2 endpoint, launch assessment {name} for respondents {respondents}.
        slots:
          name: requestBody.name
          respondents: requestBody.respondents
      - text: Launch a v2 assessment {name} from template {templateId} due {deadline} for {respondents}.
        slots:
          name: requestBody.name
          templateId: requestBody.templateId
          deadline: requestBody.deadline
          respondents: requestBody.respondents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch assessments in bulk per inventory
      effect: write
      questions:
      - Can I create one assessment for each inventory item in a single request?
      - Is there a bulk way to launch many assessments at once?
      instructions:
      - text: Launch assessments in bulk, one per inventory ID I give you.
      - text: Create a batch of assessments across my inventory records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/reassign'].put
  update:
    x-apievangelist-phrasing:
      intent: Reassign an assessment's people or org
      effect: write
      questions:
      - Can I change the respondents or approvers on an assessment already in flight?
      - Is it possible to move an assessment to a different organization?
      instructions:
      - text: Reassign assessment {assessmentId} to respondents {respondents}.
        slots:
          assessmentId: path.assessmentId
          respondents: requestBody.respondents
      - text: Move assessment {assessmentId} to organization {orgGroupId} with approvers {approvers}.
        slots:
          assessmentId: path.assessmentId
          orgGroupId: requestBody.orgGroupId
          approvers: requestBody.approvers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit answers to assessment questions
      effect: write
      questions:
      - Can I post question responses to an assessment programmatically?
      - Why can't I add responses to an assessment that is already completed?
      instructions:
      - text: Submit responses to the questions on assessment {assessmentId}.
        slots:
          assessmentId: path.assessmentId
      - text: Record my answers on assessment {assessmentId}.
        slots:
          assessmentId: path.assessmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/risks'].post
  update:
    x-apievangelist-phrasing:
      intent: Flag a risk on an assessment question
      effect: write
      questions:
      - Can I raise a risk against a specific question on an assessment?
      - Who becomes the risk owner when a risk is flagged on an assessment?
      instructions:
      - text: Flag a risk on assessment {assessmentId} for question {questionId} in section {sectionId}.
        slots:
          assessmentId: path.assessmentId
          questionId: requestBody.questionId
          sectionId: requestBody.sectionId
      - text: Create risk {riskCreateRequest} on assessment {assessmentId} question {questionId}.
        slots:
          riskCreateRequest: requestBody.riskCreateRequest
          assessmentId: path.assessmentId
          questionId: requestBody.questionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an assessment for review
      effect: write
      questions:
      - What must be answered before an assessment can be sent for review?
      - Can I accept the disclaimer when submitting an assessment?
      instructions:
      - text: Submit assessment {assessmentId} for review.
        slots:
          assessmentId: path.assessmentId
      - text: Send assessment {assessmentId} to Under Review with comment {comment}.
        slots:
          assessmentId: path.assessmentId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{assessmentId}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task on an assessment
      effect: write
      questions:
      - Can I add a follow-up task to an assessment and assign it to someone?
      - How many tasks can be created on an assessment per call?
      instructions:
      - text: Create task {taskName} on assessment {assessmentId}.
        slots:
          taskName: requestBody.taskName
          assessmentId: path.assessmentId
      - text: Add assessment task {taskName} to {assessmentId}, assigned to {assigneeId} due {deadline}.
        slots:
          taskName: requestBody.taskName
          assessmentId: path.assessmentId
          assigneeId: requestBody.assigneeId
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{id}/reassess'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a reassessment of an assessment
      effect: write
      questions:
      - Can I rerun an old assessment against the latest template version?
      - Does a reassessment carry over previous responses and attachments?
      instructions:
      - text: Reassess assessment {id}.
        slots:
          id: path.id
      - text: Launch a reassessment of {id} due {deadline}, copying responses {copyResponses}.
        slots:
          id: path.id
          deadline: requestBody.deadline
          copyResponses: requestBody.copyResponses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{id}/reopen'].post
  update:
    x-apievangelist-phrasing:
      intent: Reopen a completed assessment
      effect: write
      questions:
      - Can a completed assessment be reopened to ask respondents for more information?
      - Which stage does a reopened assessment go back to?
      instructions:
      - text: Reopen completed assessment {id}.
        slots:
          id: path.id
      - text: Reopen assessment {id} and email respondents {emailComment}.
        slots:
          id: path.id
          emailComment: requestBody.emailComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v2/assessments/{id}/send-back'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an assessment back to in progress
      effect: write
      questions:
      - Can I send an assessment under review back to respondents for changes?
      - Is it possible to reset approver reviews when returning an assessment?
      instructions:
      - text: Send assessment {id} back to In Progress.
        slots:
          id: path.id
      - text: Return assessment {id} to respondents with note {emailComment}.
        slots:
          id: path.id
          emailComment: requestBody.emailComment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v3/assessments'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a new assessment
      effect: write
      questions:
      - How do I launch a new privacy assessment and assign respondents?
      - Can a new assessment be tied to an inventory record and given a deadline?
      - What happens if the template has an approver-only section?
      instructions:
      - text: Launch assessment {name} for respondents {respondents}.
        slots:
          name: requestBody.name
          respondents: requestBody.respondents
      - text: Start assessment {name} from template {templateId} for {respondents}, due {deadline}.
        slots:
          name: requestBody.name
          templateId: requestBody.templateId
          respondents: requestBody.respondents
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assessment/v3/assessments/{assessmentId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve an assessment
      effect: write
      questions:
      - Can I approve a submitted assessment and mark it completed?
      - Does an assessment have to be submitted before it can be approved?
      instructions:
      - text: Approve assessment {assessmentId}.
        slots:
          assessmentId: path.assessmentId
      - text: Approve assessment {assessmentId} with approval comment {closureComment}.
        slots:
          assessmentId: path.assessmentId
          closureComment: requestBody.closureComment
      method: generated
      generated: '2026-09-26'