Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Auto VPN Clusters API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-auto-vpn-clusters-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['/auto-vpn-clusters'].get

$.paths['/auto-vpn-clusters'].post

$.paths['/auto-vpn-clusters/{id}'].get

$.paths['/auto-vpn-clusters/{id}'].put

$.paths['/auto-vpn-clusters/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Network Services Auto VPN Clusters API
  version: 1.0.0
extends: openapi/palo-alto-networks-auto-vpn-clusters-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['/auto-vpn-clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Auto VPN clusters
      effect: read
      questions:
      - Which Auto VPN clusters are configured?
      - Can I look up Auto VPN clusters by name?
      instructions:
      - text: List all Auto VPN clusters.
      - text: Find the Auto VPN cluster named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-vpn-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Auto VPN cluster
      effect: write
      questions:
      - How do I set up a new Auto VPN cluster linking branches to hubs?
      - Can I turn on SD-WAN and mesh between hubs when creating a VPN cluster?
      instructions:
      - text: Create an Auto VPN cluster named {name} connecting {branches} to hubs {gateways}.
        slots:
          name: requestBody.name
          branches: requestBody.branches
          gateways: requestBody.gateways
      - text: Create a {type} VPN cluster {name} with SD-WAN set to {enable_sdwan}.
        slots:
          type: requestBody.type
          name: requestBody.name
          enable_sdwan: requestBody.enable_sdwan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-vpn-clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Auto VPN cluster
      effect: read
      questions:
      - What branches and hubs belong to a specific Auto VPN cluster?
      - Can I fetch one VPN cluster's settings by UUID?
      instructions:
      - text: Get Auto VPN cluster {id}.
        slots:
          id: path.id
      - text: Show the branches and hubs in VPN cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-vpn-clusters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Auto VPN cluster
      effect: write
      questions:
      - How do I add branches to an existing Auto VPN cluster?
      - Can I enable mesh interconnect on a cluster I already built?
      instructions:
      - text: Update Auto VPN cluster {id} to include branches {branches}.
        slots:
          id: path.id
          branches: requestBody.branches
      - text: Set mesh between hubs to {enable_mesh_between_hubs} on existing VPN cluster {id}.
        slots:
          enable_mesh_between_hubs: requestBody.enable_mesh_between_hubs
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-vpn-clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Auto VPN cluster
      effect: destructive
      questions:
      - How do I tear down an Auto VPN cluster?
      - Can I remove a VPN cluster by its UUID?
      instructions:
      - text: Delete Auto VPN cluster {id}.
        slots:
          id: path.id
      - text: Remove the VPN cluster with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'