# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Objects Quarantined Devices API
  version: 1.0.0
extends: openapi/palo-alto-networks-quarantined-devices-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: 6
- target: $.paths['/quarantined-devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List quarantined devices
      effect: read
      questions:
      - Which devices are currently quarantined from GlobalProtect?
      - Is a device with a given serial number quarantined?
      instructions:
      - text: List quarantined devices.
      - text: Check if the device with serial number {serial_number} is quarantined.
        slots:
          serial_number: query.serial_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/quarantined-devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Quarantine a device
      effect: write
      questions:
      - How do I quarantine a compromised device?
      - Can I block a device by host ID and serial number?
      instructions:
      - text: Quarantine the device with host ID {host_id}.
        slots:
          host_id: requestBody.host_id
      - text: Quarantine host {host_id} with serial number {serial_number}.
        slots:
          host_id: requestBody.host_id
          serial_number: requestBody.serial_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/quarantined-devices'].delete
  update:
    x-apievangelist-phrasing:
      intent: Release a device from quarantine
      effect: destructive
      questions:
      - How do I take a device out of quarantine?
      - Can I remove a host from the quarantine list?
      instructions:
      - text: Release host {host_id} from quarantine.
        slots:
          host_id: query.host_id
      - text: Remove device {host_id} from the quarantined devices list.
        slots:
          host_id: query.host_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/quarantined-devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List quarantined devices
      effect: read
      questions:
      - Which devices are currently on the quarantine list?
      - Can I check whether a device with a given serial number is quarantined?
      instructions:
      - text: List all quarantined devices.
      - text: Check if host {host_id} is quarantined.
        slots:
          host_id: query.host_id
      - text: Look up quarantine status for serial number {serial_number}.
        slots:
          serial_number: query.serial_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/quarantined-devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Quarantine a device
      effect: write
      questions:
      - How do I quarantine a compromised endpoint?
      - Can I include the device's IP address when adding it to quarantine?
      instructions:
      - text: Quarantine device {host_id}.
        slots:
          host_id: requestBody.host_id
      - text: Add host {host_id} with serial {serial_number} and IP {ip} to the quarantine list.
        slots:
          host_id: requestBody.host_id
          serial_number: requestBody.serial_number
          ip: requestBody.ip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/quarantined-devices'].delete
  update:
    x-apievangelist-phrasing:
      intent: Release a device from quarantine
      effect: destructive
      questions:
      - How do I take a device off the quarantine list?
      - What identifies the device when I remove it from quarantine?
      instructions:
      - text: Remove device {host_id} from quarantine.
        slots:
          host_id: query.host_id
      - text: Unquarantine host {host_id}.
        slots:
          host_id: query.host_id
      method: generated
      generated: '2026-10-01'