Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Manage Cloud NGFW Manage NGFW API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-managengfw-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 7

$.info

$.paths['/v1/config/ngfirewalls'].get

$.paths['/v1/config/ngfirewalls'].post

$.paths['/v1/config/ngfirewalls/{ngfirewallname}'].get

$.paths['/v1/config/ngfirewalls/{ngfirewallname}'].delete

$.paths['/v1/config/ngfirewalls/{ngfirewallname}/description'].put

$.paths['/v1/config/ngfirewalls/{ngfirewallname}/subnets'].put

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 Manage Cloud NGFW Manage NGFW API
  version: 1.0.0
extends: openapi/palo-alto-networks-managengfw-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: 6
- target: $.paths['/v1/config/ngfirewalls'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud NGFW firewalls
      effect: read
      questions:
      - Which Cloud NGFW firewalls are deployed in my account?
      - Can I list only firewalls attached to specific VPCs?
      instructions:
      - text: List NGFW firewalls in VPCs {VpcIds}.
        slots:
          VpcIds: requestBody.VpcIds
      - text: Show firewalls using rulestack {RuleStackName}.
        slots:
          RuleStackName: requestBody.RuleStackName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/ngfirewalls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud NGFW firewall
      effect: write
      questions:
      - How do I deploy a new Cloud NGFW firewall into my VPC?
      - Can I attach a rulestack when I create a firewall?
      instructions:
      - text: Create firewall {FirewallName} in VPC {VpcId} with subnets {SubnetMappings} and endpoint mode {EndpointMode}.
        slots:
          FirewallName: requestBody.FirewallName
          VpcId: requestBody.VpcId
          SubnetMappings: requestBody.SubnetMappings
          EndpointMode: requestBody.EndpointMode
      - text: Deploy NGFW {FirewallName} in {VpcId}, subnets {SubnetMappings}, mode {EndpointMode}, rulestack {RuleStackName}.
        slots:
          FirewallName: requestBody.FirewallName
          VpcId: requestBody.VpcId
          SubnetMappings: requestBody.SubnetMappings
          EndpointMode: requestBody.EndpointMode
          RuleStackName: requestBody.RuleStackName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/ngfirewalls/{ngfirewallname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cloud NGFW firewall
      effect: read
      questions:
      - What is the configuration of one of my NGFW firewalls?
      - Which subnets and rulestack does a named firewall use?
      instructions:
      - text: Get firewall {ngfirewallname}.
        slots:
          ngfirewallname: path.ngfirewallname
      - text: Show configuration for NGFW {ngfirewallname} in account {AccountId}.
        slots:
          ngfirewallname: path.ngfirewallname
          AccountId: requestBody.AccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/ngfirewalls/{ngfirewallname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cloud NGFW firewall
      effect: destructive
      questions:
      - How do I tear down an NGFW firewall safely?
      - What must I change in route tables before deleting a firewall?
      instructions:
      - text: Delete firewall {ngfirewallname}.
        slots:
          ngfirewallname: path.ngfirewallname
      - text: Remove NGFW {ngfirewallname} from account {AccountId}.
        slots:
          ngfirewallname: path.ngfirewallname
          AccountId: requestBody.AccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/ngfirewalls/{ngfirewallname}/description'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a firewall's description
      effect: write
      questions:
      - How do I change the description on an NGFW firewall?
      - Can I relabel a firewall so it is easier to identify?
      instructions:
      - text: Set the description of firewall {ngfirewallname} to {Description}.
        slots:
          ngfirewallname: path.ngfirewallname
          Description: requestBody.Description
      - text: Relabel NGFW {ngfirewallname} as {Description}.
        slots:
          ngfirewallname: path.ngfirewallname
          Description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/config/ngfirewalls/{ngfirewallname}/subnets'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a firewall's subnet mappings
      effect: write
      questions:
      - How do I add a subnet to an existing NGFW firewall?
      - Can I detach a subnet from a firewall's endpoints?
      instructions:
      - text: Associate subnets {AssociateSubnetMappings} with firewall {ngfirewallname}.
        slots:
          AssociateSubnetMappings: requestBody.AssociateSubnetMappings
          ngfirewallname: path.ngfirewallname
      - text: Disassociate subnets {DisassociateSubnetMappings} from NGFW {ngfirewallname}.
        slots:
          DisassociateSubnetMappings: requestBody.DisassociateSubnetMappings
          ngfirewallname: path.ngfirewallname
      method: generated
      generated: '2026-09-26'