# 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 Workitem API
  version: 1.0.0
extends: openapi/adobe-suite-workitem-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: 10
- target: $.paths['/workitem/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single work item
      effect: read
      questions:
      - How do I look up one work item from someone's work list by ID?
      - Can I choose which fields come back for a work item?
      instructions:
      - text: Show me work item {id}.
        slots:
          id: path.id
      - text: Fetch work item {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single work item
      effect: write
      questions:
      - How can I update one work item?
      - Is it possible to edit a work item and return specific fields?
      instructions:
      - text: Edit work item {id}.
        slots:
          id: path.id
      - text: Update work item {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single work item
      effect: destructive
      questions:
      - How do I delete one work item?
      - Can I force the removal of a work item?
      instructions:
      - text: Delete work item {id}.
        slots:
          id: path.id
      - text: Force delete work item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several work items by ID
      effect: read
      questions:
      - Can I fetch multiple work items in one call?
      - What's the quickest way to load a known set of work items?
      instructions:
      - text: Get work items {id}.
        slots:
          id: query.id
      - text: Bulk fetch work items {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many work items in one request
      effect: write
      questions:
      - Is there a bulk edit for work items?
      - Can I update a batch of work items together?
      instructions:
      - text: Bulk edit the work items I send.
      - text: Apply edits to multiple work items and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several work items at once
      effect: destructive
      questions:
      - Can I bulk delete work items by ID?
      - Does bulk work item deletion support a force flag?
      instructions:
      - text: Delete work items {id} in bulk.
        slots:
          id: query.id
      - text: Bulk force-delete work items {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count work items
      effect: read
      questions:
      - How many work items are in the system?
      - Can I count only the work items that match a filter?
      instructions:
      - text: Count all work items.
      - text: Count work items matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search work items with filters
      effect: read
      questions:
      - How do I search work items assigned to a particular user?
      - Can I page through work item search results?
      instructions:
      - text: Search work items where {filters}.
        slots:
          filters: query.filters
      - text: Find work items matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on work items
      effect: read
      questions:
      - Can I get grouped report data about work items?
      - What does a filtered work item report return?
      instructions:
      - text: Run a work item report.
      - text: Report on work items filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workitem/markViewed'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a work item as viewed
      effect: write
      questions:
      - How do I clear the new indicator on a work item once I've seen it?
      - Can I flag a work item as viewed through the API?
      instructions:
      - text: Mark work item {ID} as viewed.
        slots:
          ID: query.ID
      - text: Flag work item {ID} as seen.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'