Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Testflinger Queues API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/queues/wait_times'].get
$.paths['/v1/queues/{queue_name}/jobs'].get
$.paths['/v1/queues/{queue_name}/agents'].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 Testflinger Queues API
  version: 1.0.0
extends: openapi/canonical-queues-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: 3
- target: $.paths['/v1/queues/wait_times'].get
  update:
    x-apievangelist-phrasing:
      intent: Get queue wait times
      effect: read
      questions:
      - How long do jobs typically wait before they start on each queue?
      - Which queue has the shortest wait right now?
      instructions:
      - text: Show wait time metrics for all queues.
      - text: Get the job wait time statistics per queue.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/queues/{queue_name}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs in a queue
      effect: read
      questions:
      - Which jobs are sitting in a particular queue and what state are they in?
      - Is a given queue backed up with waiting jobs?
      instructions:
      - text: List the jobs in queue {queue_name}.
        slots:
          queue_name: path.queue_name
      - text: Show the state of every job on queue {queue_name}.
        slots:
          queue_name: path.queue_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/queues/{queue_name}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List agents serving a queue
      effect: read
      questions:
      - Which agents are listening on a particular queue?
      - Are any devices online to run jobs from a given queue?
      instructions:
      - text: List the agents listening to queue {queue_name}.
        slots:
          queue_name: path.queue_name
      - text: Show data for all agents serving queue {queue_name}.
        slots:
          queue_name: path.queue_name
      method: generated
      generated: '2026-10-01'