Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Queuetopic API

12 actions 12 updates phrasing extends openapi/adobe-suite-queuetopic-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 12

$.info
$.paths['/queuetopic/{id}'].get
$.paths['/queuetopic/{id}'].put
$.paths['/queuetopic/{id}'].delete
$.paths['/queuetopic'].get
$.paths['/queuetopic'].put
$.paths['/queuetopic'].post
$.paths['/queuetopic'].delete
$.paths['/queuetopic/count'].get
$.paths['/queuetopic/search'].get
$.paths['/queuetopic/report'].get
$.paths['/queuetopic/queueTopicByID'].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 Queuetopic API
  version: 1.0.0
extends: openapi/adobe-suite-queuetopic-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: 11
- target: $.paths['/queuetopic/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one request queue topic
      effect: read
      questions:
      - How do I read a Workfront request queue topic by ID?
      - Can I choose which fields come back for one queue topic?
      instructions:
      - text: Show me queue topic {id}.
        slots:
          id: path.id
      - text: Get queue topic {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single queue topic
      effect: write
      questions:
      - What call changes one request queue topic?
      - Can I update the default assignee on a single queue topic?
      instructions:
      - text: Update queue topic {id} with my changes.
        slots:
          id: path.id
      - text: Edit queue topic {id} and return fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single queue topic
      effect: destructive
      questions:
      - How do I remove one topic from a request queue?
      - Can I force-delete a queue topic that is in use?
      instructions:
      - text: Delete queue topic {id}.
        slots:
          id: path.id
      - text: Delete queue topic {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several queue topics by ID
      effect: read
      questions:
      - Can I load a list of queue topics by their IDs in one request?
      - Which call bulk-reads known request queue topics?
      instructions:
      - text: Fetch queue topics {id}.
        slots:
          id: query.id
      - text: Bulk get queue topics {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit queue topics
      effect: write
      questions:
      - How do I update several queue topics together?
      - Is there a bulk edit for request queue topics?
      instructions:
      - text: Bulk update these queue topics with the edits I give you.
      - text: Bulk edit the queue topics and return fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a request queue topic
      effect: write
      questions:
      - How do I add a new topic to a request queue?
      - What does the API return after creating a queue topic?
      instructions:
      - text: Create a queue topic with the details I provide.
      - text: Create a new queue topic and return fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete queue topics
      effect: destructive
      questions:
      - Can I delete several queue topics in one request?
      - How do I force-delete a batch of queue topics?
      instructions:
      - text: Delete queue topics {id}.
        slots:
          id: query.id
      - text: Bulk delete queue topics {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count queue topics
      effect: read
      questions:
      - How many queue topics match a filter?
      - Can I count request queue topics without listing them?
      instructions:
      - text: Count queue topics matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many queue topics exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search queue topics
      effect: read
      questions:
      - How do I find queue topics that match certain criteria?
      - Can I sort and page queue topic search results?
      instructions:
      - text: Search queue topics where {filters}.
        slots:
          filters: query.filters
      - text: Search queue topics matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on queue topics
      effect: read
      questions:
      - Can I get aggregated report data about queue topics?
      - What returns a grouped queue topic report?
      instructions:
      - text: Run a queue topic report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Report on queue topics using list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queuetopic/queueTopicByID'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a queue topic via the queueTopicByID action
      effect: read
      questions:
      - Is there a query-parameter lookup that resolves a queue topic ID?
      - Which action returns a queue topic when I pass queueTopicID as a query value?
      instructions:
      - text: Run the queueTopicByID lookup for {queueTopicID}.
        slots:
          queueTopicID: query.queueTopicID
      - text: Resolve queue topic {queueTopicID} using the queueTopicByID action.
        slots:
          queueTopicID: query.queueTopicID
      method: generated
      generated: '2026-09-26'