Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Workload Management Queues API

5 actions 5 updates phrasing extends openapi/automation-anywhere-queues-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/queues/{id}'].get
$.paths['/queues/{id}/consumers'].post
$.paths['/queues/{id}/members/{userId}'].put
$.paths['/queues/{id}/participants'].post

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 Automation Anywhere Workload Management Queues API
  version: 1.0.0
extends: openapi/automation-anywhere-queues-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: 4
- target: $.paths['/queues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a work item queue's details
      effect: read
      questions:
      - What is the configuration and status of a specific work item queue?
      - Which work item model and processing order does a queue use?
      instructions:
      - text: Show the details of queue {id}.
        slots:
          id: path.id
      - text: Get the work item model and status for queue {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queues/{id}/consumers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a role as a queue consumer
      effect: write
      questions:
      - How do I let bots under a role process work items from a queue?
      - Who is allowed to add consumer roles to a queue?
      instructions:
      - text: Add role {roleId} as a consumer of queue {id}.
        slots:
          roleId: requestBody.roleId
          id: path.id
      - text: Let bots in role {roleId} work items from queue {id}.
        slots:
          roleId: requestBody.roleId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queues/{id}/members/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or change a queue member
      effect: write
      questions:
      - Can I make a user an owner or member of a work item queue?
      - Is it possible to change a person's membership role on an existing queue?
      instructions:
      - text: Make user {userId} a {role} of queue {id}.
        slots:
          userId: path.userId
          role: requestBody.role
          id: path.id
      - text: Add user {userId} as a member of queue {id}.
        slots:
          userId: path.userId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/queues/{id}/participants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a participant to a queue
      effect: write
      questions:
      - Can I give someone view-only style access to a queue's status and work items?
      - What can a queue participant do compared to an owner?
      instructions:
      - text: Add user {userId} as a participant of queue {id}.
        slots:
          userId: requestBody.userId
          id: path.id
      - text: Let user {userId} watch queue {id} as a participant.
        slots:
          userId: requestBody.userId
          id: path.id
      method: generated
      generated: '2026-09-26'