# 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 Documentrequest API
  version: 1.0.0
extends: openapi/adobe-suite-document-request-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/documentrequest/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one document request
      effect: read
      questions:
      - How do I see the details of a single document request?
      - Can I fetch one document request with selected fields?
      instructions:
      - text: Show document request {id}.
        slots:
          id: path.id
      - text: Get document request {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a document request
      effect: write
      questions:
      - Can I change an existing request for a document?
      - What call edits one document request by ID?
      instructions:
      - text: Edit document request {id} with my changes.
        slots:
          id: path.id
      - text: Update document request {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document request
      effect: destructive
      questions:
      - How do I cancel and remove a document request?
      - Is there a force flag for deleting a document request?
      instructions:
      - text: Delete document request {id}.
        slots:
          id: path.id
      - text: Force-delete document request {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several document requests by ID
      effect: read
      questions:
      - Can I retrieve multiple document requests at once by ID?
      - Which call returns a batch of known document requests?
      instructions:
      - text: Fetch document requests {id}.
        slots:
          id: query.id
      - text: Get document requests {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many document requests at once
      effect: write
      questions:
      - Is there a bulk edit for document requests?
      - Can I change a group of document requests in one request?
      instructions:
      - text: Bulk edit these document requests with my changes.
      - text: Update several document requests and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a document from someone
      effect: write
      questions:
      - How do I ask a teammate to provide a document in Workfront?
      - Can I create a document request and get fields back?
      instructions:
      - text: Create a new document request.
      - text: Create a document request and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many document requests
      effect: destructive
      questions:
      - Can I delete several document requests at once?
      - What does force do in a bulk delete of document requests?
      instructions:
      - text: Delete document requests {id}.
        slots:
          id: query.id
      - text: Bulk delete document requests {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count document requests
      effect: read
      questions:
      - How many document requests are outstanding?
      - Can I count document requests matching a filter?
      instructions:
      - text: Count all document requests.
      - text: Count document requests matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search document requests
      effect: read
      questions:
      - Which document requests match given criteria?
      - Can I search document requests and page the results?
      instructions:
      - text: Search document requests where {filters}.
        slots:
          filters: query.filters
      - text: Find document requests matching {filters} returning {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentrequest/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a document request report
      effect: read
      questions:
      - Can I get grouped totals across document requests?
      - What does an aggregated document request report show?
      instructions:
      - text: Run a document request report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a document request report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'