Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings VPN Settings API

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

$.paths['/vpn-settings'].post

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

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

$.paths['/vpn-settings/{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 Device Settings VPN Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-vpn-settings-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['/vpn-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List VPN settings
      effect: read
      questions:
      - What VPN settings are configured for a folder?
      - Can I list VPN settings scoped to a snippet or device?
      instructions:
      - text: List VPN settings in folder {folder}.
        slots:
          folder: query.folder
      - text: Show VPN settings for device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vpn-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create VPN settings
      effect: write
      questions:
      - How do I create new VPN settings?
      - Can I define VPN configuration from scratch through the API?
      instructions:
      - text: Create VPN settings with configuration {vpn}.
        slots:
          vpn: requestBody.vpn
      - text: Add new VPN settings using {vpn}.
        slots:
          vpn: requestBody.vpn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vpn-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get VPN settings
      effect: read
      questions:
      - How do I view one set of VPN settings by ID?
      - What does a particular VPN settings object contain?
      instructions:
      - text: Get VPN settings {id}.
        slots:
          id: path.id
      - text: Show the VPN settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vpn-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update VPN settings
      effect: write
      questions:
      - Can I change existing VPN settings?
      - How do I modify the VPN configuration on a settings object?
      instructions:
      - text: Update VPN settings {id} to {vpn}.
        slots:
          id: path.id
          vpn: requestBody.vpn
      - text: Change the VPN configuration of settings {id} to {vpn}.
        slots:
          id: path.id
          vpn: requestBody.vpn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vpn-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete VPN settings
      effect: destructive
      questions:
      - How do I delete a VPN settings object?
      - Can I remove VPN settings I no longer need?
      instructions:
      - text: Delete VPN settings {id}.
        slots:
          id: path.id
      - text: Remove VPN settings {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'