OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Object Manager Object Task Management API

4 actions 4 updates phrasing extends openapi/onetrust-object-task-management-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/tasks'].post
$.paths['/v1/tasks/{taskId}'].get
$.paths['/v1/tasks/{taskId}'].put

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 Platform - Object Manager Object Task Management API
  version: 1.0.0
extends: openapi/onetrust-object-task-management-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: 3
- target: $.paths['/v1/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task on a Project, Model or Dataset
      effect: write
      questions:
      - How do I assign a follow-up task on an AI model record?
      - Can I give a new object task a deadline and priority?
      instructions:
      - text: Create task {taskName} of type {taskTypeNameKey} on object {parentEntityId} in org group {orgGroupId}.
        slots:
          taskName: requestBody.taskName
          taskTypeNameKey: requestBody.taskTypeNameKey
          parentEntityId: requestBody.parentEntityId
          orgGroupId: requestBody.orgGroupId
      - text: Assign task {taskName} on object {parentEntityId} to {assigneeEmail}, due {deadline}.
        slots:
          taskName: requestBody.taskName
          parentEntityId: requestBody.parentEntityId
          assigneeEmail: requestBody.assigneeEmail
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object task and its history
      effect: read
      questions:
      - Who is assigned to a task on a Project and when is it due?
      - Can I see the activity history of an object task?
      instructions:
      - text: Show object task {taskId}.
        slots:
          taskId: path.taskId
      - text: Get the activity history and assignee of task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object task
      effect: write
      questions:
      - How do I mark an object task complete or change its status?
      - Can I reassign a task on a Dataset?
      instructions:
      - text: Set the status of task {taskId} ({taskName}) to {status}.
        slots:
          taskId: path.taskId
          taskName: requestBody.taskName
          status: requestBody.status
      - text: Reassign task {taskId} ({taskName}) to {assigneeEmail}.
        slots:
          taskId: path.taskId
          taskName: requestBody.taskName
          assigneeEmail: requestBody.assigneeEmail
      method: generated
      generated: '2026-09-26'