Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Security Zones API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-security-zones-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['/zones'].get
$.paths['/zones'].post
$.paths['/zones/{id}'].get
$.paths['/zones/{id}'].put
$.paths['/zones/{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 Network Services Security Zones API
  version: 1.0.0
extends: openapi/palo-alto-networks-security-zones-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['/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List security zones
      effect: read
      questions:
      - Which security zones are defined in a folder or snippet?
      - Can I find a security zone by name?
      instructions:
      - text: List security zones in folder {folder}.
        slots:
          folder: query.folder
      - text: Find security zone {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security zone
      effect: write
      questions:
      - How do I create a new security zone and assign network interfaces to it?
      - Can I turn on user identification when creating a zone?
      instructions:
      - text: Create security zone {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: requestBody.folder
      - text: Create zone {name} with network {network} and user identification {enable_user_identification}.
        slots:
          name: requestBody.name
          network: requestBody.network
          enable_user_identification: requestBody.enable_user_identification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security zone
      effect: read
      questions:
      - What interfaces and ACLs belong to a specific security zone?
      - How can I view a single zone by ID?
      instructions:
      - text: Get security zone {id}.
        slots:
          id: path.id
      - text: Show the network and ACL settings of zone {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a security zone
      effect: write
      questions:
      - How do I enable device identification on an existing security zone?
      - Can I change the user ACL of a zone?
      instructions:
      - text: 'Update zone {id} ({name}) to enable device identification: {enable_device_identification}.'
        slots:
          id: path.id
          name: requestBody.name
          enable_device_identification: requestBody.enable_device_identification
      - text: Set user ACL {user_acl} on security zone {id} named {name}.
        slots:
          user_acl: requestBody.user_acl
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a security zone
      effect: destructive
      questions:
      - How do I delete a security zone?
      - Is a zone removed by its ID?
      instructions:
      - text: Delete security zone {id}.
        slots:
          id: path.id
      - text: Remove zone {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'