OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Task Management Tasks API

4 actions 4 updates phrasing extends openapi/onetrust-tasks-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['/api/task-management/v1/tasks'].post

$.paths['/api/task-management/v1/tasks/{taskId}'].get

$.paths['/api/task-management/v1/tasks/{taskId}'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform - Task Management Tasks API
  version: 1.0.0
extends: openapi/onetrust-tasks-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['/api/task-management/v1/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task on an issue
      effect: write
      questions:
      - Can I create a task on an issue and assign it by email?
      - Which object types support tasks today?
      instructions:
      - text: Create task {taskName} on issue {parentEntityId} in org {orgGroupId}, type {taskTypeNameKey}.
        slots:
          taskName: requestBody.taskName
          parentEntityId: requestBody.parentEntityId
          orgGroupId: requestBody.orgGroupId
          taskTypeNameKey: requestBody.taskTypeNameKey
      - text: Add task {taskName} to {parentEntityId} for {assigneeEmail} due {deadline}.
        slots:
          taskName: requestBody.taskName
          parentEntityId: requestBody.parentEntityId
          assigneeEmail: requestBody.assigneeEmail
          deadline: requestBody.deadline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/task-management/v1/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task
      effect: read
      questions:
      - What is the status, priority and deadline of a task?
      - Can I look up one issue task by its ID?
      instructions:
      - text: Get task {taskId} of type {taskTypeNameKey}.
        slots:
          taskId: path.taskId
          taskTypeNameKey: query.taskTypeNameKey
      - text: Show the deadline of task {taskId}, type {taskTypeNameKey}.
        slots:
          taskId: path.taskId
          taskTypeNameKey: query.taskTypeNameKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/task-management/v1/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a task
      effect: write
      questions:
      - Can I change a task's status, assignee or priority?
      - Is it possible to push back a task's deadline?
      instructions:
      - text: Update task {taskId} of type {taskTypeNameKey}, naming it {taskName}.
        slots:
          taskId: path.taskId
          taskTypeNameKey: query.taskTypeNameKey
          taskName: requestBody.taskName
      - text: Set task {taskId} ({taskTypeNameKey}) {taskName} to status {status}.
        slots:
          taskId: path.taskId
          taskTypeNameKey: query.taskTypeNameKey
          taskName: requestBody.taskName
          status: requestBody.status
      method: generated
      generated: '2026-09-26'