API Evangelist conversational phrasing for Adobe Workfront Externaldocument 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 Externaldocument API
  version: 1.0.0
extends: openapi/adobe-suite-externaldocument-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['/externaldocument/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search external document records with filters
      effect: read
      questions:
      - How do I query Workfront's external document records using filter conditions?
      - Can I page and pick fields when searching external document objects?
      instructions:
      - text: Search external document records where {filters}.
        slots:
          filters: query.filters
      - text: Find external document objects matching {filters} returning {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/browseListWithLinkAction'].put
  update:
    x-apievangelist-phrasing:
      intent: Browse a document provider with a link action
      effect: read
      questions:
      - Can I browse a connected document provider's files while preparing a link action?
      - How do I load breadcrumbs while browsing an external provider for linking?
      instructions:
      - text: Browse provider {documentProviderID} of type {providerType} for link action {linkAction}.
        slots:
          documentProviderID: query.documentProviderID
          providerType: query.providerType
          linkAction: query.linkAction
      - text: Browse {providerType} with {searchParams} and loadBreadcrumbs={loadBreadcrumbs} for linking.
        slots:
          providerType: query.providerType
          searchParams: query.searchParams
          loadBreadcrumbs: query.loadBreadcrumbs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/getDocumentDownloadUrl'].put
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for an external document
      effect: read
      questions:
      - How do I get a download link for a file stored in a connected document provider?
      - Can I get a URL to open an external document rather than download it?
      instructions:
      - text: Get the download URL for document {documentID} in provider {documentProviderID}.
        slots:
          documentID: query.documentID
          documentProviderID: query.documentProviderID
      - text: Get an open link (isOpen={isOpen}) for {providerType} document {documentID}.
        slots:
          isOpen: query.isOpen
          providerType: query.providerType
          documentID: query.documentID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/getRootFolderID'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the root folder ID from a document provider
      effect: read
      questions:
      - How do I find the root folder of a connected external document provider?
      - What is the top-level folder ID for my linked storage provider?
      instructions:
      - text: Get the root folder ID for provider {documentProviderID} of type {providerType}.
        slots:
          documentProviderID: query.documentProviderID
          providerType: query.providerType
      - text: Look up the top folder in {providerType} storage.
        slots:
          providerType: query.providerType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/getRootFolderIDFromDB'].put
  update:
    x-apievangelist-phrasing:
      intent: Get a provider's stored root folder ID
      effect: read
      questions:
      - Can I read the root folder ID Workfront already has saved for a document provider?
      - Where is the cached root folder for a provider stored?
      instructions:
      - text: Get the saved root folder ID for provider {documentProviderID} from the database.
        slots:
          documentProviderID: query.documentProviderID
      - text: Read the stored root folder of document provider {documentProviderID}.
        slots:
          documentProviderID: query.documentProviderID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/linkExternalDocumentObjects'].put
  update:
    x-apievangelist-phrasing:
      intent: Link external documents to a Workfront object
      effect: write
      questions:
      - How do I attach files from a connected storage provider to a project or task?
      - Can I link external documents into a specific destination folder with proofing options?
      instructions:
      - text: Link {objects} from provider {documentProviderID} to {refObjCode} {refObjID}.
        slots:
          objects: query.objects
          documentProviderID: query.documentProviderID
          refObjCode: query.refObjCode
          refObjID: query.refObjID
      - text: Link external documents to {refObjCode} {refObjID} into folder {destFolderID}.
        slots:
          refObjCode: query.refObjCode
          refObjID: query.refObjID
          destFolderID: query.destFolderID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/setLinkedFolderMetadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Set metadata for a linked external folder
      effect: write
      questions:
      - How do I tie an external storage folder to a project as its linked folder?
      - Can I update the linked folder metadata for a document provider?
      instructions:
      - text: Set linked folder {externalStorageID} for project {projectID} on provider {documentProviderID}.
        slots:
          externalStorageID: query.externalStorageID
          projectID: query.projectID
          documentProviderID: query.documentProviderID
      - text: Save linked folder metadata for {providerType} folder {externalStorageID}.
        slots:
          providerType: query.providerType
          externalStorageID: query.externalStorageID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/browseList'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse files in an external document provider
      effect: read
      questions:
      - How do I list the files and folders in a connected storage provider?
      - Can I filter what shows up when browsing an external provider?
      instructions:
      - text: Browse files in provider {documentProviderID}.
        slots:
          documentProviderID: query.documentProviderID
      - text: Browse {providerType} with search params {searchParams}.
        slots:
          providerType: query.providerType
          searchParams: query.searchParams
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/getFolderMetaData'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for an external folder
      effect: read
      questions:
      - How do I get details about a specific folder in a connected document provider?
      - Can I check folder metadata for a folder linked to a project?
      instructions:
      - text: Get metadata for folder {folderID} in provider {documentProviderID}.
        slots:
          folderID: query.folderID
          documentProviderID: query.documentProviderID
      - text: Show linked-folder metadata for {providerType} folder {folderID} (isForLinkedFolder={isForLinkedFolder}).
        slots:
          providerType: query.providerType
          folderID: query.folderID
          isForLinkedFolder: query.isForLinkedFolder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externaldocument/searchExternalDocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: Search files inside an external storage provider
      effect: read
      questions:
      - How do I search for a file by name inside my connected cloud storage?
      - Can I limit a provider file search to one folder?
      instructions:
      - text: Search provider {documentProviderID} for files named {searchString}.
        slots:
          documentProviderID: query.documentProviderID
          searchString: query.searchString
      - text: Search {providerType} folder {searchInFolder} for {searchString}, {limit} at a time.
        slots:
          providerType: query.providerType
          searchInFolder: query.searchInFolder
          searchString: query.searchString
          limit: query.limit
      method: generated
      generated: '2026-09-26'