Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Tasks API

7 actions 7 updates phrasing extends openapi/drata-tasks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/workspaces/{workspaceId}/tasks'].get
$.paths['/workspaces/{workspaceId}/tasks'].post
$.paths['/workspaces/{workspaceId}/tasks/{taskId}'].get
$.paths['/workspaces/{workspaceId}/tasks/{taskId}'].put
$.paths['/workspaces/{workspaceId}/tasks/{taskId}/actions'].post
$.paths['/workspaces/{workspaceId}/upcoming-tasks'].get

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 Drata Tasks API
  version: 1.0.0
extends: openapi/drata-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: 6
- target: $.paths['/workspaces/{workspaceId}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks in a workspace
      effect: read
      questions:
      - Which compliance tasks are assigned to a given person?
      - Can I find tasks due between two dates?
      - What tasks are linked to a specific control?
      instructions:
      - text: List tasks in workspace {workspace}.
        slots:
          workspace: path.workspaceId
      - text: Show tasks assigned to {assignee} in workspace {workspace}.
        slots:
          assignee: query.assigneeId
          workspace: path.workspaceId
      - text: Find tasks due between {from} and {to}.
        slots:
          from: query.dueDateFrom
          to: query.dueDateTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task
      effect: write
      questions:
      - How do I create a follow-up task with a due date?
      - Can a new task be tied to controls, risks or policies?
      instructions:
      - text: Create task {title} due {due_date} in workspace {workspace}.
        slots:
          title: requestBody.title
          due_date: requestBody.dueDate
          workspace: path.workspaceId
      - text: Add a task {title} due {due_date} and assign it to {assignee}.
        slots:
          title: requestBody.title
          due_date: requestBody.dueDate
          assignee: requestBody.assigneeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one task
      effect: read
      questions:
      - What are the details of a specific task?
      - Can I look up a task by its ID?
      instructions:
      - text: Get task {task} in workspace {workspace}.
        slots:
          task: path.taskId
          workspace: path.workspaceId
      - text: Show me task {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/tasks/{taskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a task
      effect: write
      questions:
      - Can I push back a task's due date?
      - Is it possible to reassign an existing task to someone else?
      instructions:
      - text: Move the due date of task {task} in workspace {workspace} to {due_date}.
        slots:
          task: path.taskId
          workspace: path.workspaceId
          due_date: requestBody.dueDate
      - text: Reassign task {task} to {assignee}.
        slots:
          task: path.taskId
          assignee: requestBody.assigneeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/tasks/{taskId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete or reopen a task
      effect: write
      questions:
      - How do I mark a task as done?
      - Can I undo completing a task?
      instructions:
      - text: Mark task {task} in workspace {workspace} as complete.
        slots:
          task: path.taskId
          workspace: path.workspaceId
      - text: Apply action {action} to task {task}.
        slots:
          action: requestBody.action
          task: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/upcoming-tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List upcoming Drata-assigned tasks
      effect: read
      questions:
      - What policy renewals and vendor reviews are coming due?
      - Which upcoming tasks has Drata generated for us this quarter?
      - Can I filter upcoming tasks by type?
      instructions:
      - text: List upcoming tasks for workspace {workspace}.
        slots:
          workspace: path.workspaceId
      - text: Show upcoming renewals and reviews in workspace {workspace} due before {to}.
        slots:
          workspace: path.workspaceId
          to: query.dueDateTo
      method: generated
      generated: '2026-09-26'