API Evangelist conversational phrasing for Adobe Workfront Assignment API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Assignment API
  version: 1.0.0
extends: openapi/adobe-suite-assignment-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: 18
- target: $.paths['/assignment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one work assignment
      effect: read
      questions:
      - How do I see who a specific assignment in Workfront is given to?
      - Can I fetch one assignment record with only certain fields?
      instructions:
      - text: Show assignment {id}.
        slots:
          id: path.id
      - text: Get assignment {id} returning {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one assignment
      effect: write
      questions:
      - Can I change an existing assignment record by its ID?
      - What call edits a single task or issue assignment?
      instructions:
      - text: Edit assignment {id} with my changes.
        slots:
          id: path.id
      - text: Update assignment {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one assignment
      effect: destructive
      questions:
      - How do I remove a single assignment record?
      - Is there a force flag when deleting an assignment?
      instructions:
      - text: Delete assignment {id}.
        slots:
          id: path.id
      - text: Force-delete assignment {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several assignments by ID
      effect: read
      questions:
      - Can I load multiple assignments at once when I know their IDs?
      - Which request returns a batch of specific assignments?
      instructions:
      - text: Fetch assignments {id}.
        slots:
          id: query.id
      - text: Get assignments {id} with only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many assignments at once
      effect: write
      questions:
      - Is there a bulk edit for assignment records?
      - Can I change a set of assignments in one request?
      instructions:
      - text: Bulk edit these assignments with my changes.
      - text: Apply updates to several assignments and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an assignment
      effect: write
      questions:
      - How do I create a new assignment record?
      - Can I create an assignment and get chosen fields back?
      instructions:
      - text: Create a new assignment.
      - text: Create an assignment and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many assignments at once
      effect: destructive
      questions:
      - Can I bulk delete a list of assignments?
      - What does force do when deleting several assignments?
      instructions:
      - text: Delete assignments {id}.
        slots:
          id: query.id
      - text: Bulk delete assignments {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count assignments matching filters
      effect: read
      questions:
      - How many assignments exist in Workfront right now?
      - Can I count only assignments that match a filter, like one user's?
      instructions:
      - text: Count all assignments.
      - text: Count assignments matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search assignments by criteria
      effect: read
      questions:
      - Which assignments match a set of filters?
      - Can I search assignments and page through what comes back?
      instructions:
      - text: Search assignments where {filters}.
        slots:
          filters: query.filters
      - text: Find assignments matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregated assignment report
      effect: read
      questions:
      - Can I get a grouped report of assignments rather than individual records?
      - What totals can an assignment report give me?
      instructions:
      - text: Run an assignment report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build an assignment report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/assignUserToRoleOnProjects'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a user to a role across projects
      effect: write
      questions:
      - How do I put a user into a job role on several projects at once?
      - Can I include issues when assigning a user to a role on projects?
      instructions:
      - text: Assign user {swapUserID} to role {swapRoleID} on projects {projectIDs}.
        slots:
          swapUserID: query.swapUserID
          swapRoleID: query.swapRoleID
          projectIDs: query.projectIDs
      - text: 'Assign {swapUserID} to role {swapRoleID} on projects {projectIDs}, including issues: {includeIssues}.'
        slots:
          swapUserID: query.swapUserID
          swapRoleID: query.swapRoleID
          projectIDs: query.projectIDs
          includeIssues: query.includeIssues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/assignUserToRoleOnTasks'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a user to a role on specific tasks
      effect: write
      questions:
      - Can I assign someone to a role on a list of tasks rather than whole projects?
      - How do I lock a user to a role when assigning them to tasks?
      instructions:
      - text: Assign user {swapUserID} to role {swapRoleID} on tasks {taskIDs}.
        slots:
          swapUserID: query.swapUserID
          swapRoleID: query.swapRoleID
          taskIDs: query.taskIDs
      - text: Put {swapUserID} on tasks {taskIDs} as role {swapRoleID} with lock-to-role {lockToRole}.
        slots:
          swapUserID: query.swapUserID
          taskIDs: query.taskIDs
          swapRoleID: query.swapRoleID
          lockToRole: query.lockToRole
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/swapUsersOnProjects'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace one user with another across projects
      effect: write
      questions:
      - How do I hand over all of one person's project work to someone else?
      - Can I swap users on projects only for certain roles?
      instructions:
      - text: Swap {swapFromUserID} for {swapToUserID} on projects {projectIDs}.
        slots:
          swapFromUserID: query.swapFromUserID
          swapToUserID: query.swapToUserID
          projectIDs: query.projectIDs
      - text: Replace {swapFromUserID} with {swapToUserID} on projects {projectIDs} for roles {swapRoleIDs}.
        slots:
          swapFromUserID: query.swapFromUserID
          swapToUserID: query.swapToUserID
          projectIDs: query.projectIDs
          swapRoleIDs: query.swapRoleIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/swapUsersOnTasks'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace one user with another on tasks
      effect: write
      questions:
      - Can I reassign a set of tasks from one user to another in one step?
      - Does swapping users on tasks also cover issues?
      instructions:
      - text: Swap {swapFromUserID} for {swapToUserID} on tasks {taskIDs}.
        slots:
          swapFromUserID: query.swapFromUserID
          swapToUserID: query.swapToUserID
          taskIDs: query.taskIDs
      - text: 'Move tasks {taskIDs} from {swapFromUserID} to {swapToUserID}, including issues: {includeIssues}.'
        slots:
          taskIDs: query.taskIDs
          swapFromUserID: query.swapFromUserID
          swapToUserID: query.swapToUserID
          includeIssues: query.includeIssues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/unassignUserFromProjects'].put
  update:
    x-apievangelist-phrasing:
      intent: Unassign a user from projects
      effect: destructive
      questions:
      - How do I take a person off several projects at once?
      - Can I unassign a user from projects but only for certain roles?
      instructions:
      - text: Unassign user {unassignUserID} from projects {projectIDs}.
        slots:
          unassignUserID: query.unassignUserID
          projectIDs: query.projectIDs
      - text: Remove {unassignUserID} from projects {projectIDs} in roles {swapRoleIDs}.
        slots:
          unassignUserID: query.unassignUserID
          projectIDs: query.projectIDs
          swapRoleIDs: query.swapRoleIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/unassignUserFromTasks'].put
  update:
    x-apievangelist-phrasing:
      intent: Unassign a user from tasks
      effect: destructive
      questions:
      - Can I pull someone off a list of tasks in a single call?
      - Does unassigning a user from tasks touch their issues too?
      instructions:
      - text: Unassign user {unassignUserID} from tasks {taskIDs}.
        slots:
          unassignUserID: query.unassignUserID
          taskIDs: query.taskIDs
      - text: 'Take {unassignUserID} off tasks {taskIDs}, including issues: {includeIssues}.'
        slots:
          unassignUserID: query.unassignUserID
          taskIDs: query.taskIDs
          includeIssues: query.includeIssues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/getAssignAssignmentsForTasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview assignments available to assign on tasks
      effect: read
      questions:
      - Which assignments on these tasks could be given to a user?
      - Can I check the assignable assignments for tasks before reassigning?
      instructions:
      - text: List the assignable assignments for tasks {taskIDs}.
        slots:
          taskIDs: query.taskIDs
      - text: 'Show assign candidates on tasks {taskIDs} with issues included: {includeIssues}.'
        slots:
          taskIDs: query.taskIDs
          includeIssues: query.includeIssues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assignment/getUnassignAssignmentsForTasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview assignments that can be unassigned on tasks
      effect: read
      questions:
      - Which current assignments on these tasks can be removed?
      - What would be unassigned if I cleared users from a set of tasks?
      instructions:
      - text: List the unassignable assignments on tasks {taskIDs}.
        slots:
          taskIDs: query.taskIDs
      - text: 'Show what could be unassigned on tasks {taskIDs}, issues included: {includeIssues}.'
        slots:
          taskIDs: query.taskIDs
          includeIssues: query.includeIssues
      method: generated
      generated: '2026-09-26'