# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Testflinger Client Permissions API
  version: 1.0.0
extends: openapi/canonical-client-permissions-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/client-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all client permissions
      effect: read
      questions:
      - Which clients have permissions on the Testflinger server?
      - What priority and reservation limits does every client have?
      instructions:
      - text: List every client's permissions.
      - text: Show all client IDs with their roles and limits.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-permissions/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one client's permissions
      effect: read
      questions:
      - What is the maximum priority a particular client may use?
      - Which role is assigned to a given client ID?
      instructions:
      - text: Show the permissions for client {client_id}.
        slots:
          client_id: path.client_id
      - text: Get the role and limits of client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-permissions/{client_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update client permissions
      effect: write
      questions:
      - How do I grant a client a higher job priority?
      - Can I set a maximum reservation time for a client?
      instructions:
      - text: Set client {client_id} max priority to {max_priority}.
        slots:
          client_id: path.client_id
          max_priority: requestBody.max_priority
      - text: Create client {client_id} with role {role} and email {email}.
        slots:
          client_id: path.client_id
          role: requestBody.role
          email: requestBody.email
      - text: Allow client {client_id} reservations of up to {max_reservation_time}.
        slots:
          client_id: path.client_id
          max_reservation_time: requestBody.max_reservation_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-permissions/{client_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a client and its permissions
      effect: destructive
      questions:
      - How do I remove a client ID entirely?
      - What happens to a client's permissions when it is deleted?
      instructions:
      - text: Delete client {client_id} and its permissions.
        slots:
          client_id: path.client_id
      - text: Remove client ID {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'