# 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 Documentfolder API
  version: 1.0.0
extends: openapi/adobe-suite-documentfolder-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: 23
- target: $.paths['/documentfolder/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document folder
      effect: read
      questions:
      - How do I look up a single document folder by its ID in Workfront?
      - Can I pick which fields come back when I fetch one folder?
      instructions:
      - text: Get document folder {id}.
        slots:
          id: path.id
      - text: Fetch folder {id} returning only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a document folder
      effect: write
      questions:
      - Can I rename or change the details of one existing document folder?
      - What call updates a single folder and hands back selected fields?
      instructions:
      - text: Edit document folder {id} with the changes I give you.
        slots:
          id: path.id
      - text: Update folder {id} and return its {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document folder
      effect: destructive
      questions:
      - How do I remove one document folder?
      - Is there a force option for deleting a folder that won't delete normally?
      instructions:
      - text: Delete document folder {id}.
        slots:
          id: path.id
      - text: Force-delete folder {id} with force set to {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several document folders by ID
      effect: read
      questions:
      - Can I fetch a batch of document folders at once when I already have their IDs?
      - What's the way to retrieve multiple folders together instead of one at a time?
      instructions:
      - text: Get the document folders with IDs {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch folders {ids} with just the fields {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many document folders in one request
      effect: write
      questions:
      - Can I update a whole set of document folders in a single request?
      - Is bulk editing of folders supported rather than editing each one?
      instructions:
      - text: Bulk edit the document folders I list with the changes I provide.
      - text: Apply my edits to several folders at once and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document folder
      effect: write
      questions:
      - How do I create a new document folder in Workfront?
      - Can I make a folder and choose which of its fields come back?
      instructions:
      - text: Create a new document folder with the name I give you.
      - text: Add a document folder and return its {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several document folders at once
      effect: destructive
      questions:
      - Can I delete a batch of document folders in one call?
      - What happens if I force a bulk delete of folders?
      instructions:
      - text: Delete the document folders {ids}.
        slots:
          ids: query.id
      - text: Bulk force-delete folders {ids} with force {force}.
        slots:
          ids: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count document folders
      effect: read
      questions:
      - How many document folders do we have?
      - Can I count only the folders that match a filter?
      instructions:
      - text: Count all my document folders.
      - text: Tell me how many folders match the filter {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search document folders
      effect: read
      questions:
      - How can I find document folders matching certain conditions?
      - Can a folder search be sorted or paged with list options?
      instructions:
      - text: Search document folders matching {filters}.
        slots:
          filters: query.filters
      - text: Find folders where {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on document folders
      effect: read
      questions:
      - Can I generate a report of document folders grouped or aggregated?
      - What report data can I pull on folders filtered by conditions?
      instructions:
      - text: Run a document folder report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a folder report using list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a document folder with a user or team
      effect: write
      questions:
      - How do I share one document folder with a specific user or team?
      - Can I grant view access to a folder but forbid certain actions?
      instructions:
      - text: Share folder {id} with {accessorObjCode} {accessorID} giving {coreAction} access.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Give {accessorID} ({accessorObjCode}) {coreAction} on folder {id} but block {forbiddenActions}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/share'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several document folders at once
      effect: write
      questions:
      - Can I share multiple document folders with the same person in one go?
      - Is there a batch way to grant a team access to many folders?
      instructions:
      - text: Share folders {ids} with {accessorObjCode} {accessorID} at {coreAction} level.
        slots:
          ids: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
      - text: Batch-share folders {ids} to {accessorID} ({accessorObjCode}) as {coreAction}, forbidding {forbiddenActions}.
        slots:
          ids: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing a document folder with someone
      effect: destructive
      questions:
      - How do I revoke one person's access to a document folder?
      - Can I remove a team from a folder's sharing list?
      instructions:
      - text: Unshare folder {id} from {accessorObjCode} {accessorID}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Revoke {accessorID}'s access to document folder {id}; they are a {accessorObjCode}.
        slots:
          id: path.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/unshare'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop sharing several document folders at once
      effect: destructive
      questions:
      - Can I pull someone's access from a whole batch of folders in one call?
      - What's the bulk way to unshare many document folders from a team?
      instructions:
      - text: Unshare folders {ids} from {accessorObjCode} {accessorID}.
        slots:
          ids: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      - text: Batch-revoke access for {accessorID} ({accessorObjCode}) across document folders {ids}.
        slots:
          ids: query.id
          accessorObjCode: query.accessorObjCode
          accessorID: query.accessorID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Share a document folder publicly
      effect: write
      questions:
      - How do I make one document folder publicly accessible?
      - Can a public folder share restrict what outside viewers are allowed to do?
      instructions:
      - text: Publicly share folder {id} with {coreAction} access.
        slots:
          id: path.id
          coreAction: query.coreAction
      - text: Make document folder {id} public as {coreAction} while forbidding {forbiddenActions}.
        slots:
          id: path.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/sharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Share several document folders publicly
      effect: write
      questions:
      - Can I make a batch of document folders public at the same time?
      - Is there a bulk public-share option for folders with limited permissions?
      instructions:
      - text: Publicly share folders {ids} with {coreAction} access.
        slots:
          ids: query.id
          coreAction: query.coreAction
      - text: Make document folders {ids} public as {coreAction}, blocking {forbiddenActions}.
        slots:
          ids: query.id
          coreAction: query.coreAction
          forbiddenActions: query.forbiddenActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/{id}/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from a document folder
      effect: destructive
      questions:
      - How do I turn off the public link on one document folder?
      - Can I make a publicly shared folder private again?
      instructions:
      - text: Remove public sharing from folder {id}.
        slots:
          id: path.id
      - text: Make document folder {id} private again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/unsharePublic'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove public sharing from several folders
      effect: destructive
      questions:
      - Can I take a batch of document folders off public sharing at once?
      - What's the bulk way to make many public folders private?
      instructions:
      - text: Remove public sharing from folders {ids}.
        slots:
          ids: query.id
      - text: Make document folders {ids} private in one batch.
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/getFolderSizeInBytes'].put
  update:
    x-apievangelist-phrasing:
      intent: Get a document folder's size in bytes
      effect: read
      questions:
      - How much storage does a document folder use?
      - Can the folder size include subfolders and linked folders?
      instructions:
      - text: Tell me the size in bytes of folder {folderID}.
        slots:
          folderID: query.folderID
      - text: Calculate the size of folder {folderID} with recursive {recursive} and includeLinked {includeLinked}.
        slots:
          folderID: query.folderID
          recursive: query.recursive
          includeLinked: query.includeLinked
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/isLinkedFolder'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether a folder is a linked folder
      effect: read
      questions:
      - Is this document folder linked from an external storage source?
      - Can I tell if a folder is linked rather than native to Workfront?
      instructions:
      - text: Check whether document folder {documentFolderID} is a linked folder.
        slots:
          documentFolderID: query.documentFolderID
      - text: Tell me if {documentFolderID} is linked.
        slots:
          documentFolderID: query.documentFolderID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/isSmartFolder'].put
  update:
    x-apievangelist-phrasing:
      intent: Check whether a folder is a smart folder
      effect: read
      questions:
      - Is a given document folder a smart folder?
      - What call tells me if a folder is a smart folder?
      instructions:
      - text: Check whether document folder {documentFolderID} is a smart folder.
        slots:
          documentFolderID: query.documentFolderID
      - text: Tell me if {documentFolderID} is smart.
        slots:
          documentFolderID: query.documentFolderID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/unlinkFolders'].put
  update:
    x-apievangelist-phrasing:
      intent: Unlink linked document folders
      effect: destructive
      questions:
      - How do I unlink folders that were linked in from external storage?
      - Can I unlink several linked folders in one request?
      instructions:
      - text: Unlink folders {ids}.
        slots:
          ids: query.ids
      - text: Disconnect the linked document folders {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentfolder/myFolders'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own document folders
      effect: read
      questions:
      - Which document folders belong to me?
      - Can I see just my folders without building a search filter?
      instructions:
      - text: List my document folders.
      - text: Show the document folders owned by the signed-in user.
      method: generated
      generated: '2026-09-26'