Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Destinations API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-destinations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/forwarding-profile-destinations'].get
$.paths['/forwarding-profile-destinations'].post
$.paths['/forwarding-profile-destinations/{id}'].get
$.paths['/forwarding-profile-destinations/{id}'].put
$.paths['/forwarding-profile-destinations/{id}'].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 GlobalProtect Destinations API
  version: 1.0.0
extends: openapi/palo-alto-networks-destinations-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: 5
- target: $.paths['/forwarding-profile-destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect forwarding destinations
      effect: read
      questions:
      - Which GlobalProtect forwarding profile destinations are defined?
      - Can I find a GlobalProtect destination by name in a folder?
      instructions:
      - text: List GlobalProtect forwarding destinations.
      - text: Find GlobalProtect destination {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect forwarding destination
      effect: write
      questions:
      - How do I add a destination to a GlobalProtect forwarding profile by FQDN?
      - Can a GlobalProtect destination be a list of IP addresses?
      instructions:
      - text: Create GlobalProtect destination {name} for FQDN {fqdn}.
        slots:
          name: requestBody.name
          fqdn: requestBody.fqdn
      - text: Add GlobalProtect destination {name} covering IP addresses {ip_addresses}.
        slots:
          name: requestBody.name
          ip_addresses: requestBody.ip_addresses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-destinations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GlobalProtect forwarding destination
      effect: read
      questions:
      - Which FQDNs and IPs does a given GlobalProtect destination cover?
      - Can I fetch a GlobalProtect destination by ID?
      instructions:
      - text: Show GlobalProtect destination {id}.
        slots:
          id: path.id
      - text: Get the FQDN and IP list for destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-destinations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect forwarding destination
      effect: write
      questions:
      - How do I change the FQDN or IP addresses on an existing GlobalProtect destination?
      - Can I rename a forwarding profile destination?
      instructions:
      - text: Update GlobalProtect destination {id} named {name} to FQDN {fqdn}.
        slots:
          id: path.id
          name: requestBody.name
          fqdn: requestBody.fqdn
      - text: Replace the IP addresses on destination {id} ({name}) with {ip_addresses}.
        slots:
          id: path.id
          name: requestBody.name
          ip_addresses: requestBody.ip_addresses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-destinations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect forwarding destination
      effect: destructive
      questions:
      - How do I remove a GlobalProtect forwarding destination?
      - Will traffic forwarding change if I delete a destination?
      instructions:
      - text: Delete GlobalProtect destination {id}.
        slots:
          id: path.id
      - text: Remove forwarding destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'