# 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 Documentversion API
  version: 1.0.0
extends: openapi/adobe-suite-documentversion-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: 9
- target: $.paths['/documentversion/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document version
      effect: read
      questions:
      - How do I look up a single document version in Workfront?
      - Can I pick which fields to return for a document version?
      instructions:
      - text: Show document version {id}.
        slots:
          id: path.id
      - text: Get document version {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several document versions by ID
      effect: read
      questions:
      - Can I load multiple document versions at once by ID?
      - Is there a bulk get for document versions?
      instructions:
      - text: Fetch document versions {id}.
        slots:
          id: query.id
      - text: Bulk-load document versions {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document version
      effect: write
      questions:
      - How do I add a new version to a document?
      - Can I upload a new document version record through the API?
      instructions:
      - text: Create a new document version.
      - text: Add a document version and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count document versions
      effect: read
      questions:
      - How many document versions match a filter?
      - Can I count versions without listing them?
      instructions:
      - text: Count document versions matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me the total number of document versions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search document versions
      effect: read
      questions:
      - What's the way to search document versions by field?
      - Can I sort and page document version search results?
      instructions:
      - text: Search document versions where {filters}.
        slots:
          filters: query.filters
      - text: Find document versions matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on document versions
      effect: read
      questions:
      - Can I produce an aggregate report over document versions?
      - How do I group document versions in a report?
      instructions:
      - text: Run a document version report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a document version report with options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/getDocumentReviewerDecision'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the reviewer decision on a document version
      effect: read
      questions:
      - What did the reviewer decide on this document version?
      - Can I check whether a document version was approved by its reviewer?
      instructions:
      - text: Get the reviewer decision for document version {documentVersionID}.
        slots:
          documentVersionID: query.documentVersionID
      - text: Show the review outcome of document version {documentVersionID}.
        slots:
          documentVersionID: query.documentVersionID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/getProofingTokens'].put
  update:
    x-apievangelist-phrasing:
      intent: Get proofing tokens for a document version
      effect: read
      questions:
      - How do I obtain proofing tokens to open a document version in proofing?
      - Can I get the proof access tokens for a specific version?
      instructions:
      - text: Get proofing tokens for version {versionID}.
        slots:
          versionID: query.versionID
      - text: Fetch the proof tokens for document version {versionID}.
        slots:
          versionID: query.versionID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documentversion/setDocumentReviewerDecision'].put
  update:
    x-apievangelist-phrasing:
      intent: Record a reviewer decision on a document version
      effect: write
      questions:
      - How do I approve or reject a document version as its reviewer?
      - Can I add a comment along with my review decision?
      instructions:
      - text: Set my decision on document version {documentVersionID} to {reviewerDecision}.
        slots:
          documentVersionID: query.documentVersionID
          reviewerDecision: query.reviewerDecision
      - text: Record {reviewerDecision} on version {documentVersionID} with comment {comment}.
        slots:
          reviewerDecision: query.reviewerDecision
          documentVersionID: query.documentVersionID
          comment: query.comment
      method: generated
      generated: '2026-09-26'