Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Cloud NGFW for AWS REST Firewalls API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-firewalls-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['/config/ngfirewalls'].get
$.paths['/config/ngfirewalls'].post
$.paths['/config/ngfirewalls/{firewall}'].get
$.paths['/config/ngfirewalls/{firewall}'].put
$.paths['/config/ngfirewalls/{firewall}'].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 Palo Alto Networks Cloud NGFW for AWS REST Firewalls API
  version: 1.0.0
extends: openapi/palo-alto-networks-firewalls-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['/config/ngfirewalls'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud NGFW firewalls in an AWS account
      effect: read
      questions:
      - Which Cloud NGFW firewalls are running in my AWS account?
      - Can I see only the firewalls attached to one VPC?
      - What status and rule stack does each of my cloud firewalls have?
      instructions:
      - text: List all Cloud NGFW firewalls in the account.
      - text: List the Cloud NGFW firewalls attached to VPC {vpcid}.
        slots:
          vpcid: query.vpcid
      - text: Show the next {maxresults} firewalls using page token {nexttoken}.
        slots:
          maxresults: query.maxresults
          nexttoken: query.nexttoken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/ngfirewalls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Cloud NGFW firewall in a VPC
      effect: write
      questions:
      - How do I deploy a new Cloud NGFW firewall into one of my AWS VPCs?
      - What do I need to specify when creating a cloud firewall, like the rule stack and subnet mappings?
      instructions:
      - text: Create a Cloud NGFW firewall named {FirewallName} with configuration {FirewallEntry}.
        slots:
          FirewallName: requestBody.FirewallName
          FirewallEntry: requestBody.FirewallEntry
      - text: 'Provision a new cloud firewall {FirewallName} using these VPC, subnet and rule stack settings: {FirewallEntry}.'
        slots:
          FirewallName: requestBody.FirewallName
          FirewallEntry: requestBody.FirewallEntry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/ngfirewalls/{firewall}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud NGFW firewall's configuration
      effect: read
      questions:
      - What is the current status of a specific Cloud NGFW firewall?
      - Which rule stack and subnets is a given cloud firewall using?
      instructions:
      - text: Show the configuration and status of firewall {firewall}.
        slots:
          firewall: path.firewall
      - text: Check whether Cloud NGFW firewall {firewall} is active.
        slots:
          firewall: path.firewall
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/ngfirewalls/{firewall}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Cloud NGFW firewall
      effect: write
      questions:
      - How do I switch an existing cloud firewall to a different rule stack?
      - Can I change the subnet mappings of a firewall that's already deployed?
      instructions:
      - text: Update firewall {firewall} with the new configuration {FirewallEntry}.
        slots:
          firewall: path.firewall
          FirewallEntry: requestBody.FirewallEntry
      - text: Point existing firewall {firewall} ({FirewallName}) at the rule stack in {FirewallEntry}.
        slots:
          firewall: path.firewall
          FirewallName: requestBody.FirewallName
          FirewallEntry: requestBody.FirewallEntry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/ngfirewalls/{firewall}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Cloud NGFW firewall
      effect: destructive
      questions:
      - How do I tear down a Cloud NGFW firewall and remove its VPC endpoints?
      - In what state must a firewall be before it can be deleted?
      instructions:
      - text: Delete Cloud NGFW firewall {firewall}.
        slots:
          firewall: path.firewall
      - text: Remove firewall {firewall} and disassociate it from its VPC.
        slots:
          firewall: path.firewall
      method: generated
      generated: '2026-09-26'