Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Zone Protection Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-zone-protection-profiles-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['/zone-protection-profiles'].get
$.paths['/zone-protection-profiles'].post
$.paths['/zone-protection-profiles/{id}'].get
$.paths['/zone-protection-profiles/{id}'].put
$.paths['/zone-protection-profiles/{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 Zone Protection Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-zone-protection-profiles-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['/zone-protection-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List zone protection profiles
      effect: read
      questions:
      - Which zone protection profiles guard my security zones?
      - Can I list zone protection profiles in one folder?
      instructions:
      - text: List zone protection profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the zone protection profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zone-protection-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a zone protection profile
      effect: write
      questions:
      - How do I create a zone protection profile with flood and scan protection?
      - Can a new zone protection profile discard spoofed IP packets?
      instructions:
      - text: Create zone protection profile {name} with flood settings {flood}.
        slots:
          name: requestBody.name
          flood: requestBody.flood
      - text: 'Add zone protection profile {name} that discards spoofed IPs: {spoofed_ip_discard}.'
        slots:
          name: requestBody.name
          spoofed_ip_discard: requestBody.spoofed_ip_discard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zone-protection-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a zone protection profile
      effect: read
      questions:
      - What flood thresholds does a specific zone protection profile set?
      - Can I retrieve a zone protection profile by ID?
      instructions:
      - text: Get zone protection profile {id}.
        slots:
          id: path.id
      - text: Show the flood thresholds in zone protection profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zone-protection-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a zone protection profile
      effect: write
      questions:
      - Can I tighten scan protection on an existing zone protection profile?
      - How do I enable strict IP checking on a profile I already have?
      instructions:
      - text: Update zone protection profile {id} ({name}) with scan settings {scan}.
        slots:
          id: path.id
          name: requestBody.name
          scan: requestBody.scan
      - text: Turn strict IP check to {strict_ip_check} on zone protection profile {id} named {name}.
        slots:
          strict_ip_check: requestBody.strict_ip_check
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zone-protection-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a zone protection profile
      effect: destructive
      questions:
      - Can I remove a zone protection profile no zone uses?
      - What ID deletes a zone protection profile?
      instructions:
      - text: Delete zone protection profile {id}.
        slots:
          id: path.id
      - text: Remove zone protection profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'