# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Device Settings High Availability Configurations API
  version: 1.0.0
extends: openapi/palo-alto-networks-high-availability-configurations-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: 8
- target: $.paths['/ha-configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's HA configuration
      effect: read
      questions:
      - Is high availability turned on for my firewall?
      - What HA group and interface is a device using?
      instructions:
      - text: Show the high availability configuration for device {device}.
        slots:
          device: query.device
      - text: Check HA settings on firewall {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a device's HA configuration
      effect: write
      questions:
      - Can I change the HA group or interface on a device that already has HA?
      - How do I disable high availability on an existing pair?
      instructions:
      - text: Update HA on device {device} to use interface {interface} and group {group}.
        slots:
          device: requestBody.device
          interface: requestBody.interface
          group: requestBody.group
      - text: Set HA enabled to {enabled} on the existing config with group {group} and interface {interface}.
        slots:
          enabled: requestBody.enabled
          group: requestBody.group
          interface: requestBody.interface
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HA configuration
      effect: write
      questions:
      - How do I set up high availability on a firewall for the first time?
      - What group and interface details are required to create an HA config?
      instructions:
      - text: Create a new HA configuration for device {device} with group {group} on interface {interface}.
        slots:
          device: requestBody.device
          group: requestBody.group
          interface: requestBody.interface
      - text: Set up high availability from scratch using HA group {group} and interface {interface}.
        slots:
          group: requestBody.group
          interface: requestBody.interface
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device's HA configuration
      effect: destructive
      questions:
      - Can I remove high availability from a device entirely?
      - What happens to a firewall's HA setup when I delete it?
      instructions:
      - text: Delete the HA configuration on device {device}.
        slots:
          device: query.device
      - text: Remove high availability from firewall {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations-ports'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest ports for HA setup
      effect: read
      questions:
      - Which ports can I pick for an HA link on this device?
      - Can I see available HA port options by interface type?
      instructions:
      - text: List available HA ports on device {device_id} for {interface_type} interfaces.
        slots:
          device_id: query.device_id
          interface_type: query.interface_type
      - text: Suggest port choices for the {interface_type} HA link on {device_id}.
        slots:
          interface_type: query.interface_type
          device_id: query.device_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations-ip-addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest IP addresses for HA setup
      effect: read
      questions:
      - What IP addresses are available to assign to an HA interface?
      - Can I get IP address suggestions for configuring HA?
      instructions:
      - text: List IP address options for HA on device {device_id}, interface type {interface_type}.
        slots:
          device_id: query.device_id
          interface_type: query.interface_type
      - text: Suggest an HA IP for the {interface_type} interface of {device_id}.
        slots:
          interface_type: query.interface_type
          device_id: query.device_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations-netmasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest netmasks for HA setup
      effect: read
      questions:
      - Which netmasks can I use on an HA interface?
      - Is there a list of valid subnet masks for my HA link?
      instructions:
      - text: List netmask options for HA on device {device_id} with interface type {interface_type}.
        slots:
          device_id: query.device_id
          interface_type: query.interface_type
      - text: Show subnet mask choices for the {interface_type} HA interface on {device_id}.
        slots:
          interface_type: query.interface_type
          device_id: query.device_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ha-configurations-gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest gateways for HA setup
      effect: read
      questions:
      - What gateway addresses are available for an HA interface?
      - Can I get default gateway options while configuring HA?
      instructions:
      - text: List gateway options for HA on device {device_id}, interface type {interface_type}.
        slots:
          device_id: query.device_id
          interface_type: query.interface_type
      - text: Suggest a gateway for the {interface_type} HA link on {device_id}.
        slots:
          interface_type: query.interface_type
          device_id: query.device_id
      method: generated
      generated: '2026-09-26'