Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Queuedef API

9 actions 9 updates phrasing extends openapi/adobe-suite-queuedef-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/queuedef/{id}'].get
$.paths['/queuedef'].get
$.paths['/queuedef/count'].get
$.paths['/queuedef/search'].get
$.paths['/queuedef/report'].get
$.paths['/queuedef/getQueueDefTree'].put
$.paths['/queuedef/searchByPath'].put
$.paths['/queuedef/queueTopics'].get

OpenAPI Overlay

Raw ↑
# 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 Queuedef API
  version: 1.0.0
extends: openapi/adobe-suite-queuedef-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: 8
- target: $.paths['/queuedef/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one request queue definition
      effect: read
      questions:
      - How do I read the setup of one Workfront request queue?
      - Can I choose which fields come back for a queue definition?
      instructions:
      - text: Show queue definition {id}.
        slots:
          id: path.id
      - text: Get request queue {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several queue definitions by ID
      effect: read
      questions:
      - Can I retrieve multiple request queue definitions by their IDs?
      - Which call returns a set of known queue definitions?
      instructions:
      - text: Fetch queue definitions {id}.
        slots:
          id: query.id
      - text: Get request queues {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count request queue definitions
      effect: read
      questions:
      - How many request queues match a filter?
      - Can I get the total number of queue definitions?
      instructions:
      - text: Count queue definitions matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many request queues exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search request queue definitions
      effect: read
      questions:
      - How do I find request queues by project or visibility?
      - Can I search queue definitions with filters and paging?
      instructions:
      - text: Search queue definitions where {filters}.
        slots:
          filters: query.filters
      - text: Find request queues matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on request queues
      effect: read
      questions:
      - Can I get grouped totals of request queue definitions?
      - What returns a report-style summary of queues?
      instructions:
      - text: Run a queue definition report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Summarize request queues as a report with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/getQueueDefTree'].put
  update:
    x-apievangelist-phrasing:
      intent: Get the topic tree of a request queue
      effect: read
      questions:
      - Can I see the full hierarchy of topics and groups in a request queue?
      - What does the tree structure of a queue look like?
      instructions:
      - text: Get the queue tree for {name}.
        slots:
          name: query.name
      - text: Show the topic hierarchy of request queue {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/searchByPath'].put
  update:
    x-apievangelist-phrasing:
      intent: Find request queues by path name
      effect: read
      questions:
      - Can I look up a queue by typing part of its path name?
      - Is there a limit on how many queue path matches come back?
      instructions:
      - text: Search queues by path for {name}.
        slots:
          name: query.name
      - text: Find up to {limit} queue paths matching {name}.
        slots:
          name: query.name
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuedef/queueTopics'].get
  update:
    x-apievangelist-phrasing:
      intent: List topics defined in request queues
      effect: read
      questions:
      - Which topics are available in my request queues?
      - Can I filter the list of queue topics?
      instructions:
      - text: List queue topics matching {filters}.
        slots:
          filters: query.filters
      - text: Show all the request queue topics.
      method: generated
      generated: '2026-09-26'