Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Testflinger Restricted Queues API

5 actions 5 updates phrasing extends openapi/canonical-restricted-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 5

$.info
$.paths['/v1/restricted-queues'].get
$.paths['/v1/restricted-queues/{queue_name}'].get
$.paths['/v1/restricted-queues/{queue_name}'].post
$.paths['/v1/restricted-queues/{queue_name}'].delete

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 Restricted Queues API
  version: 1.0.0
extends: openapi/canonical-restricted-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: 4
- target: $.paths['/v1/restricted-queues'].get
  update:
    x-apievangelist-phrasing:
      intent: List restricted queues and owners
      effect: read
      questions:
      - Which queues are restricted, and who owns them?
      - Can I see every restricted queue at once?
      instructions:
      - text: List all restricted queues and their owners.
      - text: Show who owns each restricted queue.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/restricted-queues/{queue_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a restricted queue's owners
      effect: read
      questions:
      - Who is allowed to use a particular restricted queue?
      - Is a given queue restricted?
      instructions:
      - text: Show the owners of restricted queue {queue_name}.
        slots:
          queue_name: path.queue_name
      - text: Get restriction details for queue {queue_name}.
        slots:
          queue_name: path.queue_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/restricted-queues/{queue_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an owner to a restricted queue
      effect: write
      questions:
      - How do I give a client access to a restricted queue?
      - Can a restricted queue have more than one owner?
      instructions:
      - text: Add client {client_id} as an owner of restricted queue {queue_name}.
        slots:
          client_id: requestBody.client_id
          queue_name: path.queue_name
      - text: Grant {client_id} ownership of queue {queue_name}.
        slots:
          client_id: requestBody.client_id
          queue_name: path.queue_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/restricted-queues/{queue_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an owner from a restricted queue
      effect: destructive
      questions:
      - How do I take a client's access away from a restricted queue?
      - What happens when I remove an owner from a restricted queue?
      instructions:
      - text: Remove client {client_id} as owner of restricted queue {queue_name}.
        slots:
          client_id: requestBody.client_id
          queue_name: path.queue_name
      - text: Revoke {client_id}'s ownership of queue {queue_name}.
        slots:
          client_id: requestBody.client_id
          queue_name: path.queue_name
      method: generated
      generated: '2026-10-01'